API endpoints

Last updated: October 28, 2024

The complete iProov Open API endpoint reference is on iPortal: https://secure.iproov.me/docs.html#section/Introduction

For API credentials, you need a valid user account where you can set up your service provider in iPortal.

The endpoints are described below.

Important

All request body elements are mandatory unless otherwise specified.

POST /claim/enrol/token

Element	Description
`user_id`	Mandatory
`resource`	Enter a meaningful description, for example: User onboarding Partners: use this value to distinguish traffic between your customers, for example: `customer_id + journey info “resource” : “xxxx-xxxcio-xxoic-onboarding”`
`token`	Capture enroll: use this parameter to initiate the iProov SDK.

This is a multipart/form-data request.

Element	Description
`image`	Format: `string <binary>` Image 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
`token`	The output token from this call: `POST claim/enrol/token`
`source`	Specify the correct image source type: Electronic ID: `eid` Optical ID: `oid` Selfie picture: `selfie`
`rotation`	The rotation of the image. Currently only the value '0' is supported (the image cannot be rotated).

You must call this endpoint to validate that an enrollment was successful.

To receive a frame in response, your service provider must be configured accordingly, contact the iProov Customer Success team.

Element	Description
`token`	The output token from this call: `POST claim/enrol/token call`

Element	Description
`user_id`	Mandatory
`token`	For photo enroll and verify, use this token to initiate the iProov SDK.

You must call this endpoint to validate that a verification was successful.

Element	Description
`api_key`	To receive a frame in response, specify the API key of the service provider.

Next step