REST API reference

The REST API reference is located on iPortal: https://secure.iproov.me/docs.html

REST API glossary

Last updated: August 28, 2024

activate

[boolean]

Default: true

Actives the user account. If false, the user state will be SUSPENDED.

See: Management API services

api_key The API key obtained from your service provider in iPortal.
assurance_type

The assurance type used in a claim.

[Enum: Default: "genuine_presence" or "liveness"]

client

[string]

Fingerprint or client identifier of the device making the request, for example, User Agent.

date_time

[string], datetime format - "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'"

(Optional) The date time to suspend the user.

Default: now

grant_type

[string]

OAuth2 grant type, the only allowed value is: “client_credentials”

image The image used for enrollment in a binary format.
name

[string]

The name displayed to the user when completing a GPA or LA transaction.

reason

[string]

The reason to be displayed if a claim is attempted with this invalidated token.

resource [string]

The resource being accessed, for example: a URL, Use Case, or client ID.

risk_profile

[string]

An optional pre-defined list.

See: Risk profiles

rotation

The rotation value of the image.

Default: 0 (the only supported value).

scope

[string array]

(Optional) Define the required scopes (omitting grants will provide all allowed scopes).

secret

The API Secret obtained from your service provider in iPortal.

source

[Enum: “eid”, “oid”, “selfie”]

The source of the enrollment image.

See: Image source options

token Obtained from the generated token.
user_id

[string]

A unique generated user_id in this format: [a-zA-Z0-9'\+_@\.-]{1,256}