Introduction

IDscan Core is the set of REST APIs inside IDscan Enterprise for verifying identity documents and the people who present them. Your own application sends images to the services and gets structured results back, so you keep complete control of the user experience, the user interface and the business rules you apply to the results. It is a server-to-server integration: you choose which services to call and how. The services run in the EU and the US and scale with your demand.

What you can do

• Verify an identity document: send one or more images of a passport, driving licence or ID card and get back its classification, the data read from it and the result of every authentication check. Proof-of-address documents can be read and verified too, and a document can be classified without being verified.
• Check that a person is live: passive liveness from a single selfie, enhanced liveness from an encrypted capture packet, biometric spoof detection, age estimation, celebrity checks, and extracting the portrait from a capture packet.
• Match two faces: compare the portrait from a document with a selfie, or any two facial images, and get a similarity score.

How it works

• One request per check. Each endpoint takes a POST with a multipart/form-data body: the image files and a few fields that describe them. The result comes back as JSON.
• Send an image, or refer to one. Most checks have two forms. The plain endpoint takes the image itself. The endpoint ending in /id takes the identifier of an image the service has already received, so a later check can reuse it without uploading it again.
• A token on every request. Requests are authorised with a JSON Web Token in the Authorization header. See Authentication.
• Your own reference on every request. Send an x-correlation-id header or CorrelationId field, and the service echoes it in the response, so you can match results to your own records and quote it to support.
• Two regions. Every service has an EU and a US address. See Requests and responses.

Where to start

1. Get started: your first document verification, from a token to a result.
2. Authentication: how requests are authorised.
3. Requests and responses: base addresses, request format, status codes and errors.
4. OpenAPI definitions: download each service’s definition to generate a client or try the API in your own tools.

The API reference is generated from the OpenAPI definition each service publishes, so it describes the services as they are deployed. When a service changes, the reference changes with it.