Image Request endpoint version 3

get

https://upload.socure.com/api/3.0/documents/{uuid}

The Image Request endpoint (v3) is planned for deprecation in a future release.
New integrations should use Image Request endpoint (v5).

Get a ZIP file containing copies of a consumer's uploaded ID and selfie images from Socure's servers. See Image Request Endpoint Version 3 for more information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

string

required

The unique identifier associated with the uploaded images. The uuid is returned in the response when you upload an ID using the Document Upload endpoint.

Query Params

imagequality

string

enum

Defaults to original

The quality of the retrieved images.

The API returns the original images by default. Specify optimized to retrieve copies of the images that are compressed to a smaller file size. Only images above 650 DPI are optimized.

Note: We recommend retrieving the original images.

Allowed:

type

string

enum

Returns the specified image only. If omitted, the API will return all images.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/zip

application/json

200Success

400Bad Request

401Unauthorized