OpenAPI definitions

Each IDscan Core service describes itself with an OpenAPI definition. The API reference on this site is generated from these definitions, and you can use them directly.

Service	Definition	Interactive page
Document Verification	document-verification.json	Swagger page
Liveness and biometrics	liveness.json	Swagger page
Face Match	face-match.json	Swagger page

What you can do with them

• Generate a client in your language with OpenAPI Generator or a similar tool, so that requests and responses are typed and checked.
• Import the API into your tools, such as Postman, Insomnia or Bruno, to try calls and keep examples.
• Try a call on the service’s own Swagger page, with your token.
• Check for changes by comparing a definition with the copy you used when you integrated.

Where they come from

The definitions are published by the services themselves, at the addresses in the table above, and describe each service as it is deployed. The copies here are the EU services’ definitions, fetched regularly and checked before publication; the US services expose the same API. The reference pages are built from these copies, so a change to a service reaches the reference after it has been reviewed, not silently.