Skip to navigation
Identity verification APIConfiguration

Get configuration

Returns the ID types enabled for your organisation, the checks available for each, and your branding. Call it on start-up to decide which ID options to offer and which capture steps to run.

Error codes

errorStatusMeaning
Missing or invalid Authorization header401No bearer credential was sent.
Invalid API key401The key is unknown or revoked.
environment_mismatch403The key belongs to an environment this host does not serve.
origin_not_allowed403The request origin is not on the publishable key allowlist.
ip_not_allowed403The caller address is not on the secret key allowlist.
organization_suspended403The organisation is suspended.

Accepts a publishable (pk_) or secret (sk_) key.

Authentication

AuthorizationBearer
Send the API key as a Bearer token. Each operation states whether a publishable key is enough or a secret key is required.

Response

The configuration.
environmentenum
The environment of the API key.
Allowed values:
idTypeslist of objects
The ID types enabled for your organisation. Disabled ones are omitted.
brandingobject
Your organisation branding, as the SDK shows it.
geoCountrystring or null

A best guess at the caller country from their network address, as an ISO 3166 alpha-2 code. A default for forms, never evidence.

addressSearchboolean
Whether address search is available for the address step.
deviceAttestationobject
What a mobile SDK needs to attest the app it runs in.
addressSearchModeenumOptional
How address search behaves. Absent when address search is unavailable.
Allowed values:
mapsFrameUrlstringOptional
The address of the hosted map picker for this caller. Absent when no map picker is available.

Errors

401
Unauthorized Error
403
Forbidden Error