Skip to main content
Requirements:
  • API key pair
  • Direct Processing enabled (configured by iDenfy staff)
Limitations:
  • This implementation does not support 3D liveness detection or short photo sequences. If these are required, use a different integration type.
  • Images required for a specific document should be provided, usually at least FRONT and FACE.
  • The maximum request size is 20 MB.
  • Direct Processing cannot be used to update a verification. You need to either use the Request Update feature or perform a re-verification using the same clientId via token generation.

​
Sending request

POST https://ivs.idenfy.com/api/v2/process
Authorization: Basic {API_KEY}:{API_SECRET}
Content-Type: application/json

​
Request parameters

A unique string for the verification session. Must be 10-40 characters, ASCII only.
Country code in ISO 3166-1 alpha-2 format (e.g., LT, US).
Type of document being submitted. Possible values: ID_CARD, PASSPORT, DRIVER_LICENSE, RESIDENCE_PERMIT.
Object containing Base64-encoded images. Keys can include: FRONT, BACK, FACE.
Set to true to skip photo validation. Useful if document detection fails on valid photos.
Possible errors:
  • Invalid JSON or API key/secret returns a standard iDenfy error response. See error messages.
  • A 200 OK with an error message may indicate the document was not detected in the photo.
In such cases try one of these:
  • Disable Validate photos in environment settings (done by iDenfy staff)
  • Add skipAnalysis: true in the request
  • Use a clearer photo with a visible document or selfie

​
Request example

{
  "authToken": "3FA5TFPA2ZE3LMPGGS1EGOJNJE",
  "country": "LT",
  "documentType": "ID_CARD",
  "images": {
    "FRONT": "/9j/4AAQSkZJRgABAQAAAQABAAD/4...",
    "BACK": "/9j/4AAQSkZJRgABAQAAAQABAAD/4...",
    "FACE": "/9j/4AAQSkZJRgABAQAAAQABAAD/4..."
  }
}

​
Response

For successful API calls that start processing, there will be no message body — just a response with a 200 status code.

​
Failed response example

Failed API calls return a message identifying the problem. 
{
  "message": "No image provided for step 'BACK'",
  "identifier": "MISSING_VALUE",
  "documentation": "",
  "severity": "NOT_SEVERE"
}