PATCH/Submission

• 단일 제출 데이터의 정보를 수정합니다.

• 수정된 데이터는 재수정은 가능하지만, 기존으로 복원할 수 없습니다.

Request URL

• URL과 x-api-key를 반드시 입력해 주어야 합니다.

curl -X PATCH "https://rest-api.argosidentity.com/v3/submission" \
-H "x-api-key: {yourAPIKey}" \

Sample Request

• 제출된 KYC 데이터(submission)를 수정하기 위한 샘플 요청 값 입니다.

curl --location --request PATCH 'https://rest-api.argosidentity.com/v3/submission' \
--header 'x-api-key: {yourAPIKey}'

Sample Request

• 수정 요청 제출을 위한 샘플 데이터 입니다. (Body)

{
  "submissionId": "6xx28lo115832",
  "admin": "[e-mail]",
  "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"
		}
}

Sample Response

• 수정이 완료 되었을 때 확인할 수 있는 샘플 데이터 입니다.

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

Input Data

• KYC 데이터(submission)를 수정하기 위한 매개변수에 대해 설명합니다.

• 반드시 Value format 을 지켜야 합니다.

Parameter	Required	Type	Value format	Description
submissionId	required*	string		Submission ID. 각각의 제출건에 대한 고유 ID
admin	required*	string		해당 Project에 등록된 어드민(email) 계정
data	required*	object		수정하고자 하는 데이터 항목을 담은 객체. 내부에 아래의 최소 1개 이상 프로퍼티 포함 필수
data.kycStatus	Optional	string	-approved -rejected	KYC 결과 수정
data.idType	Optional	string	-passport -drivers_license -government_id -residence_permit -vehicle_registration_certificate -visa -aadhaar -pancard	신분증 유형 수정: Value format 중 1개 선택
data.issuingCountry	Optional	string	-KOR, USA, JPN … -ISO Alpha3 국가코드	신분증 발급 국가 수정: 유효한 ISO3 코드로 입력 (ISO 3166-1 alpha-3)
data.fullName	Optional	string	-hong kil dong	FullName 수정
data.gender	Optional	string	-female -male	성별 수정
data.birthDate	Optional	string	YYYY-MM-DD	생년월일 수정
data.nationality	Optional	string	-KOR, USA, JPN … -ISO Alpha3 국가코드	국적 수정: 유효한 ISO3 코드로 입력 (ISO 3166-1 alpha-3)
data.issueDate	Optional	string	YYYY-MM-DD	발급일자 수정
data.expireDate	Optional	string	YYYY-MM-DD	만료일자 수정
data.documentNumber	Optional	string	“50-11-J11354”	document number 수정: 입력 형식( ‘-’ 를 포함한 전체 문자열)
data.identityNumber	Optional	string	“983155-1111001”	identity number 수정: 입력 형식(’-’ 를 포함한 전체 문자열)
data.serialNumber	Optional	string	“07PN10”	serial number 수정: 입력 형식( ‘-’ 를 포함한 전체 문자열)

암호화 옵션 사용 시 Input Data

2024.06.21

• 암호화 옵션 사용 시, Input 및 Output 의 양 방향 암/복호화 추가

Request Body 를 암호화 하여 API 요청

body : encrypt({
		email : 'string',
		fullName : 'string',
		issuingCountry : 'string',
		birthDate: 'string'
		...
	})

---

Output Data

• KYC 데이터(submission) 수정 시 반환 되는 데이터 목록입니다.

Response	Description
message	KYC 데이터 수정 성공 실패 상태 값

암호화 옵션 사용 시 Output Data

Body 객체 내 ‘data’ 프로퍼티에 암호화 된 결과 반환

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