KR

GET/Submission

Request URL

curl -X GET "https://rest-api.argosidentity.com/v3/submission?submission_id={submission_id}"
-H "x-api-key: {yourAPIKey}"

제출 목록을 가져옵니다.

  • KYC/AML 상태는 GET 요청으로 확인할 수 있습니다.

  • 특정 제출의 KYC 상태를 확인하거나 GET 요청과 함께 KYC 제출 목록을 얻을 수 있습니다.

  • 매개 변수가 제공되지 않으면 모든 제출 목록이 반환됩니다.

  • 매개 변수가 제공된 경우 지정된 매개 변수를 기준으로 목록을 필터링합니다.

  • 특정 제출의 제출 데이터를 가져오려면 제출 ID(submission_id)를 매개 변수로 제공해야 합니다. 자세한 내용은 아래 Input Data 테이블을 참조해 주세요.

Input Data

*이 붙은 것은 필수 파라미터 입니다. (Get submission은 필수 파라미터가 없습니다.)

파라미터설명

submission_id

하나의 제출된 데이터에 일치하는 Submission ID가 반환.

userid

사용자 ID와 일치하는 목록이 반환되며, userid는 submission을 post 할 때 선택적으로 추가되는 변수.

email

이메일 주소와 일치하는 제출 목록이 반환됨.

count

userid를 통한 리스트 조회 시, 사용자가 지정한 Count 값이 없으면 기본값으로 50개 출력

nextpage_id

응답에 nextpageKey가 리턴되는 경우 다음 페이지가 있음을 의미하며,

요청 parameter에 nextpage_id(nextpageKey.id)와 nextpage_date(nextpageKey.created_at)를 함께 포함하여 요청하면 다음 페이지가 호출됨.

nextpage_date

응답에 nextpageKey가 리턴되는 경우,다음 페이지가 있음을 의미하며,

요청 parameter에 nextpage_id(nextpageKey.id)와 nextpage_date(nextpageKey.created_at)를 함께 포함하여 요청하면 다음 페이지가 호출됨.

start_date

특정 기간 동안 제출된 KYC 데이터를 조회할 경우 조회 기간의 시작 날짜. (YYYYMMDD)

end_date

특정 기간 동안 제출된 KYC 데이터를 조회할 경우 조회 기간의 끝나는 날짜. (YYYYMMDD)

request_type

특정 항목만 선택적으로 조회, { kyc, aml, data, others } 중 한 가지 입력

  • aml: aml. 하위 데이터 + submission_id

  • kyc: kyc. 하위 데이터 + submission_id

  • data: data. 하위 데이터 + submission_id

  • others: aml, kyc, data 를 제외한 나머지 모든 항목

암호화 옵션 사용 시 Input Data

2024.06.21

  • 암호화 옵션 사용 시, Input 및 Output 의 양 방향 암/복호화 추가

Input 객체(Query String Parameter)를 암호화한 후, data 프로퍼티로 전송.

queryStringParameters : {
	data : encrypt({
		email : 'string',
		start_date : 'string',
		end_date : 'string'
	})
}

Output Data

Response설명

data

KYC 제출자 데이터

data.name

이름

data.gender

<male, female>

data.nationality

3글자 형식의 국가코드 (ISO alpha3 형식)

data.date_of_birth

YYYY-MM-DD의 날짜 형식

data.ip_address

IPv4 형식의 IP 주소

data.idType

신분증 종류

<passport, government_id, drivers_licensem, residence permit, vehicle registration certificate, visa, aadhaar, pancard>

data.idcard_issuingCountry

신분증 발급 국가의 ISO alpha 3 형식의 코드

data.idcard_issueDate

YYYY-MM-DD 형식의 신분증 발급일자

data.idcard_expireDate

YYYY-MM-DD 형식의 신분증 만료일자

data.identityNumber

주민등록번호

data.documentNumber

신분증 번호

data.address_city

도시

data.address_country

국가

data.address_state

주

data.address_street

도로

data.address_zipcode

우편번호

data.address_globalCode

전체 주소에 대한 상세코드 값 (ex. 8Q98HXPG+MP)

data.address_compoundCode

국가 및 도시와 상세주소 코드 값 (ex. HXPG+MP Seoul, South Korea)

data.address_formatted

상세 코드를 변환한 주소

data.address_input

사용자 입력 주소 값

data.address_detail

사용자 입력 상세주소 값

data.cf1

submission을 제출할 때 선택적으로 추가되는 값 1

data.cf2

submission을 제출할 때 선택적으로 추가되는 값 2

data.cf3

submission을 제출할 때 선택적으로 추가되는 값 3

email

이메일 주소

reviewer

system: AI가 검수 agent: 사람이 검수

submission_id

각 제출건(submission)에 부여된 고유 식별 ID

applicant_id

중복 제출한 사용자에게 부여되는 식별 ID

created_at

KYC가 제출된 날짜와 시간 (UTC+0)

kyc_result_at

KYC가 결과가 최초로 정해진 시간으로 approved/rejected 일 때만 출력 됨. (UTC+0)

updated_at

KYC 상태가 최종 업데이트된 날짜와 시간 (UTC+0)

pending_at

KYC가 Pending으로 제출된 날짜와 시간 (UTC+0)

userid

submission을 생성할 때 선택적으로 추가되는 파라미터

additional_list

대시보드에서 설정한 Additional form 에 대해, KYC 진행 시 사용자가 입력한 데이터 아래의 요청 타입의 경우 포함

  • 특정 submissionId 또는 email 로 조회한 경우

  • ‘request_type’ 을 ‘others’ 로 조회한 경우

additional_list.answer

Additional form의 각 항목 명

additional_list.inputValue

각 항목에 대한 사용자 입력값

additional_list.blockType

각 항목에 대한 데이터 타입

kyc

KYC 데이터 오브젝트

kyc.result

<Incomplete, pending, approved, rejected>

Incomplete: 불충분한 KYC 데이터로 인해 제출이 완료되지 않음.

Pending: 제출된 파일은 수동 검수 중.

Approved: 제출된 파일이 승인.

Rejected: 제출된 파일이 거절, 사유는 kyc.comment에서 확인 가능.

kyc.comment

KYC 거절 사유는 KYC 결과가 ‘rejected’ 되었을 때 반환 *Reject comment 참고

kyc.commentCode

KYC 거절 사유(kyc.comment)에 대한 코드 값 *Reject comment code 참고

kyc.attempts

Liveness, Detect face, Face compare, 신분증 진위확인의 실행건에 대한 오브젝트

kyc.attempts[i].attemptCnt

KYC 제출에 실패하여 재시도 한 횟수

kyc.attempts[i].idBarcodeResult

USA, CAN, MEX 신분증에 대한 바코드 진위 확인 결과

kyc.attempts[i].verificationResult

i번째 실행된 신분증 진위확인 결과 값 <success, fail>

kyc.attempts[i].verification

i번째 실행된 신분증 진위확인의 결과 상세 데이터

kyc.attempts[i].verificationParams

i번째 실행되는 신분증 진위확인 실행 시 필요한 값

kyc.attempts[i].errorCode

Liveness, Detect face, Face compare, 신분증 진위확인 실행 시 발생되는 예외 오류 메세지의 코드

kyc.attempts[i].errorMsg

Liveness, Detect face, Face compare, 신분증 진위확인 실행 시 발생되는 예외 오류 메세지

kyc.attempts[i].step1Time1st

step1을 첫 번째로 호출한 시간

kyc.attempts[i].step1Time2nd

step1을 두 번째로 호출한 시간

kyc.attempts[i].step1Time3rd

step1을 세번째로 호출한 시간

kyc.attempts[i].step2Time1st

step2을 첫 번째로 호출한 시간

kyc.attempts[i].step2Time2nd

step2을 두 번째로 호출한 시간

kyc.attempts[i].step2Time3rd

step2을 세 번째로 호출한 시간

kyc.attempts[i].retryMsg

Liveness, Detect face, Face compare, 신분증 진위확인 실행 시 발생되는 실패 원인 메세지

kyc.attempts[i].retryCode

Liveness, Detect face, Face compare, 신분증 진위확인 실행 시 발생되는 실패 원인 메세지의 코드

kyc.attempts[i].faceSimilarityScore

i번째 실행되는 face compare 비교 값

kyc.attempts[i].selfieImage

i번째 제출되는 Selfie 이미지 저장 URL

kyc.attempts[i].livenessScore

i번째 실행되는 liveness 점수 값

aml

aml 스크리닝 결과 데이터 오브젝트

aml.raw_data

AML 스크리닝 결과의 원시 데이터를 반환하는 객체

aml.risk_level_summary

<Not Screened, High, Medium, Low>

aml.currentstatus

<Not Screened, Red Flag>

aml.matches

상세 AML 스크리닝 결과. aml.currentstatus가 ‘Red Flag’일때만 이용 가능합니다.

aml.matches[i].risk_level

Red Flag 위험도 <HIGH, MEDIUM, LOW>

aml.matches[i].argos_number

AML 보고서를 조회하기 위한 고유 ID

aml.matches[i].resource_id

AML 보고서를 조회하기 위한 리소스 고유 ID

aml.matches[i].score

AML 스크리닝 매칭 점수

aml.matches[i].risk_icons

AML 리스크 아이콘

nextpageKey

추가로 출력될 다음 페이지가 있을 경우에 전달되는 키 값 오브젝트

nextpageKey.id

다음 페이지 호출시 필요한 가장 마지막으로 조회되었던 submission의 id 값

nextpageKey.created_at

다음 페이지 호출시 필요한 가장 마지막으로 조회되었던 submission의 created_at 값

bank_verification

한국인 계좌 인증 옵션 사용 시, 계좌 인증 결과에 대한 오브젝트

bank_verification.result

계좌 인증 성공 결과 <success, fail>

bank_verification.type

계좌 인증 유형 <occupancy(1원인증), nameCheck(예금주조회)>*현재는 1원인증만 개발된 상태

bank_verification.bank_code

계좌 인증에 사용한 은행 코드

bank_verification.account_number

계좌 인증에 사용한 계좌번호

bank_verification.retry_count

계좌 인증 중 코드 발송(pre-step2)에 실패한 횟수

id_LivenessScore

공격 방지 옵션 사용 시, ID Card Liveness Score 결과 상위 객체

id_LivenessScore.Screen_play

ID Card Liveness 검증 파이프라인 중 ‘Screen play’ 의 liveness score

id_LivenessScore.Paper_printed

ID Card Liveness 검증 파이프라인 중 ‘Paper printed’ 의 liveness score

id_LivenessScore.Replace_portraits

ID Card Liveness 검증 파이프라인 중 ‘Replace portraits’ 의 liveness score

Injection_action

Injection Process 실행 내역을 반환합니다.

Injection_action.type

Injection Process 의 Type 입니다.

Injection_action.time

Injection Process 의 해당 Type 의 가장 최근 실행 일자 입니다.

tokenId

Private mode 에서 live-form 으로 제출 시 사용한 tokenID

Sample Response - Specific Submission

{
    "Items": [
        {
            "data": {
                "name": "{name}",
                "gender": "male",
                "nationality": "KOR",
                "date_of_birth": "YYYY-MM-DD",
                "address_city": "{city}",
                "address_country": "KOR",
                "address_state": "{state}",
                "address_street": "{street}",
                "address_street2": "{street2}",
                "address_zipcode": "{zipcode}",
                "ip_address": "{ip_address}",
                "idcard_issuingCountry": "KOR",
                "idcard_issueDate": "YYYY-MM-DD",
                "idType": "government_id",
                "identityNumber": "{******-*******}"
            },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "updated_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "reviewer": "{reviewer}",
      "aml" : {
	      "raw_data": {...},
	      "matches": [...],
	      "risk_level_summary": "HIGH",
        "currentstatus": "Red Flag"
      },
            "kyc": {
                "result": "rejected",
                "comment": [
                    "Multiple invalid KYC attempts "
                ],
                "commentCode": [
                    "too_many_retry"
                ],
                "attempts": [
                    {
                        "attemptCnt": 1,
                        "step1Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
                        "ocrResult": "success",
                        "verificationResult": "success",
                        "verification": {
                            "result": {
                                "code": "CF-00000",
                                "message": "성공",
                                "transactionId": "{transactionId}",
                                "extraMessage": ""
                            },
                            "data": {
                                "resUserIdentiyNo": "*************",
                                "resAuthenticity": "1",
                                "resAuthenticityDesc": "입력하신 내용은 등록된 내용과 일치합니다.",
                                "resUserNm": "{resUserNm}"
                            }
                        },
                        "verificationParams": {
                            "fullName": "{fullName}",
                            "idType": "government_id",
                            "issueDate": "{YYYY-MM-DD}",
                            "identityNumber": "******-*******"
                        },
                        "step2Time1st": "YYYY-MM-DD-HH-MM-SS-ZZZ",
                        "liveness": {
                            "score": 8.097455,
                            "probability": 0.9996958,
                            "quality": 0.7537264
                        },
                        "faceSimilarityScore": 0,
                        "retryMsg": [
                            "The face doesn’t match. Please retry with another face image."
                        ],
                        "livenessScore": 99,
                        "selfieImage": "{selfieImage URL}",
                        "retryCode": [
                            "face_compare_underscore"
                        ]
                    },
                    {
                        "attemptCnt": 2,
                        "verificationResult": "success",
                        "verification": {
                            "result": {
                                "code": "CF-00000",
                                "message": "성공",
                                "transactionId": "{transactionId}",
                                "extraMessage": ""
                            },
                            "data": {
                                "resUserIdentiyNo": "*************",
                                "resAuthenticity": "1",
                                "resAuthenticityDesc": "입력하신 내용은 등록된 내용과 일치합니다.",
                                "resUserNm": "{resUserNm}"
                            }
                        },
                        "verificationParams": {
                            "fullName": "{fullName}",
                            "idType": "government_id",
                            "issueDate": "{YYYY-MM-DD}",
                            "identityNumber": "******-*******"
                        },
                        "step2Time2nd": "YYYY-MM-DD-HH-MM-SS-ZZZ",
                        "liveness": {
                            "score": 8.097455,
                            "probability": 0.9996958,
                            "quality": 0.7537264
                        },
                        "faceSimilarityScore": 0,
                        "retryMsg": [
                            "The face doesn’t match. Please retry with another face image."
                        ],
                        "livenessScore": 99,
                        "selfieImage": "{selfieImage URL}",
                        "retryCode": [
                            "face_compare_underscore"
                        ]
                    },
                    {
                        "attemptCnt": 3,
                        "verificationResult": "success",
                        "verification": {
                            "result": {
                                "code": "CF-00000",
                                "message": "성공",
                                "transactionId": "{selfieImage URL}",
                                "extraMessage": ""
                            },
                            "data": {
                                "resUserIdentiyNo": "*************",
                                "resAuthenticity": "1",
                                "resAuthenticityDesc": "입력하신 내용은 등록된 내용과 일치합니다.",
                                "resUserNm": "{resUserNm}"
                            }
                        },
                        "verificationParams": {
                            "fullName": "{fullName}",
                            "idType": "government_id",
                            "issueDate": "{YYYY-MM-DD}",
                            "identityNumber": "981112-1******"
                        },
                        "step2Time3rd": "YYYY-MM-DD-HH-MM-SS-ZZZ",
                        "liveness": {
                            "score": 8.097455,
                            "probability": 0.9996958,
                            "quality": 0.7537264
                        },
                        "faceSimilarityScore": 0,
                        "retryMsg": [
                            "The face doesn’t match. Please retry with another face image."
                        ],
                        "livenessScore": 99,
                        "selfieImage": "{selfieImage URL}",
                        "retryCode": [
                            "face_compare_underscore"
                        ]
                    }
                ]
            }
        }
    ]
}

암호화 옵션 사용 시 Output Data

Body 내 ‘data’ 프로퍼티에 암호화 된 결과 반환

response : {
   body : {
      "data": "encrypted-string",
      "isEncrypted": true		}
}

Reject Code & Comment

kyc.commentCodekyc.comment

id_image_invalidImage

ID document not detected. Please take a picture of your ID document.

id_image_invalidId

Invalid ID document. Please resubmit with another ID document.

id_image_error

Fail to upload the ID image. Please resubmit the KYC process.

id_image_badImage

Fail to read the ID image. Please take a clear picture of your ID document.

id_info_dataMismatch

The entered information does not match with your ID document.

id_info_blacklist

According to the policy, we do not accept KYC from {country}.

id_info_notOfAge

We do not accept KYC anyone under {13} years old.

too_many_retry

Multiple invalid KYC attempts

blacklistCountry

According to the policy, we do not accept KYC from {country}.

under_ageLimit

We do not accept KYC anyone under {13} years old.

invalid_acceptedID

Inacceptable ID type. Please resubmit with another ID, check the valid ID on the submission page.

address_image_invalidImage

Invalid proof of address. Proof of address must include your full name and address. ex)utility bill, bank statement, residency certificate, etc.

address_image_error

Fail to upload proof of address image. Please retry.

address_image_badImage

Fail to read the image. Please take a clear picture of your proof of address.

address_info_expiredDocument

Expired proof of address. The proof of address should be issued within 6 months.

address_info_dataMismatch

Entered information does not match with your proof of address.

timeout

KYC rejected due to timeout

other

*수동 검수 시 검수자가 적은 코멘트

GET/Submission/Submission ID

특정 Submission ID의 정보를 조회합니다.

  • URL과 x-api-key 를 반드시 입력해야 합니다

  • 반드시 Query Params로 조회해야 합니다.

  • 단 건만 조회가 가능합니다.

  • KYC 신원 정보 데이터, KYC 결과, AML 결과, 거절 사유 및 코드, 재시도 사유 및 코드 등을 확인할 수 있습니다.

Request URL

curl -X GET "https://rest-api.argosidentity.com/v3/submission?submission_id={submission_id}"\
-H "x-api-key: {yourAPIKey}"

Sample Request

curl --location --request GET 'https://rest-api.argosidentity.com/v3/submission?submission_id={submission_id}'\
--header 'x-api-key: {yourAPIKey}'

Sample Response

{
    "Items": [
        {
            "data": {
                "name": "홍길동",
                "gender": "male",
                "nationality": "KOR",
                "date_of_birth": "YYYY-MM-DD",
                "cf1": "{cf1}",
                "ip_address": "XXX.XXX.XXX.XXX",
                "idcard_issuingCountry": "KOR",
                "idcard_issueDate": "YYYY-MM-DD",
                "idType": "government_id"
            },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "userid": "{userid}",
            "kyc": {
                "result": "rejected",
                "comment": [
                    "Multiple invalid KYC attempts "
                ],
                "commentCode": [
                    "too_many_retry"
                ],
                "attempts": [
                    {
                        "attemptCnt": 1,
                        "retryMsg": [
                            "Liveness fail: Face is too close to one or more borders. Please retry."
                        ],
                        "retryCode": [
                            "liveness_error"
                        ]
                    },
                    {
                        "attemptCnt": 2,
                        "retryMsg": [
                            "Liveness fail: Absolute face size is too small. Please retry."
                        ],
                        "retryCode": [
                            "liveness_error"
                        ]
                    },
                    {
                        "attemptCnt": 3,
                        "livenessScore": 99
                        "retryMsg": [
                            "The face doesn’t match. Please retry with another face image."
                        ],
                        "retryCode": [
                            "face_compare_underscore"
                        ]
                    }
                ]
            }
        }
    ]
}

GET/Submission/User ID

특정 user_id를 가지고 있는 제출 건을 조회합니다.

  • URL과 x-api-key 를 반드시 입력해야 합니다.

  • 반드시 Query Params로 조회해야 합니다.

  • 동일한 userid로 제출된 모든 KYC 데이터(submission)가 조회 됩니다.

Request URL

curl -X GET "https://rest-api.argosidentity.com/v3/submission?userid={userid}"\
-H "x-api-key: {yourAPIKey}"

Sample Request

curl --location --request GET 'https://rest-api.argosidentity.com/v3/submission?userid={userid}' \
--header 'x-api-key: {yourAPIKey}'

Sample Response

{
	"Items": [
        {
            "data": {
                "name": "{name}",
                "gender": "male",
                "nationality": "KOR",
                "date_of_birth": "YYYY-MM-DD"
            },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
						"userid" : "{userid}" 
            "reviewer": "{reviewer}",
            "kyc": {
                "result": "rejected",
                "comment": [
                    "Multiple invalid KYC attempts "
                ],
                "commentCode": [
                    "too_many_retry"
                ]
            }
        },
        {
            "data": {
                "name": "{name}",
                "gender": "male",
                "nationality": "BRA",
                "date_of_birth": "YYYY-MM-DD"
            },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
						"userid" : "{userid}"
            "reviewer": "{reviewer}",
            "kyc": {
                "result": "rejected",
                "comment": [
                    "test"
                ],
                "commentCode": [
                    "other"
                ]
            }
        },
        {
            "data": {
                "name": "{name}",
                "gender": "male",
                "nationality": "KOR",
                "date_of_birth": "YYYY-MM-DD"
            },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "userid" : "{userid}",
            "reviewer": "{reviewer}",
            "kyc": {
                "result": "rejected",
                "comment": [
                    "Multiple invalid KYC attempts "
                ],
                "commentCode": [
                    "too_many_retry"
                ]
	           }
	        }
			 }
	  ]
}

GET/Submission/Email

특정 이메일의 제출 건을 조회합니다.

  • URL과 x-api-key 를 반드시 입력해야 합니다.

  • 반드시 Query Params로 조회해야 합니다.

  • 동일한 email로 제출된 모든 KYC 데이터(submission)가 조회 됩니다.

  • KYC 신원 정보 데이터, KYC 결과, AML 결과, 거절 사유 및 코드, 재시도 사유 및 코드 등을 확인 할 수 있습니다.

Request URL

curl -X GET "https://rest-api.argosidentity.com/v3/submission?email={email}"\
-H "x-api-key: {yourAPIKey}"

Sample Request

curl --location --request GET 'https://rest-api.argosidentity.com/v3/submission?email={email}' \
--header 'x-api-key: {yourAPIKey}'

Sampel Response

{
	"Items": [
        {
            "data": {
                "name": "{name}",
                "gender": "male",
                "nationality": "KOR",
                "date_of_birth": "YYYY-MM-DD"
            },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "reviewer": "{reviewer}",
            "kyc": {
                "result": "rejected",
                "comment": [
                    "Multiple invalid KYC attempts "
                ],
                "commentCode": [
                    "too_many_retry"
                ]
            }
        },
        {
            "data": {
                "name": "{name}",
                "gender": "male",
                "nationality": "BRA",
                "date_of_birth": "YYYY-MM-DD"
            },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "reviewer": "{reviewer}",
            "kyc": {
                "result": "rejected",
                "comment": [
                    "test"
                ],
                "commentCode": [
                    "other"
                ]
            }
        },
        {
            "data": {
                "name": "{name}",
                "gender": "male",
                "nationality": "KOR",
                "date_of_birth": "YYYY-MM-DD"
            },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "reviewer": "{reviewer}",
            "kyc": {
                "result": "rejected",
                "comment": [
                    "Multiple invalid KYC attempts "
                ],
                "commentCode": [
                    "too_many_retry"
                ]
	           }
	        }
			 }
	  ]
}

GET/Submission/List

전체 리스트로 조회합니다.

  • URL과 x-api-key 를 반드시 입력해야 합니다.

  • 반드시 Query Params로 조회해야 합니다.

  • 제출된 모든 KYC데이터(submission)가 조회 됩니다.

  • KYC 신원 정보 데이터, KYC 결과 AML 결과, 거절 사유 및 코드, 재 시도 사유 및 코드 등을 확인 할 수 있습니다.

Request URL

curl -X GET "https://rest-api.argosidentity.com/v3/submission"\
-H "x-api-key: {yourAPIKey}"

Sample Request

curl --location --request GET 'https://rest-api.argosidentity.com/v3/submission' \
--header 'x-api-key: {yourAPIKey}'

Sample Response

"Items": [
        {
            "data": {
                "name": "{name}",
                "gender": "male",
                "nationality": "KOR",
                "date_of_birth": "YYYY-MM-DD"
            },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "reviewer": "{reviewer}",
            "kyc": {
                "result": "rejected",
                "comment": [
                    "Multiple invalid KYC attempts "
                ],
                "commentCode": [
                    "too_many_retry"
                ]
            }
        },
        {
            "data": {
                "name": "{name}",
                "gender": "male",
                "nationality": "BRA",
                "date_of_birth": "YYYY-MM-DD"
            },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "pending_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "reviewer": "{reviewer}",
            "kyc": {
                "result": "rejected",
                "comment": [
                    "test"
                ],
                "commentCode": [
                    "other"
                ]
            }
        },
        {
            "data": {
                "name": "{name}",
                "gender": "male",
                "nationality": "KOR",
                "date_of_birth": "YYYY-MM-DD"
            },
            "email": "{email}",
            "submission_id": "{submission_id}",
            "created_at": "YYYY-MM-DD-HH-MM-SS-ZZZ",
            "reviewer": "{reviewer}",
            "kyc": {
                "result": "rejected",
                "comment": [
                    "Multiple invalid KYC attempts "
                ],
                "commentCode": [
                    "too_many_retry"
                ]
            }
        }
		}
]

GET/Submission/Applicant ID

중복으로 제출된 KYC 데이터의 고유 식별 ID(submission_id)와 이메일을 확인할 수 있습니다.

  • 이름, 생년월일, 국적, 성별, 얼굴이 같은 사람의 submission이 다수 있을 경우 중복 제출로 판단하며, 중복 제출된 submission들을 확인 할 수 있습니다.

  • 중복으로 제출하지 않은 일반적인 제출자의 경우 승인된 단일 submission만 가져옵니다.

  • applicant_id를 기준으로 조회하기 때문에, Get/submission API를 사용하여 applicant_id 정보를 확인해야 합니다.

  • applicant_id는 신원정보(name, date of birth, gender, nationality) 와 Selfie 총 5가지의 데이터를 비교합니다.

    • 5가지의 데이터가 동일한 KYC 제출 데이터에 대해서 동일한 applicant_id를 생성합니다.

    • 비교대상 정보가 없는 경우 랜덤으로 값을 생성합니다.

Request URL

curl -X GET "https://rest-api.argosidentity.com/v3/submission/applicant?applicant_id={applicant_id}"
-H "x-api-key: {yourAPIKey}"

Input Data

*이 붙은 것은 필수 파라미터 입니다.

파라미터설명

*applicant_id

submission 정보에서 획득한 제출자의 고유 applicant_id로 조회합니다.

Output Data

응답설명

submission_id

중복제출로 확인된 submission의 고유 값

email

중복 제출로 확인된 submission에 기록된 이메일 주소

Sample Request

curl --location --request GET 'https://rest-api.argosidentity.com/v3/submission/applicant?applicant_id={applicant_id}' \
--header 'x-api-key: {yourAPIKey}'

Sample Response

[
    {
        "submission_id": "{submission_id}",
        "email": "{email}"
    },
    {
        "submission_id": "{submission_id}",
        "email": "{email}"
    },
    {
        "submission_id": "{submission_id}",
        "email": "{email}"
    }
]
PreviousPOST/AMLNextGET/Report/AML

Last updated