API glossary

activate

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

[boolean (default: true)]

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

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

[string]
date_time

(Optional) The date time to suspend the user.

Default: now

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

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

[string]
image The image used for enrollment in a binary format.
name

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

[string]
reason

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

[string]
resource

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

[string]
risk_profile

(Optional)

[string] (pre defined list)

See: Risk profiles

rotation

The rotation value of the image.

By default set to 0 (the only supported value).

scope

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

[string array]
secret

The API Secret obtained from your service provider in iPortal.

source

The source of the enrollment image, see: Image source options

[Enum: “eid”, “oid”, “selfie”]
token Obtained from the generated token.
user_id

A unique generated user_id in this format:

[a-zA-Z0-9'\+_@\.-]{1,256}

[string]