post
https://api-v3.authenticating.com/identity/v2/document/scan
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
This endpoint is used to upload the front and back of a user's driver's license or ID card for verification. Unlike Upload ID, the images are sent as files using multipart/form-data and not as base64 strings.
This is an asynchronous call. It returns a 202 with result as in_progress as soon as the images are saved, and the scan runs in the background. Once the scan is done, the result can be fetched in one of the following ways:
- Webhook (recommended): The
GOVT_ID_SCAN_STATUS_UPDATEevent is sent to all the active webhook URLs of your company. Details on the payload can be checked here. - Status API: Call Check Upload ID V2 every few seconds until
resultis no longerin_progress.
If the webhook is not received within a few minutes, call the status API. It always has the latest result.
Before calling this endpoint, the user must be created using Create User and consent must be recorded using User Consent.
Request Body (multipart/form-data)
multipart/form-data)| Field | Type | Required | Notes |
|---|---|---|---|
userAccessCode | text | Yes | userAccessCode of the user. |
idFront | file | Yes | Front of the ID. JPG, JPEG or PNG, 5MB or smaller. |
idBack | file | Yes | Back of the ID. Same format as the front, 5MB or smaller. |
Important Notes:-
- This call does not tell you whether the ID passed or not. A
202only means the images were uploaded successfully and the scan has started. - Only the following formats are accepted:- JPG, JPEG, PNG. Both images must be of the same format. PDF files and other image formats will not be accepted.
- The maximum allowed size of each image is 5MB.
- Only one scan can run at a time for a user. If a scan is already in progress, the call returns a
400. attemptsin the response is the number of scans this user has made on this endpoint.- Only two-sided documents are accepted here: driver's licenses, ID cards, residence documents, military IDs, voter IDs and permits. A passport or visa sent to this endpoint will not be verified and returns
restricted_doc_type. Please use Upload Passport V2 for those. - Make sure the images are clear, well-lit and free of glare, and all the edges of the ID are visible. To see a sample ID image, please see here.
Error Responses
| Status | errorCode | When |
|---|---|---|
400 | IDENTITY_ID_INVALID_IMAGE_UPLOAD | idFront or idBack is missing or is not sent as a file. |
400 | IDENTITY_IMAGE_TOO_LARGE | An image is larger than 5MB. |
400 | IDENTITY_INVALID_IMAGE_FORMAT | An image is not a JPG, JPEG or PNG, or the two images are of different formats. |
400 | IDENTITY_ID_ALREADY_COMPLETED | The ID has already been verified for this user. |
400 | IDENTITY_DOCUMENT_SCAN_IN_PROGRESS | A scan is already in progress for this user. |
400 | - | userAccessCode is missing or doesn't match any user from your company. |
401 | - | The API key is invalid, or consent is not recorded for the user. |
