Skip to main content
Notes
  • Only one image can be downloaded per API call.
  • If the requested image type does not exist for the submission, an error will be returned.

​
1. Endpoint

GET/Image

​
2. Authentication

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

​
3. Request Parameters

​
string
required
Unique ID of the submission
​
string
required
Type of image to download
  • idImage: Front side of the ID
  • idBackImage: Back side of the ID
  • selfieImage: Selfie image
  • addressImage: Address document image

​
4. Request Example

GET/Image

​
5. Response

​
5-1. Success Response

If the request is successful, the API directly returns the requested image file.

​
5-2. Error Codes

If an error occurs, the API returns a 400 status code with one of the following error messages: This API is a convenient way to retrieve and download various images uploaded during the ID Check submission process.