Get Verification UserInfo

curl --request GET \
  --url 'https://api.hopae.com/connect/v2/verifications/{verificationId}/userinfo?provenance=true&missing_claims=true' \
  --user '{appId}:{appSecret}'

{
  "user": {
    "given_name": "OK",
    "family_name": "TESTNUMBER",
    "name": "OK TESTNUMBER",
    "birthdate": "1905-04-04",
    "nationality": "LT",
    "source_id": "PNOLT-40504040001"
  },
  "missing_claims": [
    "email"
  ],
  "acr": "urn:hopae:loa:4",
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "verification_model": "disclosure",
  "provenance": {
    "presentation": {
      "credentials": [
        {
          "claims": {
            "documentNumber": "PNOLT-40504040001-MOCK-Q",
            "birthdate": "1905-04-04",
            "countryCode": "LT",
            "givenName": "OK",
            "surname": "TESTNUMBER"
          },
          "evidence": {
            "token": {
              "id_token": "<BASE64_ID_TOKEN>",
              "expires_at": "2026-09-03T10:19:52.000Z",
              "access_token": "<OPAQUE_ACCESS_TOKEN>",
              "token_type": "Bearer"
            },
            "names": "id_token;expires_at;access_token;token_type"
          }
        }
      ]
    },
    "_metadata": {
      "verification_id": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8",
      "verified_at": "2026-09-03T09:19:52.110Z",
      "status": "completed",
      "provider_id": "smart-id",
      "connection_id": "smart-id",
      "credential_id": "smart-id",
      "connection_instance_id": "conn_01J8XK2P4M9QR3TV"
    }
  },
  "sub": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8"
}

{
  "user": {
    "name": "Manuela Elisa da Mota",
    "cpf": "12345678900"
  },
  "missing_claims": [],
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "verification_model": "match",
  "match": {
    "matched": false,
    "granularity": "per_field",
    "submitted_fields": [
      "name",
      "birthdate",
      "cpf"
    ],
    "details": {
      "name": {
        "matched": true,
        "submitted_value": "Manuela Elisa da Mota",
        "similarity": 100
      },
      "birthdate": {
        "matched": false,
        "submitted_value": "1975-06-05"
      },
      "cpf": {
        "matched": true,
        "submitted_value": "12345678900"
      }
    }
  },
  "provenance": {
    "presentation": {
      "credentials": [
        {
          "claims": {
            "rfb_existe": true,
            "cnh_existe": true,
            "qrcode": {
              "nome": true,
              "data_nascimento": false
            }
          },
          "evidence": {
            "token": {
              "integrator_jws": "eyJhbGciOiJSUzI1NiIsInR5cCI6...",
              "token_type": "integrator"
            },
            "names": "integrator_jws;token_type"
          }
        }
      ]
    },
    "_metadata": {
      "verification_id": "019bc4f7-2b44-7f1a-9c3d-8e5b0a6f2c77",
      "verified_at": "2026-09-03T10:02:19.551Z",
      "status": "completed",
      "provider_id": "br-cpf",
      "connection_id": "br-cpf-cnh-match",
      "credential_id": "br-cnh-match",
      "connection_instance_id": "conn_01J8XK7T1B5NM0WD"
    }
  },
  "sub": "019bc4f7-2b44-7f1a-9c3d-8e5b0a6f2c77"
}

{
  "user": {
    "given_name": "OK",
    "family_name": "TESTNUMBER",
    "name": "OK TESTNUMBER",
    "birthdate": "1905-04-04",
    "nationality": "LT",
    "source_id": "PNOLT-40504040001"
  },
  "acr": "urn:hopae:loa:4",
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "verification_model": "disclosure",
  "sub": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8"
}

GET

verifications

{verificationId}

userinfo

curl --request GET \
  --url 'https://api.hopae.com/connect/v2/verifications/{verificationId}/userinfo?provenance=true&missing_claims=true' \
  --user '{appId}:{appSecret}'

{
  "user": {
    "given_name": "OK",
    "family_name": "TESTNUMBER",
    "name": "OK TESTNUMBER",
    "birthdate": "1905-04-04",
    "nationality": "LT",
    "source_id": "PNOLT-40504040001"
  },
  "missing_claims": [
    "email"
  ],
  "acr": "urn:hopae:loa:4",
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "verification_model": "disclosure",
  "provenance": {
    "presentation": {
      "credentials": [
        {
          "claims": {
            "documentNumber": "PNOLT-40504040001-MOCK-Q",
            "birthdate": "1905-04-04",
            "countryCode": "LT",
            "givenName": "OK",
            "surname": "TESTNUMBER"
          },
          "evidence": {
            "token": {
              "id_token": "<BASE64_ID_TOKEN>",
              "expires_at": "2026-09-03T10:19:52.000Z",
              "access_token": "<OPAQUE_ACCESS_TOKEN>",
              "token_type": "Bearer"
            },
            "names": "id_token;expires_at;access_token;token_type"
          }
        }
      ]
    },
    "_metadata": {
      "verification_id": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8",
      "verified_at": "2026-09-03T09:19:52.110Z",
      "status": "completed",
      "provider_id": "smart-id",
      "connection_id": "smart-id",
      "credential_id": "smart-id",
      "connection_instance_id": "conn_01J8XK2P4M9QR3TV"
    }
  },
  "sub": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8"
}

{
  "user": {
    "name": "Manuela Elisa da Mota",
    "cpf": "12345678900"
  },
  "missing_claims": [],
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "verification_model": "match",
  "match": {
    "matched": false,
    "granularity": "per_field",
    "submitted_fields": [
      "name",
      "birthdate",
      "cpf"
    ],
    "details": {
      "name": {
        "matched": true,
        "submitted_value": "Manuela Elisa da Mota",
        "similarity": 100
      },
      "birthdate": {
        "matched": false,
        "submitted_value": "1975-06-05"
      },
      "cpf": {
        "matched": true,
        "submitted_value": "12345678900"
      }
    }
  },
  "provenance": {
    "presentation": {
      "credentials": [
        {
          "claims": {
            "rfb_existe": true,
            "cnh_existe": true,
            "qrcode": {
              "nome": true,
              "data_nascimento": false
            }
          },
          "evidence": {
            "token": {
              "integrator_jws": "eyJhbGciOiJSUzI1NiIsInR5cCI6...",
              "token_type": "integrator"
            },
            "names": "integrator_jws;token_type"
          }
        }
      ]
    },
    "_metadata": {
      "verification_id": "019bc4f7-2b44-7f1a-9c3d-8e5b0a6f2c77",
      "verified_at": "2026-09-03T10:02:19.551Z",
      "status": "completed",
      "provider_id": "br-cpf",
      "connection_id": "br-cpf-cnh-match",
      "credential_id": "br-cnh-match",
      "connection_instance_id": "conn_01J8XK7T1B5NM0WD"
    }
  },
  "sub": "019bc4f7-2b44-7f1a-9c3d-8e5b0a6f2c77"
}

{
  "user": {
    "given_name": "OK",
    "family_name": "TESTNUMBER",
    "name": "OK TESTNUMBER",
    "birthdate": "1905-04-04",
    "nationality": "LT",
    "source_id": "PNOLT-40504040001"
  },
  "acr": "urn:hopae:loa:4",
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "verification_model": "disclosure",
  "sub": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8"
}

Returns the verified user data and, for match connections, the match outcome. The audit trail (provenance) and missing_claims are returned only when you request them with the query parameters below. Available when the session is completed, or when it failed with error.code: "loa_insufficient" (the lax assurance result).

Headers

string

required

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

Path Parameters

string

required

The session id.

Query Parameters

boolean

default:"false"

true (or 1) adds the provenance block, including the connection identity under provenance._metadata. Omitted or any other value leaves it out.

boolean

default:"false"

true (or 1) adds the missing_claims list. Omitted or any other value leaves it out.

Response

Connection identity appears only under provenance._metadata, never as top-level userinfo fields, so request provenance=true to read it. The IDs are snapshotted when the session is created.

string

required

Subject identifier. In Hopae Connect this is the verificationId. A verification is a one-time event, not an account. Use user.source_id to recognise a returning person.

number

Numeric Level of Assurance, 1 to 5.

string

Human-readable assurance label (e.g. substantial).

string

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

string

With provenance=true. The provider of the connection that ran, as a catalog provider id (e.g. smart-id, google-wallet).

string

The catalog connection id (e.g. google-wallet-us-mdl). Human-readable but opaque: read provider_id and credential_id instead of parsing it.

string

The credential that was verified (e.g. us-mdl).

string

With provenance=true. The activated connection instance the session ran on (conn_…), the instance resolved at creation.

string

required

disclosure (attributes under user) or match (comparison under match, with user echoing the verified subset of what you submitted). See Verification Model.

string[]

Returned only with missing_claims=true. Requested claims the source could not provide. Includes source_id when it was requested but could not be derived for this person. [] when nothing is missing.

object | null

The verified attributes, limited to the claims the workflow requested. For match connections it contains the verified subset of the values you submitted in userInput. Per-field providers: only fields with matched: true. Aggregate providers: every submitted field when the aggregate outcome is true, otherwise empty.

Show Common fields

string

Full name

string

Given name

string

Family name

string

Middle name(s)

string

YYYY-MM-DD

string

Gender value

string

ISO 3166-1 alpha-2

string

Email address

boolean

Whether the email is verified

string

E.164 phone number

boolean

Whether the phone number is verified

object | string

Structured address

string

Base64-encoded portrait

string

BCP 47 locale

string

Stable identifier for the same person on this connection. Present only when source_id is selected in the workflow’s data request and the connection can derive it.

See Normalized User Data for the full catalog. Provider-specific claims may also appear.

object

Present only when verification_model is match.

Show Match fields

boolean

Aggregate outcome, true only when every submitted field matched.

string

per_field or aggregate.

string[]

The userInput keys that were compared.

object

Per-field outcomes keyed by field name (per_field only): matched, submitted_value, and optionally similarity (0 to 100).

object

Returned only with provenance=true. What the source returned, as handed over by the provider. See Return Data Model.

Show Presentation

array

One entry per upstream credential presented for this verification.

object

The provider’s raw response for this credential, in the provider’s own field names. Returned for every verification model, match included.

object

Signed proof material relayed from the source, when the provider issues it. See Evidence & Data Integrity.

Show Metadata

string

The session id.

string

ISO 8601 completion time.

string

Session status at read time.

object

Present when the session ended with loa_insufficient.

Catalog identity is carried by provenance._metadata.provider_id, connection_id, credential_id, and connection_instance_id. It is never repeated at the top level of userinfo.

object

Present only for the one non-completed state this endpoint serves: a session that failed with code: "loa_insufficient" (the provider returned a lower LoA than the workflow asked for). The data is still returned so you can decide how to handle it.

Workflow decision nodes (check-min-loa, check-claim, evaluate) add their outputs to this response, for example metLoa, hasClaim, or computed.<field>. See Workflow Nodes.

curl --request GET \
  --url 'https://api.hopae.com/connect/v2/verifications/{verificationId}/userinfo?provenance=true&missing_claims=true' \
  --user '{appId}:{appSecret}'

{
  "user": {
    "given_name": "OK",
    "family_name": "TESTNUMBER",
    "name": "OK TESTNUMBER",
    "birthdate": "1905-04-04",
    "nationality": "LT",
    "source_id": "PNOLT-40504040001"
  },
  "missing_claims": [
    "email"
  ],
  "acr": "urn:hopae:loa:4",
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "verification_model": "disclosure",
  "provenance": {
    "presentation": {
      "credentials": [
        {
          "claims": {
            "documentNumber": "PNOLT-40504040001-MOCK-Q",
            "birthdate": "1905-04-04",
            "countryCode": "LT",
            "givenName": "OK",
            "surname": "TESTNUMBER"
          },
          "evidence": {
            "token": {
              "id_token": "<BASE64_ID_TOKEN>",
              "expires_at": "2026-09-03T10:19:52.000Z",
              "access_token": "<OPAQUE_ACCESS_TOKEN>",
              "token_type": "Bearer"
            },
            "names": "id_token;expires_at;access_token;token_type"
          }
        }
      ]
    },
    "_metadata": {
      "verification_id": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8",
      "verified_at": "2026-09-03T09:19:52.110Z",
      "status": "completed",
      "provider_id": "smart-id",
      "connection_id": "smart-id",
      "credential_id": "smart-id",
      "connection_instance_id": "conn_01J8XK2P4M9QR3TV"
    }
  },
  "sub": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8"
}

{
  "user": {
    "name": "Manuela Elisa da Mota",
    "cpf": "12345678900"
  },
  "missing_claims": [],
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "verification_model": "match",
  "match": {
    "matched": false,
    "granularity": "per_field",
    "submitted_fields": [
      "name",
      "birthdate",
      "cpf"
    ],
    "details": {
      "name": {
        "matched": true,
        "submitted_value": "Manuela Elisa da Mota",
        "similarity": 100
      },
      "birthdate": {
        "matched": false,
        "submitted_value": "1975-06-05"
      },
      "cpf": {
        "matched": true,
        "submitted_value": "12345678900"
      }
    }
  },
  "provenance": {
    "presentation": {
      "credentials": [
        {
          "claims": {
            "rfb_existe": true,
            "cnh_existe": true,
            "qrcode": {
              "nome": true,
              "data_nascimento": false
            }
          },
          "evidence": {
            "token": {
              "integrator_jws": "eyJhbGciOiJSUzI1NiIsInR5cCI6...",
              "token_type": "integrator"
            },
            "names": "integrator_jws;token_type"
          }
        }
      ]
    },
    "_metadata": {
      "verification_id": "019bc4f7-2b44-7f1a-9c3d-8e5b0a6f2c77",
      "verified_at": "2026-09-03T10:02:19.551Z",
      "status": "completed",
      "provider_id": "br-cpf",
      "connection_id": "br-cpf-cnh-match",
      "credential_id": "br-cnh-match",
      "connection_instance_id": "conn_01J8XK7T1B5NM0WD"
    }
  },
  "sub": "019bc4f7-2b44-7f1a-9c3d-8e5b0a6f2c77"
}

{
  "user": {
    "given_name": "OK",
    "family_name": "TESTNUMBER",
    "name": "OK TESTNUMBER",
    "birthdate": "1905-04-04",
    "nationality": "LT",
    "source_id": "PNOLT-40504040001"
  },
  "acr": "urn:hopae:loa:4",
  "hopae_loa": 4,
  "hopae_loa_label": "high",
  "verification_model": "disclosure",
  "sub": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8"
}

provenance.presentation.credentials[].claims is the provider’s own response in its native field names (for match providers, typically per-field confirmations). userInput, match.submitted_fields, and match.details use OIDC-normalized keys (e.g. name, birthdate), so the audit trail stays aligned with the source while your request and the outcome stay normalized.

Errors

HTTP	Code	When
404	`SESSION_VERIFICATION_NOT_FOUND`	Unknown id, a session of another app, or an environment mismatch
409	`SESSION_INVALID_STATUS_TRANSITION`	The session is not `completed` and is not a `failed` session with `error.code: "loa_insufficient"`
403	`AUTH_DATA_PROTECTED`	The session was started over OIDC with `private_mode`

Authorizations

Authorization

string

header

required

Basic base64(appId:appSecret). See Authentication.

Path Parameters

verificationId

string

required

The session id.

Query Parameters

provenance

boolean

default:false

true (or 1) adds the provenance block, including the connection identity under provenance._metadata. Off by default.

missing_claims

boolean

default:false

true (or 1) adds the missing_claims list. Off by default.

Response

Verified data.

user

object

Verified attributes, limited to the claims the workflow requested. source_id appears only when selected in the workflow and the source provided it. See Normalized User Data.

missing_claims

string[]

Returned only with missing_claims=true. Requested claims the source could not provide (may include source_id).

acr

string

Authentication Context Class Reference.

hopae_loa

number

Numeric Level of Assurance, 1 to 5.

hopae_loa_label

string

LoA label.

verification_model

enum<string>

disclosure or match.

Available options:

disclosure,

match

match

object

Match outcome: matched, granularity, submitted_fields, details. Match connections only.

error

object

Present when the achieved LoA was lower than requested (loa_insufficient).

provenance

object

Returned only with provenance=true. What the source returned, plus verification metadata. See Return Data Model.

Show child attributes

sub

string

The verification id. New for every verification, so it is not a stable user identifier. Use user.source_id to recognise a returning person. Always the last key.

Overview

OIDC

Verifications

Get Verification UserInfo

Headers

Path Parameters

Query Parameters

Response

Errors

Authorizations

Path Parameters

Query Parameters

Response

​Headers

​Path Parameters

​Query Parameters

​Response

​Errors

Authorizations

Path Parameters

Query Parameters

Response

Headers

Path Parameters

Query Parameters

Response

Errors