CLOVA eKYC Account API

버전

개요

1원 계좌 인증 API 가이드입니다. API는 인증(Verify)과 확인(Confirm) 2단계로 나뉘며, 이용 이력 및 통계는 인증 단계에서 발생합니다.

인증

인증요청

API 요청 예시

curl -X POST "{invokeUrl}/verify" \
-H "X-EKYC-SECRET: {secretKey}" \
-H "Content-Type: application/json" \
-d "{ \"accountNo\": \"{accountNo}\", \"bankCode\": \"{backCode}\", \"name\": \"{name}\", \"requestId\": \"{requestId}\",  \"text\": \"{text}\", \"verifyType\": \"{verifyType}\", \"verifyLength\": \"{verifyLength}\"}"

요청헤더

요청바디

VerifyType 정의

적요는 받는 분에게 표시되는 내용으로 인증 요청자 또는 회사명 등을 표기해, 인증 요청을 구분할 수 있습니다. 적요에 포함되는 숫자 또는 텍스트를 인증값으로 발송합니다.
Normal 및 Reverse 유형에서는 verifyLength에 따라 인증번호 자릿수가 달라지며, 값이 없으면 기본값 3이 적용됩니다.

응답

응답바디

예시

{
  "requestId": "abb3fcb0-2566-44f4-badd-202be9621c15",
  "uid": "5dc74e2d398543e0a36fea0294b1c010",
  "timestamp": 1684916415923,
  "inferType": "ACCOUNT",
  "inferDetailType": "A2",
  "result": "SUCCESS",
  "message": "Success"
}

{
    "requestId": "abb3fcb0-2566-44f4-badd-202be9621c15",
    "uid": "3cdr660o38c9n36dr5cormcc1i",
    "timestamp": 1684917556241,
    "inferType": "ACCOUNT",
    "inferDetailType": "A2",
    "result": "ERROR",
    "code": "2204",
    "message": "계좌번호를 확인해주세요."
}

확인

확인 요청

API 요청 예시

curl -X POST "{invokeUrl}/confirm" \
-H "X-EKYC-SECRET: {secret}" \
-H "Content-Type: application/json" \
-d "{\"requestId\": \"{requestId}\", \"verifyValue\": \"{verifyValue}\"}"

요청헤더

요청바디

확인응답

응답바디

예시

{
    "requestId": "abb3fcb0-2566-44f4-badd-202be9621c15",
    "uid": "3gopl70s6ac1o3ed9l68pj0d1g",
    "timestamp": 1684917397193,
    "inferType": "ACCOUNT",
    "inferDetailType": "A2",
    "result": "SUCCESS",
    "message": "Success"
}

{
    "requestId": "abb3fcb0-2566-44f4-badd-202be9621c15",
    "uid": "36d3374q6ceb534cr160sjge34",
    "timestamp": 1684917401450,
    "inferType": "ACCOUNT",
    "inferDetailType": "A2",
    "result": "ERROR",
    "code": "2111",
    "message": "계좌검증번호가 일치하지 않습니다. 다시 정확하게 입력하여 주십시오."
}

에러코드

에러응답:

{
  "code": "0011",
  "message": "Request body invalid.",
  "path": "{request API path}",
  "timestamp": 1570776853475
}