PUT/Image

Definition

• 이미 생성된 Submission 에 대하여 4종류의 이미지 새로 추가 또는 업데이트(오버라이트) 합니다.

• 대상 이미지는 신분증 앞면, 뒷면, 셀피이미지, 주소지이미지 입니다.

Input Data

• 이미지 확장자는 jpg, jpeg, png 제출 가능합니다.

• 이미지 데이터 형식은 Base64 String 으로 제출합니다.

• idImage(신분증 앞면) 또는 idBackImage(신분증 뒷면) 중 1개 이상 제출 시, idType 파라미터 필수 입니다.

Parameter	Type	Required	Description
submissionId	String	O	제출건의 고유 ID (= submissionId)
admin	String	O	프로젝트 관리자의 계정 (대시보드에 등록되어 있어야 함)
idType	String	O (Conditional)	신분증 유형. idImage, idBackImage 중 1개 이상 제출 시 필수. (drivers_license
idImage	base64 String	X	신분증 앞면 이미지 (Base64 형식)
idBackImage	base64 String	X	신분증 뒷면 이미지 (Base64 형식)
selfieImage	base64 String	X	셀피 이미지 (Base64 형식)
addressImage	base64 String	X	주소지 이미지 (Base64 형식)

Output Data

Response	Description
message	성공 메세지

Error Codes (400 error)

errorCode	Message	설명
invalid_payload	Fail to parse the input data.	Input 데이터 형식이 올바르지 않음
missing_data	Required input data is missing.	필수 데이터 누락
invalid_project	Cannot find project info.	프로젝트 ID 존재하지 않음
invalid_project	Invalid project.	유효하지 않은 프로젝트 상태
invalid_admin	Invalid admin.	유효하지 않은 관리자
invalid_submission	Invalid submission.	유효하지 않은 submission ID
invalid_data	At least one image parameter is required.	4종의 이미지 중 한 가지도 제출하지 않은 경우
missing_data	The idType is required when submit idImage or idBackImage.	idImage, idBackImage 중 한 가지 이상 제출했으나 idType 누락
invalid_idType	Invalid IdType.	유효하지 않은 idType
processing_error	Failed to put image.	데이터 처리 중 알 수 없는 에러. (CS 관리자 문의)

Request URL

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

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

Sample Request

• Body /Form-data 형식으로 제출합니다.

• 단 건 제출만 가능합니다.

curl --location --request PUT '<https://rest-api.argosidentity.com/dev/submission/image>' \\
--header 'x-api-key: {yourAPIKey}' \\
--form 'submissionId="sampleSubmissionId11"' \\
--form 'admin="[e-mail]"' \\
--form 'idType="drivers_license"' \\
--form 'idImage={base64String}' \\
--form 'idBackImage={base64String}' \\
--form 'selfieImage={base64String}' \\
--form 'addressImage={base64String}'

Sample Response

{
    "message": "complete to update image."
}