Skip to main content
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 and headers

This API requires the request body to be sent as multipart/form-data.
HeaderValueRequired
x-api-keyYour API keyRequired
Content-Typemultipart/form-dataRequired
When using curl’s --form option or Python requests library’s files parameter, the Content-Type: multipart/form-data header and boundary value are set automatically. Setting the header manually may omit the boundary value and cause the request to fail.

​
3. Request parameters

All parameters are sent as multipart/form-data fields.
​
submissionId
string
required
Unique ID of the submission
​
admin
string
required
Project administrator’s account (must be registered in the dashboard)
​
idType
string
Type of ID document. Required when submitting idImage or idBackImage.
​
idImage
string
Front side of the ID document, Base64 encoded
​
idBackImage
string
Back side of the ID document, Base64 encoded
​
selfieImage
string
Selfie image, Base64 encoded
​
addressImage
string
Address document image, Base64 encoded

​
4. Request example

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="drivers_license"' \
--form 'idImage={base64String}' \
--form 'idBackImage={base64String}' \
--form 'selfieImage={base64String}' \
--form 'addressImage={base64String}'
When using the Python requests library’s files parameter, pass text fields as (None, "value") tuples. The first element None indicates no filename, which correctly sends text data as multipart/form-data fields.

​
5. Response

​
5-1. Success response

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

​
5-2. Response data

FieldDescriptionType
messageSuccess messageString

​
5-3. 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 when submitting an ID image.
invalid_idTypeInvalid IdType.The idType provided is invalid.
processing_errorFailed to put image.An unknown error occurred during processing.