Skip to main content
GET
Retrieves the current status of a verification session. Poll this endpoint until result is set. When result.code is RECEIVED, call Get Verification UserInfo to read the data.

Headers

string
required
Basic <base64(appId:appSecret)>. See Authentication.

Path Parameters

string
required
The session id returned by Create Verification.

Response

string
The session id.
string
awaiting_user_action or authenticating while in progress, then completed or failed. completed means the provider answered, and failed means the verification ended before that. processing is reserved and not currently returned. You do not receive expired: an unfinished verification is deleted at expiresAt, and this endpoint then returns 404. See Expiry.
object
null while in progress. Set when status is completed or failed.
string
The catalog provider id (for example smart-id, freja, google-wallet), the same value Create Verification returned.
string
The workflow that governed the session: the one you passed, or the app’s default.
string
qr, redirect, push, dc, or query. A query session is already terminal at creation. Reading it again returns the stored result.
object
The flow details returned at creation. They stay on the response after the session ends. A connection that rotates its QR code (for example diia) sends the current code in flowDetails.action.qrData. The same action object is also returned at the top level.
string
ISO 8601 creation time.
string
ISO 8601 expiry time, 30 minutes after creation. If the verification has not finished by then, it has expired and is deleted.
string
ISO 8601 time the verification reached its final status.
string
deprecated
Deprecated. Use endedAt.
string
deprecated
Deprecated. Use endedAt.
object
deprecated
Use result. Present on some failed verifications, with code, message, and optionally details. A negative answer from the provider ends as completed and has no error.
string
Authentication Context Class Reference (urn:hopae:loa:{level}). Present when the connection determined the level for this verification.
number
The Hopae Level of Assurance (HLoA), 1 to 4.
string
The level’s label: none (1, Unverified), low (2), substantial (3), or high (4).
string
The activated connection instance the session runs on (conn_…).
string
The catalog connection id, for example google-wallet-us-mdl.
string
The credential being verified, for example us-mdl.
string
disclosure or match.
Non-terminal responses carry a polling hint: intervalMs is how long to wait between polls (per connection — some providers reject faster status reads), maxDurationMs is the session window.

Errors

Authorizations

Authorization
string
header
required

Basic base64(appId:appSecret). See Authentication.

Path Parameters

verificationId
string
required

The session id.

Response

Status.

verificationId
string

The session id.

status
enum<string>

Current status. processing is reserved and not currently returned.

Available options:
awaiting_user_action,
authenticating,
processing,
completed,
failed
providerId
string

Catalog provider id, for example smart-id. The same value Create Verification returned.

workflowId
string

The workflow that ran.

flowType
enum<string>

The flow.

Available options:
qr,
redirect,
push,
dc,
query
flowDetails
object

The flow details returned at creation. They stay after the session ends. A rotating QR code (for example diia) arrives in flowDetails.action.qrData. The same action object is also returned at the top level.

createdAt
string

ISO 8601.

expiresAt
string

ISO 8601.

result
object | null

null while in progress. Set when the status is completed or failed.

error
object
deprecated

Deprecated, use result. Present on some failed verifications: code, message, and optionally details.

endedAt
string

ISO 8601 time the verification reached its final status.

verifiedAt
string
deprecated

Deprecated. Use endedAt.

cancelledAt
string
deprecated

Deprecated. Use endedAt.

acr
string

Authentication Context Class Reference (urn:hopae:loa:{level}). Present when the connection determined the level for this verification.

hopae_loa
number

The Hopae Level of Assurance (HLoA), 1 to 4.

hopae_loa_label
string

The level's label: none (1, Unverified), low (2), substantial (3), or high (4).

connectionInstanceId
string

The activated connection instance the session runs on (conn_…).

connectionId
string

Catalog connection id.

credentialId
string

Catalog credential id.

verificationModel
enum<string>

disclosure or match.

Available options:
disclosure,
match
polling
object

Present while the session is not terminal. Wait intervalMs between polls. It is set per connection, because some providers reject faster status reads. maxDurationMs is the session window.