GET/Submission
GET/Submission
이 API를 사용하면 제출된 ID Check 데이터를 조회할 수 있습니다. 특정 제출 건의 상세 정보를 확인하거나 여러 제출 건의 목록을 필터링하여 가져올 수 있습니다.
1. 엔드포인트
GET/Submission
2. 인증
x-api-key 헤더에 API 키를 포함시켜야 합니다:
x-api-key
3. 요청 본문
요청 본문은 JSON 형식이어야 합니다. 다음은 필드 설명입니다:
특정 제출 건의 고유 ID
사용자 ID와 일치하는 목록 조회
이메일 주소와 일치하는 제출 목록 조회
반환할 결과의 수 (기본값: 50)
다음 페이지 조회를 위한 ID
다음 페이지 조회를 위한 날짜
조회 시작 날짜 (YYYY-MM-DD)
조회 종료 날짜 (YYYY-MM-DD)
request_type 파라미터를 사용하여 특정 데이터 유형만 선택적으로 조회할 수 있습니다. 다음 옵션 중 하나를 선택하여 입력할 수 있습니다:
kyc
: KYC 관련 데이터와 submission_id를 반환합니다.aml
: AML 관련 데이터와 submission_id를 반환합니다.data
: 제출자의 개인 정보 데이터와 submission_id를 반환합니다.others
: KYC, AML, 개인 정보를 제외한 나머지 모든 데이터 항목을 반환합니다.
4. 요청 예시
POST/Submission
5. 응답
5-1. 성공 응답
result.json
5-2. 응답 데이터
필드명 | 설명 | 데이터 타입 | 카테고리 |
---|---|---|---|
data | KYC 제출자 데이터 | Object | KYC 제출자 정보 |
data.name | 제출자의 이름 | String | KYC 제출자 정보 |
data.gender | 제출자의 성별 (male 또는 female ) | Enum | KYC 제출자 정보 |
data.nationality | ISO alpha-3 형식의 국가 코드 | String | KYC 제출자 정보 |
data.date_of_birth | 제출자의 생년월일 (YYYY-MM-DD 형식) | Date | KYC 제출자 정보 |
data.ip_address | IPv4 형식의 IP 주소 | String | KYC 제출자 정보 |
data.idType | 사용된 신분증 유형 | Enum | KYC 제출자 정보 |
data.idcard_issuingCountry | 신분증 발급 국가의 ISO alpha-3 형식 코드 ISO Alpha-3 국가 코드 | String | KYC 제출자 정보 |
data.idcard_issueDate | 신분증 발급일 (YYYY-MM-DD 형식) | String | KYC 제출자 정보 |
data.idcard_expireDate | 신분증 만료일 (YYYY-MM-DD 형식) | String | KYC 제출자 정보 |
data.identityNumber | 주민등록번호 | String | KYC 제출자 정보 |
data.documentNumber | 신분증 번호 | String | KYC 제출자 정보 |
data.address_city | 도시 | String | KYC 제출자 정보 |
data.address_country | 국가 | String | KYC 제출자 정보 |
data.address_state | 주 | String | KYC 제출자 정보 |
data.address_street | 도로 | String | KYC 제출자 정보 |
data.address_zipcode | 우편번호 | String | KYC 제출자 정보 |
data.address_globalCode | 글로벌 주소 코드 (예: 8Q98HXPG+MP) | String | KYC 제출자 정보 |
data.address_compoundCode | 복합 주소 코드 (예: HXPG+MP 서울, 대한민국) | String | KYC 제출자 정보 |
data.address_formatted | 변환된 상세 주소 | String | KYC 제출자 정보 |
data.address_input | 사용자가 입력한 주소 | String | KYC 제출자 정보 |
data.address_detail | 사용자가 입력한 상세 주소 | String | KYC 제출자 정보 |
data.cf1 | 사용자 정의 필드 #1 | String | KYC 제출자 정보 |
data.cf2 | 사용자 정의 필드 #2 | String | KYC 제출자 정보 |
data.cf3 | 사용자 정의 필드 #3 | String | KYC 제출자 정보 |
email | 제출과 연관된 이메일 주소 | String | KYC 제출자 정보 |
reviewer | 검수 유형: system 은 AI 시스템 검수, agent 는 사람 검수를 나타냄 | Enum | KYC 검수 정보 |
submission_id | 각 제출 건에 부여된 고유 식별자 | String | 제출 정보 |
applicant_id | 중복 제출된 사용자에 부여된 식별자 | String | 제출 정보 |
created_at | 제출된 날짜와 시간 (UTC+0) | String | 제출 정보 |
kyc_result_at | KYC 결과가 최종적으로 결정된 날짜와 시간 | String | 제출 정보 |
updated_at | 마지막으로 제출 정보가 업데이트된 날짜와 시간 | String | 제출 정보 |
pending_at | KYC가 보류(Pending) 상태로 표시된 날짜와 시간 | String | 제출 정보 |
userid | 제출 생성 시 선택적으로 추가된 파라미터 | String | 제출 정보 |
additional_list | 대시보드에서 설정된 추가 양식에 대해 사용자가 입력한 데이터 | Array | 추가 양식 정보 |
additional_list.answer | 각 추가 양식 필드의 이름 | String | 추가 양식 정보 |
additional_list.inputValue | 각 필드에 대한 사용자 입력 값 | String | 추가 양식 정보 |
additional_list.blockType | 각 추가 양식 필드의 데이터 타입 | String | 추가 양식 정보 |
kyc | KYC 결과를 포함하는 객체 KYC 상태 | Object | KYC 결과 정보 |
kyc.result | KYC 프로세스의 상태 | Enum | KYC 결과 정보 |
kyc.comment | KYC 거절 사유 거절 코드 및 사유 | String | KYC 결과 정보 |
kyc.commentCode | KYC 거절 사유를 나타내는 코드 거절 코드 및 사유 | String | KYC 결과 정보 |
kyc.attempts[i].attemptCnt | 실패 후 재시도한 횟수 | Number | KYC 시도 정보 |
kyc.attempts[i].idBarcodeResult | 미국, 캐나다, 멕시코 신분증의 바코드 검증 결과 | String | KYC 시도 정보 |
kyc.attempts[i].verificationResult | 신분증 진위 확인 결과 (success , fail ) | Enum | KYC 시도 정보 |
kyc.attempts[i].verification | 신분증 진위 확인 결과의 상세 데이터 | Object | KYC 시도 정보 |
kyc.attempts[i].verificationParams | 신분증 진위 확인 실행 시 필요한 매개변수 | Object | KYC 시도 정보 |
kyc.attempts[i].errorCode | 얼굴 인식, 비교, 신분증 진위 확인 중 발생한 오류 코드 | String | KYC 시도 정보 |
kyc.attempts[i].errorMsg | 얼굴 인식, 비교, 신분증 진위 확인 중 발생한 오류 메시지 | String | KYC 시도 정보 |
kyc.attempts[i].step1Time1st | step1 첫 번째 호출 시간 | String | KYC 시도 정보 |
kyc.attempts[i].step1Time2nd | step1 두 번째 호출 시간 | String | KYC 시도 정보 |
kyc.attempts[i].step1Time3rd | step1 세 번째 호출 시간 | String | KYC 시도 정보 |
kyc.attempts[i].step2Time1st | step2 첫 번째 호출 시간 | String | KYC 시도 정보 |
kyc.attempts[i].step2Time2nd | step2 두 번째 호출 시간 | String | KYC 시도 정보 |
kyc.attempts[i].step2Time3rd | step2 세 번째 호출 시간 | String | KYC 시도 정보 |
kyc.attempts[i].retryMsg | 얼굴 인식, 비교, 신분증 진위 확인 중 발생한 실패 메시지 | String | KYC 시도 정보 |
kyc.attempts[i].retryCode | 얼굴 인식, 비교, 신분증 진위 확인 중 발생한 실패 코드 | String | KYC 시도 정보 |
kyc.attempts[i].faceSimilarityScore | 얼굴 비교 유사도 점수 | Float | KYC 시도 정보 |
kyc.attempts[i].selfieImage | 제출된 셀피 이미지의 URL | String | KYC 시도 정보 |
kyc.attempts[i].livenessScore | 시도의 생체 인증 점수 | Float | KYC 시도 정보 |
kyc.attempts[i].liveness | 생체 인증 점수의 상세 데이터 (score , probability , quality 포함) | Object | KYC 시도 정보 |
kyc.attempts[i].liveness.score | 생체 인증의 전체 점수 | Float | KYC 시도 정보 |
kyc.attempts[i].liveness.probability | 생체 인증의 확률 값 | Float | KYC 시도 정보 |
kyc.attempts[i].liveness.quality | 생체 인증의 품질 점수 | Float | KYC 시도 정보 |
aml | AML 스크리닝 결과를 포함하는 객체 | Object | AML 스크리닝 정보 |
aml.raw_data | AML 스크리닝의 원시 데이터 | Object | AML 스크리닝 정보 |
aml.risk_level_summary | 리스크 수준 요약 (Not Screened , High , Medium , Low ) Risk Level | Enum | AML 스크리닝 정보 |
aml.currentstatus | AML 스크리닝의 현재 상태 (Not Screened , Red Flag ) AML Screening Status | Enum | AML 스크리닝 정보 |
aml.matches | AML 스크리닝의 상세 매칭 결과 | Array | AML 스크리닝 정보 |
aml.matches[i].risk_level | 레드 플래그 위험 수준 (HIGH , MEDIUM , LOW ) AML Screening Info | Enum | AML 스크리닝 정보 |
aml.matches[i].argos_number | AML 보고서를 조회하기 위한 고유 ID | String | AML 스크리닝 정보 |
aml.matches[i].resource_id | AML 보고서를 조회하기 위한 리소스 고유 ID | String | AML 스크리닝 정보 |
aml.matches[i].score | AML 스크리닝 매칭 점수 | Float | AML 스크리닝 정보 |
aml.matches[i].risk_icons | AML 스크리닝 위험 아이콘 | Array | AML 스크리닝 정보 |
nextpageKey | 추가 페이지를 호출할 때 필요한 키 | Object | 페이지 네비게이션 정보 |
nextpageKey.id | 마지막으로 조회된 제출 ID | String | 페이지 네비게이션 정보 |
nextpageKey.created_at | 마지막으로 조회된 제출의 생성 시간 | String | 페이지 네비게이션 정보 |
bank_verification | 계좌 인증 결과를 포함하는 객체 | Object | 계좌 인증 정보 |
bank_verification.result | 계좌 인증 결과 (success , fail ) | Enum | 계좌 인증 정보 |
bank_verification.type | 계좌 인증 유형 (occupancy (1원 인증), nameCheck ) | Enum | 계좌 인증 정보 |
bank_verification.bank_code | 계좌 인증에 사용된 은행 코드 | String | 계좌 인증 정보 |
bank_verification.account_number | 계좌 인증에 사용된 계좌 번호 | String | 계좌 인증 정보 |
bank_verification.retry_count | 코드 전송 실패 횟수 (pre-step2) | Number | 계좌 인증 정보 |
id_LivenessScore | ID 카드 생체 인증 점수 데이터를 포함하는 객체 | Object | 생체 인증 점수 정보 |
id_LivenessScore.Screen_play | Screen play 파이프라인의 생체 인증 점수 | Float | 생체 인증 점수 정보 |
id_LivenessScore.Paper_printed | Paper printed 파이프라인의 생체 인증 점수 | Float | 생체 인증 점수 정보 |
id_LivenessScore.Replace_portraits | Replace portraits 파이프라인의 생체 인증 점수 | Float | 생체 인증 점수 정보 |
Injection_action | Injection 프로세스 실행 내역을 포함하는 객체 | Object | Injection 프로세스 정보 |
Injection_action.type | Injection 프로세스 유형 | String | Injection 프로세스 정보 |
Injection_action.time | Injection 프로세스 유형별 최근 실행 시간 | String | Injection 프로세스 정보 |
tokenId | Private mode에서 제출 시 사용된 Token ID | String | 제출 정보 |
5-3. 오류 코드
에러 코드 | 메시지 | 설명 |
---|---|---|
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} | 예상치 못한 매개변수가 제출됨 |
invalid_format | invalid format: ${parameter} | 매개변수가 예상 형식과 일치하지 않음 |
processing_error | Failed to complete migration | 처리 중 알 수 없는 오류 발생 |
6. 암호화 옵션
보안 강화를 위해 요청 본문을 암호화할 수 있습니다. 암호화를 사용할 때:
전체 요청 본문 객체를 암호화합니다.
암호화된 문자열을 body
매개변수로 전송합니다.
6-1. 암호화된 요청 예시
result.json
6-2. 암호화된 응답
응답에는 isEncrypted 플래그와 암호화된 데이터가 포함됩니다:
result.json
Was this page helpful?