Skip to main content

KYC Direct processing

Requirements
  • API key
  • Direct Processing enabled (done by iDenfy's 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

Sending request​

Token generation API

Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/process

The request must contain JSON with these parameters:

authToken| Type: String
Explanation:

Verification token

Constraints:

null

country| Type: String
Explanation:

Country code in 3166-1 alpha-2 format

Constraints:

Any country in alpha-2 code

documentType| Type: String
Explanation:

Document type

Constraints:

Possible values:

  • ID_CARD
  • PASSPORT
  • RESIDENCE_PERMIT
  • DRIVER_LICENSE
  • OTHER
images| Type: Object
Explanation:

Images for verification (Base64 format)

Constraints:

See below in Image object parameters

FRONT| Type: String
Explanation:

Base64 encoded image of document front

Constraints:
  • Max size of 6MB
BACK| Type: String
Explanation:

Base64 encoded image of document back

Constraints:
  • Max size of 6MB
FACE| Type: String
Explanation:

Base64 encoded image of persons face

Constraints:
  • Max size of 6MB
UTILITY_BILL| Type: String
Explanation:

Base64 encoded image of an utility bill or any other custom additional step that was set in advance

Constraints:
  • Max size of 6MB
Possible Errors:
  • Invalid JSON or API key/secret → standard iDenfy error response. See iDenfy error messages.
  • 200 OK with error → document not detected in the photo.

In such cases try one of these:

  • Disable Validate photos in environment settings (done by iDenfy's staff)
  • Add skipAnalysis: true in the request
  • Use a clearer photo with visible document/selfie

Request example​

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

Response example​

For successful API calls, which start the processing, there will be no message, just a response with a positive 200 status.

Response example - failed​

Failed API calls will return a message identifying the problem.

{
  "message": "No image provided for step 'BACK'",
  "identifier": "MISSING_VALUE",
  "documentation": "https://documentation.idenfy.com",
  "severity": "NOT_SEVERE"
}