API getting started guide
To help you develop your implementation, iProov provides a REST API Postman collection with examples for the endpoints described in this guide.
Get started with our Postman collection:
-
Download the .json file.
-
See the Postman Readme (below).
Postman Readme
OpenAPI specification
See the iProov OpenAPI Specification.
Collection variables
Before executing requests you must populate and persist the following collection variables. Secrets and user names can be obtained from your iPortal account.
| Variable | Description |
|---|---|
| tenant |
The iProov multi-tenant URL:
|
| base_url | Set to:/api/v2 |
| api_key | Your Service Provider API key. |
| secret | Your Service Provider secret. |
| oauth_password | Your Service Provideroauthpassword. |
| oauth_username | Your Service Provideroauthusername. |
Environment variables
Set these environment variables in the collection workflow:
| Environment variable | Description |
|---|---|
| token |
The iProov enroll or verify token. |
| user_id | A unique user ID (a UUID in this collection). You can provide your own. |
| access_token | A generated Oauthaccess_tokenfromPOST /access_token. |
Photo enroll requirements
As part of the photo enroll multipart form request you must provide an image that meets these requirements:
-
Supported media types: PNG, JPEG, and JP2
-
Max image size: 2 MB
-
The image should conform to: ISO/IEC 19794 Information technology — Biometric data interchange formats — Part 5 Face image data (supporting ICAO 9303 passports and ISO 18013 Driving Licences): https://www.iso.org/standard/38749.html
-
Minimum distance between the eyes: 85 pixels
Management API requirements
You must call the POST /access_token endpoint before any other management or user endpoint. After a response is received the access_token environment variable will be set.
API error codes
Download the list of error codes and descriptions: REST API Error Codes.xlsx
Next step
