​
1. 엔드포인트

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

​
2. 인증

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

x-api-key
x-api-key: {yourAPIKey}

​
3. 요청 본문

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

​
submissionId
string
required

수정할 제출 건의 고유 ID

​
admin
string
required

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

​
data
object
required

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

​
4. 요청 예시

PATCH/Submission
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",
    "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"
  }
}'

​
5. 응답

​
5-1. 성공 응답

result.json
{
    "message": "Data Processing Success."
}

​
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. 암호화 옵션

보안 강화를 위해 요청 본문을 암호화할 수 있습니다. 암호화를 사용할 때: 전체 요청 본문 객체를 암호화합니다. 암호화된 문자열을 body 매개변수로 전송합니다.

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

result.json
body : encrypt({
		submissionId : 'string',
		admin : 'string',
		data : {
            ...
        }
	})

​
6-2. 암호화된 응답

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

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

Was this page helpful?