Notes

  • Allowed image formats: jpg, jpeg, png.
  • All images must be submitted as Base64 encoded strings.
  • The idType parameter is required when submitting idImage or idBackImage.
  • At least one image must be submitted.

​
1. Endpoint

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

​
2. Authentication

Include the API key in the x-api-key header:

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

​
3. Request Parameters

​
submissionId
string
required

Unique ID of the submission

​
admin
string
required

Project administrator’s account (must be registered in the dashboard)

​
idType
string
required

Type of ID (required when submitting idImage or idBackImage)

​
idImage
base64String

Front side of the ID image (Base64 format)

​
idBackImage
base64String

Back side of the ID image (Base64 format)

​
selfieImage
base64String

Selfie image (Base64 format)

​
addressImage
base64String

Address document image (Base64 format)

​
4. Request Example

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. Response

​
5-1. Success Response

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

​
5-2. Error Response

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

​
5.4 Error Codes

Error CodeMessageDescription
invalid_payloadFail to parse the input data.The format of the input data is invalid.
missing_dataRequired input data is missing.Some required fields are missing.
invalid_projectCannot find project info.The project ID does not exist.
invalid_projectInvalid project.The project status is invalid.
invalid_adminInvalid admin.The administrator is invalid.
invalid_submissionInvalid submission.The submission ID is invalid.
invalid_dataAt least one image parameter is required.No image was submitted.
missing_dataThe idType is required when submit idImage or idBackImage.The idType is missing for ID image submission.
invalid_idTypeInvalid IdType.The idType provided is invalid.
processing_errorFailed to put image.An unknown error occurred during data processing.

This API allows you to add new images or update existing ones for a submission. Refer to the error codes if an issue occurs to resolve it effectively.

Was this page helpful?

GET/ImageGET/AML/Report