REVIEW/Submission

이 API는 프로젝트 설정에 따라 pending 상태의 KYC 제출 건을 수동으로 검토해야 하는 프로젝트 관리자에게 특히 유용합니다. 프로젝트 설정에서 검토자가 ‘Client’로 설정된 경우, ARGOS Agent는 해당 pending 제출 건을 검토하지 않습니다.

이 API를 사용해서는 pending 상태의 제출 건만 검토할 수 있습니다. 이미 승인되거나 거부된 제출 건은 이 엔드포인트를 통해 수정할 수 없습니다. 관리자 이메일이 대시보드에 등록되어 있고 해당 프로젝트에 대한 적절한 권한이 있는지 확인하세요.

1. 엔드포인트

POST https://rest-api.argosidentity.com/v3/submission/review

POST https://kr.rest-api.argosidentity.com/v3/submission/review

2. 인증

x-api-key 헤더에 API 키를 포함시켜야 합니다:

x-api-key

x-api-key: {yourAPIKey}

3. 요청 본문

요청 파라미터는 URL query 형식이어야 합니다. 각 파라미터에 대한 설명은 다음과 같습니다.

string

필수

검수 할 submission 의 프로젝트에 관리자로 등록된 admin 계정

string

필수

검토할 pending 제출 건의 고유 ID

string

필수

변경하고자 하는 상태 값: approved 또는 rejected

string

필수

검토 결정에 대한 설명 코멘트 (선택사항). status가 rejected인 경우 필수 값

string

변경할 데이터 필드

4. 요청 예시

curl --location 'https://rest-api.argosidentity.com/v3/submission/review' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {yourAPIKey}' \
--data-raw '{
    "submissionId": "string",
    "status": "string",
    "rejectComment": "string",
    "updateFields": {
      "fullName": "string",
      "gender": "string",
      "issueDate": "string",
      "expireDate": "string",
      "birthDate": "string",
      "idType": "string"
    },
    "admin": "string"
  }

curl --location 'https://kr.rest-api.argosidentity.com/v3/submission/review' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {yourAPIKey}' \
--data-raw '{
    "submissionId": "string",
    "status": "string",
    "rejectComment": "string",
    "updateFields": {
      "fullName": "string",
      "gender": "string",
      "issueDate": "string",
      "expireDate": "string",
      "birthDate": "string",
      "idType": "string"
    },
    "admin": "string"
  }

5. 응답

5-1. 성공 응답

result.json

{
    "submissionId": "string",
    "message": "Success to review submission.",
    "finalStatus": "approved"
}

5-2. 오류 응답 예시

오류가 발생하면 400 상태 코드와 함께 응답 본문에 세부 정보가 포함됩니다:

error.json

{
    "message": "Project not found."
}

5-3. 오류 코드

오류 유형	메시지	설명
`Validation : project`	Project not found.	유효하지 않은 api-key 또는 project 데이터
`Validation : project`	admin is required.	admin 미제출
`Validation : project`	Access denied. The admin is not registered in the project.	project 에 등록되지 않은 admin 또는 유효하지 않은 admin 데이터
`Validation : submission`	Submission Id is required.	submission ID 미제출
`Validation : submission`	Invalid Submission Id.	유효하지 않은 submission 데이터
`Validation : submission`	Only submissions in pending status can be reviewed	submission 이 pending 상태가 아님.
`Validation : submission`	This submission cannot be reviewed by client	client review 가능한 submission 아님
`Validation : request parameter`	Invalid status	변경할 status 가 approved 또는 rejected 가 아님
`Validation : request parameter`	Invalid data format.	updateFields 의 포맷이 올바르지 않음 (object 필수)
`Validation : request parameter`	Reject comment is required	rejected 로 상태 변경 시, rejectedComment 필수값 미제출
`Validation : request parameter`	Invalid idType	유효하지 않은 idType
`Validation : request parameter`	Invalid gender	유효하지 않은 gender
`Validation : request parameter`	Invalid issueDate format. Use YYYY-MM-DD	유효하지 않은 date format (yyyy-mm-dd 필수)
`Validation : request parameter`	Invalid expireDate format. Use YYYY-MM-DD	유효하지 않은 date format (yyyy-mm-dd 필수)
`Validation : request parameter`	Invalid birthDate format. Use YYYY-MM-DD	유효하지 않은 date format (yyyy-mm-dd 필수)
`Processing Error`	Failed to process submission	데이터 프로세싱 중 정의되지 않은 에러 발생
`Processing Error`	Error in submission review process.	검수 프로세싱 중 정의되지 않은 에러 발생

시작하기

‘ID check API는 기업 고객이 KYC(Know Your Customer) 및 AML(Anti-Money Laundering) 프로세스를 보다 체계적이고 효율적으로 관리할 수 있도록 설계된 솔루션입니다. 이 API는 기존 시스템과의 원활한 통합을 지원하며, 사용자 데이터를 안전하게 처리하고 관리할 수 있는 기능을 제공합니다.

GET/Submission 응답 필드 정의

GET/Submission API 응답에 포함되는 모든 필드에 대한 상세 정의

웹훅 이벤트

ARGOS ID check의 KYC 프로세스 상태 변경을 실시간으로 확인하세요. 웹훅을 통해 즉각적인 업데이트를 받아볼 수 있습니다.

개요

API 참조

1. 엔드포인트

2. 인증

3. 요청 본문

4. 요청 예시

5. 응답

5-1. 성공 응답

5-2. 오류 응답 예시

5-3. 오류 코드

관련 문서

시작하기

GET/Submission 응답 필드 정의

웹훅 이벤트

​1. 엔드포인트

​2. 인증

​3. 요청 본문

​4. 요청 예시

​5. 응답

​5-1. 성공 응답

​5-2. 오류 응답 예시

​5-3. 오류 코드

​관련 문서

시작하기

GET/Submission 응답 필드 정의

웹훅 이벤트

1. 엔드포인트

2. 인증

3. 요청 본문

4. 요청 예시

5. 응답

5-1. 성공 응답

5-2. 오류 응답 예시

5-3. 오류 코드

관련 문서