iProov REST API

REST discovered

Details

URL: https://<base_url>/api/v2
Docs: https://eu.rp.secure.iproov.me/docs.html

Authentication

Service Provider API key and secret api_key=<credential> + Service Provider API key and secret api_key=<credential> discovered

Service Provider API key and secret compound Get key ↗

Sign in to iPortal and create or open a service provider. The implementation guide says API credentials are obtained when creating a service provider, and these credentials are used for the Service API. Use the service provider's api_key and secret values in request bodies for /claim/* endpoints.

OAuth username and password for Service API token issuance basic discovered Get credentials ↗

Sign in to iPortal and create or open a service provider. The API reference says the basicAuth credentials are obtained via iPortal as an OAuth username and OAuth password, and the implementation guide maps them to POST /{api_key}/access_token. Use them as HTTP Basic auth when exchanging for an OAuth bearer token.

Management API OAuth access token bearer discovered Get token ↗

First obtain OAuth username/password from iPortal for your service provider. Then call the documented token endpoint POST /{api_key}/access_token using HTTP Basic auth to obtain an OAuth 2 bearer token. Use that bearer token for the Management and User API endpoints.