PUT/Image

Definition

• Add or update (overwrite) four types of images to an already created Submission.

• The target images are the front, back, selfie image, and address image of the ID card.

Input Data

• Image extensions can be submitted as jpg, jpeg, or png.

• Image data format is submitted as Base64 String.

• When submitting one or more of idImage (front of ID) or idBackImage (back of ID), the idType parameter is required.

Parameter	Type	Required	Description
submissionId	String	O	Unique ID of the submission (= submissionId)
admin	String	O	Project manager's account (must be registered in the dashboard)
idType	String	O (Conditional)	ID type. Required when submitting at least one of idImage and idBackImage. (drivers_license | government_id | passport | residence_permit | vehicle_registration_certificate | visa | aadhaar | pancard ) Choose 1
idImage	base64 String	X	Front image of ID card (Base64 format)
idBackImage	base64 String	X	Back image of ID card (Base64 format)
selfieImage	base64 String	X	Selfie image (Base64 format)
addressImage	base64 String	X	Address image (Base64 format)

Output Data

Response	Description
message	success message

Error Codes (400 error)

errorCode	Message	Description
invalid_payload	Fail to parse the input data.	Input data format is incorrect
missing_data	Required input data is missing.	Required data missing
invalid_project	Cannot find project info.	Project ID does not exist
invalid_project	Invalid project.	Invalid project status
invalid_admin	Invalid admin.	Invalid Administrator
invalid_submission	Invalid submission.	Invalid submission ID
invalid_data	At least one image parameter is required.	If you have not submitted any of the 4 images
missing_data	The idType is required when submit idImage or idBackImage.	One or more of idImage and idBackImage were submitted, but idType was missing.
invalid_idType	Invalid IdType.	Invalid idType
processing_error	Failed to put image.	Unknown error while processing data. (CS manager inquiry)

Request URL

• You must enter the URL and x-api-key.

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

Sample Request

• Submit in Body/Raw Json format.

• Only one submission is allowed.

curl --location --request PUT '<https://rest-api.argoskyc.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."
}