Get Verification Status

curl --request GET \
  --url 'https://api.hopae.com/connect/v2/verifications/{verificationId}' \
  --user '{appId}:{appSecret}'

{
  "verificationId": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8",
  "status": "completed",
  "providerId": "smart-id",
  "workflowId": "wf_01J8XJ4Q2R7TPX9K",
  "flowType": "push",
  "createdAt": "2026-09-03T09:18:31.774Z",
  "verifiedAt": "2026-09-03T09:19:52.110Z",
  "expiresAt": "2026-09-03T09:48:31.774Z",
  "acr": "urn:hopae:loa:4",
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "connectionInstanceId": "conn_01J8XK2P4M9QR3TV",
  "connectionId": "smart-id",
  "credentialId": "smart-id",
  "verificationModel": "disclosure"
}

{
  "verificationId": "019bc4f4-5e77-7a9c-b0d1-6c3a2f8e9b44",
  "status": "awaiting_user_action",
  "providerId": "freja",
  "workflowId": "wf_01J8XJ4Q2R7TPX9K",
  "flowType": "qr",
  "flowDetails": {
    "qrData": "<value to render as a QR code>"
  },
  "createdAt": "2026-09-03T09:12:44.301Z",
  "expiresAt": "2026-09-03T09:42:44.301Z",
  "polling": { "intervalMs": 2000, "maxDurationMs": 1800000 },
  "hopae_loa": 3,
  "hopae_loa_label": "substantial",
  "connectionInstanceId": "conn_01J8XN2C6QF9W1AZ",
  "connectionId": "freja-plus",
  "credentialId": "freja-plus",
  "verificationModel": "disclosure"
}

{
  "verificationId": "019bc4f4-5e77-7a9c-b0d1-6c3a2f8e9b44",
  "status": "failed",
  "providerId": "freja",
  "workflowId": "wf_01J8XJ4Q2R7TPX9K",
  "flowType": "qr",
  "error": {
    "code": "provider_error",
    "message": "The user cancelled the authentication",
    "details": { "provider_code": "<the provider's own code>", "provider_type": "provider_error" }
  },
  "createdAt": "2026-09-03T09:12:44.301Z",
  "failedAt": "2026-09-03T09:13:51.204Z",
  "expiresAt": "2026-09-03T09:42:44.301Z",
  "connectionInstanceId": "conn_01J8XN2C6QF9W1AZ",
  "connectionId": "freja-plus",
  "credentialId": "freja-plus",
  "verificationModel": "disclosure"
}

GET

verifications

{verificationId}

curl --request GET \
  --url 'https://api.hopae.com/connect/v2/verifications/{verificationId}' \
  --user '{appId}:{appSecret}'

{
  "verificationId": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8",
  "status": "completed",
  "providerId": "smart-id",
  "workflowId": "wf_01J8XJ4Q2R7TPX9K",
  "flowType": "push",
  "createdAt": "2026-09-03T09:18:31.774Z",
  "verifiedAt": "2026-09-03T09:19:52.110Z",
  "expiresAt": "2026-09-03T09:48:31.774Z",
  "acr": "urn:hopae:loa:4",
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "connectionInstanceId": "conn_01J8XK2P4M9QR3TV",
  "connectionId": "smart-id",
  "credentialId": "smart-id",
  "verificationModel": "disclosure"
}

{
  "verificationId": "019bc4f4-5e77-7a9c-b0d1-6c3a2f8e9b44",
  "status": "awaiting_user_action",
  "providerId": "freja",
  "workflowId": "wf_01J8XJ4Q2R7TPX9K",
  "flowType": "qr",
  "flowDetails": {
    "qrData": "<value to render as a QR code>"
  },
  "createdAt": "2026-09-03T09:12:44.301Z",
  "expiresAt": "2026-09-03T09:42:44.301Z",
  "polling": { "intervalMs": 2000, "maxDurationMs": 1800000 },
  "hopae_loa": 3,
  "hopae_loa_label": "substantial",
  "connectionInstanceId": "conn_01J8XN2C6QF9W1AZ",
  "connectionId": "freja-plus",
  "credentialId": "freja-plus",
  "verificationModel": "disclosure"
}

{
  "verificationId": "019bc4f4-5e77-7a9c-b0d1-6c3a2f8e9b44",
  "status": "failed",
  "providerId": "freja",
  "workflowId": "wf_01J8XJ4Q2R7TPX9K",
  "flowType": "qr",
  "error": {
    "code": "provider_error",
    "message": "The user cancelled the authentication",
    "details": { "provider_code": "<the provider's own code>", "provider_type": "provider_error" }
  },
  "createdAt": "2026-09-03T09:12:44.301Z",
  "failedAt": "2026-09-03T09:13:51.204Z",
  "expiresAt": "2026-09-03T09:42:44.301Z",
  "connectionInstanceId": "conn_01J8XN2C6QF9W1AZ",
  "connectionId": "freja-plus",
  "credentialId": "freja-plus",
  "verificationModel": "disclosure"
}

Retrieves the current status of a verification session. Poll this endpoint until the status is terminal, then call Get Verification UserInfo to read the result.

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, authenticating, completed, failed, or cancelled. 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.

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 same flow details returned at creation, while the session is still waiting for the user.

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 completion time. Present when status is completed.

string

Present when status is failed.

string

Present when status is cancelled.

object

Present when status is failed. Carries type, code (for example user_cancelled, loa_insufficient), message, and optionally providerError with the provider’s own code.

string

Authentication Context Class Reference, present when the provider asserted a LoA explicitly.

number

Numeric Level of Assurance, 1 to 5.

string

Human-readable LoA label (for example substantial).

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.

curl --request GET \
  --url 'https://api.hopae.com/connect/v2/verifications/{verificationId}' \
  --user '{appId}:{appSecret}'

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.

{
  "verificationId": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8",
  "status": "completed",
  "providerId": "smart-id",
  "workflowId": "wf_01J8XJ4Q2R7TPX9K",
  "flowType": "push",
  "createdAt": "2026-09-03T09:18:31.774Z",
  "verifiedAt": "2026-09-03T09:19:52.110Z",
  "expiresAt": "2026-09-03T09:48:31.774Z",
  "acr": "urn:hopae:loa:4",
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "connectionInstanceId": "conn_01J8XK2P4M9QR3TV",
  "connectionId": "smart-id",
  "credentialId": "smart-id",
  "verificationModel": "disclosure"
}

{
  "verificationId": "019bc4f4-5e77-7a9c-b0d1-6c3a2f8e9b44",
  "status": "awaiting_user_action",
  "providerId": "freja",
  "workflowId": "wf_01J8XJ4Q2R7TPX9K",
  "flowType": "qr",
  "flowDetails": {
    "qrData": "<value to render as a QR code>"
  },
  "createdAt": "2026-09-03T09:12:44.301Z",
  "expiresAt": "2026-09-03T09:42:44.301Z",
  "polling": { "intervalMs": 2000, "maxDurationMs": 1800000 },
  "hopae_loa": 3,
  "hopae_loa_label": "substantial",
  "connectionInstanceId": "conn_01J8XN2C6QF9W1AZ",
  "connectionId": "freja-plus",
  "credentialId": "freja-plus",
  "verificationModel": "disclosure"
}

{
  "verificationId": "019bc4f4-5e77-7a9c-b0d1-6c3a2f8e9b44",
  "status": "failed",
  "providerId": "freja",
  "workflowId": "wf_01J8XJ4Q2R7TPX9K",
  "flowType": "qr",
  "error": {
    "code": "provider_error",
    "message": "The user cancelled the authentication",
    "details": { "provider_code": "<the provider's own code>", "provider_type": "provider_error" }
  },
  "createdAt": "2026-09-03T09:12:44.301Z",
  "failedAt": "2026-09-03T09:13:51.204Z",
  "expiresAt": "2026-09-03T09:42:44.301Z",
  "connectionInstanceId": "conn_01J8XN2C6QF9W1AZ",
  "connectionId": "freja-plus",
  "credentialId": "freja-plus",
  "verificationModel": "disclosure"
}

Errors

HTTP	Code	When
404	`SESSION_VERIFICATION_NOT_FOUND`	Unknown id, a session of another app, an environment mismatch, or a verification past its `expiresAt`

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,

expired,

cancelled

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

Flow details while the session waits for the user.

createdAt

string

ISO 8601.

expiresAt

string

ISO 8601.

verifiedAt

string

ISO 8601. Present when completed.

failedAt

string

Present when failed.

cancelledAt

string

Present when cancelled.

error

object

Present when failed: type, code, message.

acr

string

Authentication Context Class Reference.

hopae_loa

number

Numeric Level of Assurance, 1 to 5.

hopae_loa_label

string

LoA label, for example substantial.

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.

Show child attributes

Overview

OIDC

Verifications

Get Verification Status

Headers

Path Parameters

Response

Errors

Authorizations

Path Parameters

Response

​Headers

​Path Parameters

​Response

​Errors

Authorizations

Path Parameters

Response

Headers

Path Parameters

Response

Errors