POST/Submission
Definition
ARGOS ID check 를 진행하지 않고, 고객사가 직접 사용자의 ID check 데이터를 강제 삽입하는 형태로 Submission 을 생성합니다.
해당 API 는 오직 String 데이터만 삽입할 수 있으며, 이미지 데이터는 ‘Put Image’ API 를 별도로 이용해야 합니다.
해당 API 로 생성된 Submission 은 어떠한 OCR 및 Verification 도 진행하지 않습니다.
Input Data
Parameter | Type | Required | Description |
---|---|---|---|
admin | String / email | O | 프로젝트 관리자의 계정 (대시보드에 등록되어 있어야 함) |
String / email | O | KYC 제출자의 이메일 주소 | |
fullName | String | O | KYC 제출자의 이메일 이름 |
birthDate | String / date | O | KYC 제출자의 생년월일 (YYYY-MM-DD) |
kycStatus | String (*Fixed) | O | KYC 결과 (approved | rejected) 택 1 |
idType | String (*Fixed) | O | KYC 제출자의 신분증 타입 (drivers_license | government_id | passport | residence_permit | vehicle_registration_certificate | visa | aadhaar | pancard ) 택 1 |
issuingCountry | String (*Fixed) | O | KYC 제출자의 신분증 발급국가 (ISO alpha3 형식) |
nationality | String (*Fixed) | X | KYC 제출자의 국적 (ISO alpha3 형식) |
gender | String (*Fixed) | X | KYC 제출자의 성별 (female | male) 택 1 |
issueDate | String / date | X | KYC 제출자의 신분증 발급일자 (YYYY-MM-DD) |
expireDate | String / date | X | KYC 제출자의 신분증 만료일자 (YYYY-MM-DD) |
ipAddress | String | X | KYC 제출자의 IP 주소 |
identityNumber | String | X | KYC 제출자의 주민등록번호 |
documentNumber | String | X | KYC 제출자의 문서번호 |
address_city | String | X | 주소지 - city |
address_country | String | X | 주소지 - country |
address_state | String | X | 주소지 - state |
address_street | String | X | 주소지 - street |
address_full | String | X | 주소지 - full address |
cf1 | String | X | custom field 1 |
cf2 | String | X | custom field 2 |
cf3 | String | X | custom field 3 |
userid | String | X | 사용자 고유 ID |
암호화 옵션 사용 시 Input Data
Request Body 를 암호화 하여 API 요청
Output Data
Response | Description |
---|---|
submissionId | 생성된 제출 건의 고유 ID (= Submission Id) |
암호화 옵션 사용 시 Output Data
Body 객체 내 ‘data’ 프로퍼티에 암호화 된 결과 반환
Error Codes (400 error)
errorCode | Message | 설명 |
---|---|---|
invalid_payload | Invalid payload. | 요청 본문(페이로드) 가 확인되지 않음 |
missing_data | Required input data is missing. | 필수 파라미터가 누락됨 |
invalid_project | Invalid project. | 유효하지 않은 프로젝트ID |
invalid_admin | Invalid admin. | 해당 프로젝트의 권한이 없는 어드민 계정 |
invalid_parameter | invalid parameter: {parameter} | Input data 에서 제공하지 않는 파라미터 제출 |
invalid_format | invalid format: ${parameter} | Input data 에서 안내한 데이터 형식에 맞지 않음 |
processing_error | Failed to complete migration. | 데이터 처리 중 알 수 없는 에러. (CS 관리자 문의) |
Request URL
URL과 x-api-key를 반드시 입력해 주어야 합니다.
Sample Request
Body /Raw Json 형식으로 제출합니다.
단 건 제출만 가능합니다.
Sample Response
Last updated