주의사항

  • 이미지 파일 형식: jpg, jpeg, png만 허용됩니다.
  • 모든 이미지는 Base64 인코딩된 문자열로 제출해야 합니다.
  • idImage 또는 idBackImage를 제출할 경우 반드시 idType 파라미터를 포함해야 합니다.
  • 최소 한 개 이상의 이미지를 제출해야 합니다.

1. 엔드포인트

PUT/Image
PUT https://rest-api.argosidentity.com/v3/submission/image

2. 인증

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

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

3. 요청 파라미터

submissionId
string
required

제출 건의 고유 ID

admin
string
required

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

idType
string
required

신분증 유형 (idImage 또는 idBackImage 제출 시 필수)

idImage
base64String

신분증 앞면 이미지 (Base64 형식)

idBackImage
base64String

신분증 뒷면 이미지 (Base64 형식)

selfieImage
base64String

셀피 이미지 (Base64 형식)

addressImage
base64String

주소지 이미지 (Base64 형식)

4. 요청 예시

PUT/Image
curl --location --request PUT 'https://rest-api.argosidentity.com/v3/submission/image' \
--header 'x-api-key: {yourAPIKey}' \
--form 'submissionId="sampleSubmissionId11"' \
--form 'admin="sample@argosidentity.com"' \
--form 'idType="drvlic"' \
--form 'idImage={base64String}' \
--form 'idBackImage={base64String}' \
--form 'selfieImage={base64String}' \
--form 'addressImage={base64String}'

5. 응답

5-1. 성공 응답

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

5-2. 응답 데이터

필드명설명데이터 타입
message성공 메시지String

5-3. 오류 응답

result.json
{
    "errorCode": "invalid_payload",
    "message": "Fail to parse the input data."
}

5.4 오류 코드

오류 코드메시지설명
invalid_payloadFail to parse the input data.입력 데이터 형식이 올바르지 않음
missing_dataRequired input data is missing.필수 데이터 누락
invalid_projectCannot find project info.프로젝트 ID가 존재하지 않음
invalid_projectInvalid project.유효하지 않은 프로젝트 상태
invalid_adminInvalid admin.유효하지 않은 관리자
invalid_submissionInvalid submission.유효하지 않은 submission ID
invalid_dataAt least one image parameter is required.이미지가 하나도 제출되지 않음
missing_dataThe idType is required when submit idImage or idBackImage.신분증 이미지 제출 시 idType 누락
invalid_idTypeInvalid IdType.유효하지 않은 idType
processing_errorFailed to put image.데이터 처리 중 알 수 없는 오류

이 API를 사용하여 기존 Submission에 새로운 이미지를 추가하거나 기존 이미지를 업데이트할 수 있습니다. 오류 발생 시 제공된 오류 코드를 참조하여 문제를 해결하세요.

Was this page helpful?