I

iproov.com

2 integrations · REST

iProov exposes two HTTP integration surfaces—a regional REST API authenticated either by service-provider `api_key`+`secret` in the request body or OAuth-based Basic/Bearer credentials from iPortal, and an OIDC Web surface at `api.eu.iproov.id/oidc/v1` authenticated with registered OIDC client credentials via client secret, private_key_jwt, or mTLS/public-client PKCE modes.

discovered 2mo ago
REST · OpenAPI2
Credentials
Service Provider API key and secretcompoundGet 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 issuancebasicGet 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 tokenbearerGet 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.

OIDC Web client registrationappGet key

Sign in to iPortal and go to the OIDC Web application registration flow described in Registering Your Application. Create an application, choose a token endpoint authentication method, and iPortal provisions your client_id and any associated secret or key-based configuration. This client registration is then used for OIDC Web login flows and the hosted-profile user-management API.

conventions · 1/7 published

Publish these signals → /publishing