PATCH/Submission

이 API로 kycStatus를 변경하면 Updated 웹훅이 발송됩니다. approved / rejected 웹훅은 발송되지 않으며, 변경된 상태는 data.kyc_result에 문자열로 전달됩니다. 대시보드에서 제출 건을 수정하는 경우도 동일합니다.

1. 엔드포인트

PATCH https://rest-api.argosidentity.com/v3/submission

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

2. 인증

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

x-api-key

x-api-key: {yourAPIKey}

3. 요청 본문

요청 본문은 JSON 형식이어야 합니다. 다음은 필드 설명입니다:

string

필수

수정할 제출 건의 고유 ID

string

필수

프로젝트 관리자의 이메일 (대시보드에 등록되어 있어야 함)

object

수정할 데이터 항목을 포함하는 객체

표시 properties

string

KYC 결과: approved 또는 rejected

string

ID 유형 ID 카드 코드

string

ID 발급 국가 국가 코드

string

KYC 제출자의 전체 이름

string

KYC 제출자의 이름

string

KYC 제출자의 가족 이름(성)

string

female 또는 male

string

KYC 제출자의 생년월일

string

KYC 제출자의 국적 국가 코드

string

ID 발급일 YYY-MM-DD 형식

string

ID 만료일 YYY-MM-DD 형식

string

KYC 제출자의 문서 번호

string

KYC 제출자의 신분증 번호

string

KYC 제출자의 운전면허번호

string

KYC 제출자에 대한 Admin의 메모; 요청 시, 대시보드의 상세페이지에서 메모에 기록

4. 요청 예시

curl --location --request PATCH 'https://rest-api.argosidentity.com/v3/submission' \
--header 'x-api-key: {yourAPIKey}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "submissionId": "6xx28lo115832",
  "admin": "yourAdmin@sample.com",
  "data": {
    "idType": "drivers_license",
    "issuingCountry": "KOR",
    "fullName": "hong kil dong",
    "firstName": "kil dong",
    "lastName": "hong",
    "gender": "male",
    "birthDate": "1999-11-31",
    "nationality": "USA",
    "kycStatus": "approved",
    "issueDate": "2017-10-19",
    "expireDate": "2027-10-18",
    "identityNumber": "991131-1111111",
    "documentNumber": "05-167-U0815",
    "serialNumber": "07PN10",
    "memo": "This is an example for memo"
  }
}'

curl --location --request PATCH 'https://kr.rest-api.argosidentity.com/v3/submission' \
--header 'x-api-key: {yourAPIKey}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "submissionId": "6xx28lo115832",
  "admin": "yourAdmin@sample.com",
  "data": {
    "idType": "drivers_license",
    "issuingCountry": "KOR",
    "fullName": "hong kil dong",
    "firstName": "kil dong",
    "lastName": "hong",
    "gender": "male",
    "birthDate": "1999-11-31",
    "nationality": "USA",
    "kycStatus": "approved",
    "issueDate": "2017-10-19",
    "expireDate": "2027-10-18",
    "identityNumber": "991131-1111111",
    "documentNumber": "05-167-U0815",
    "serialNumber": "07PN10",
    "memo": "This is an example for memo"
  }
}'

5. 응답

5-1. 성공 응답

result.json

{
  "message": "success to edit.",
  "statusCode": 200
}

5-2. 오류 응답

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

error.json

{
    "errorCode": "invalid_payload",
}

5-3. 오류 코드

에러 코드	설명
`API-Key is required.`	API 키가 누락됨
`The project is not found.`	프로젝트를 찾을 수 없음
`Decryption is Failed. Please check the api-key.`	데이터 복호화 실패
`Data Processing Error.`	데이터 암호화 실패
`data parsing error. please check input data.`	데이터 파싱 오류
`submissionId is required.`	submissionId 누락
`projectId or x-api-key is required.`	projectId 또는 x-api-key 누락
`admin is required.`	admin 정보 누락
`At least one property to modify is required.`	수정할 속성 누락
`Invalid idType. Please check the idType.`	잘못된 신분증 유형
`Invalid kyc status. Please check the kycStatus.`	잘못된 KYC 상태
`Invalid gender. Please check the gender.`	잘못된 성별 값
`Invalid issuingCountry. Please enter a valid ISO 3166-1 alpha-3.`	잘못된 발급국가 코드
`Invalid nationality. Please enter a valid ISO 3166-1 alpha-3.`	잘못된 국적 코드
`Invalid birthDate. Please enter the date as YYYY-MM-DD`	잘못된 생년월일 형식
`Invalid issueDate. Please enter the date as YYYY-MM-DD`	잘못된 발급일자 형식
`Invalid expireDate. Please enter the date as YYYY-MM-DD`	잘못된 만료일자 형식

6. 암호화 옵션

보안 강화를 위해 요청 본문을 암호화할 수 있습니다. 전체 요청 본문 객체를 암호화한 문자열을 HTTP 요청 본문에 그대로 넣습니다. JSON 객체나 data 필드로 감싸지 않고 URL 인코딩하지 않습니다.

POST·PATCH 요청 본문의 암호문은 raw base64 문자열로 전달합니다. GET 요청의 암호문은 URL 인코딩한 뒤 data 쿼리 파라미터로 전달합니다. 암호화 방법은 API 요청 데이터 암호화 (AES-256-ECB)를 참조하세요.

6-1. 암호화된 요청 예시

patch-encrypted.py

encryption = Encryption(api_key, mode='ECB')

payload_data = {
    "admin": "yourAdmin@sample.com", 
    "submissionId": "6xx28lo115832", 
    "data": {
        "kycStatus": "approved",
        "fullName": "hong kil dong"
    }
}

# 전체 payload를 암호화
payload_encrypted = encryption.encrypt(payload_data)

# 암호문 문자열을 요청 본문에 그대로 전송 (JSON으로 감싸거나 URL 인코딩하지 않음)
response = requests.patch(
    url,
    headers=headers,
    data=payload_encrypted
)

curl --location --request PATCH 'https://rest-api.argosidentity.com/v3/submission' \
--header 'x-api-key: {yourAPIKey}' \
--header 'Content-Type: application/json' \
--data 'N34SNtWaavEfgtg1g+o+9JhQ9rp9dGUbyFNxAsHKKGH24aVQTRXYfNpFDHIGJU6Wo0RVpOupAubiDvFDuFyTkw=='

curl --location --request PATCH 'https://kr.rest-api.argosidentity.com/v3/submission' \
--header 'x-api-key: {yourAPIKey}' \
--header 'Content-Type: application/json' \
--data 'N34SNtWaavEfgtg1g+o+9JhQ9rp9dGUbyFNxAsHKKGH24aVQTRXYfNpFDHIGJU6Wo0RVpOupAubiDvFDuFyTkw=='

6-2. 암호화된 응답

응답에는 isEncrypted 플래그와 암호화된 데이터가 포함됩니다:

result.json

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

시작하기

‘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. 오류 코드

6. 암호화 옵션

6-1. 암호화된 요청 예시

6-2. 암호화된 응답

관련 문서

시작하기

GET/Submission 응답 필드 정의

웹훅 이벤트

​1. 엔드포인트

​2. 인증

​3. 요청 본문

​4. 요청 예시

​5. 응답

​5-1. 성공 응답

​5-2. 오류 응답

​5-3. 오류 코드

​6. 암호화 옵션

​6-1. 암호화된 요청 예시

​6-2. 암호화된 응답

​관련 문서

시작하기

GET/Submission 응답 필드 정의

웹훅 이벤트

1. 엔드포인트

2. 인증

3. 요청 본문

4. 요청 예시

5. 응답

5-1. 성공 응답

5-2. 오류 응답

5-3. 오류 코드

6. 암호화 옵션

6-1. 암호화된 요청 예시

6-2. 암호화된 응답

관련 문서