Skip to main content
POST
https://sandbox.api.hopae.com/connect/v1
/
verifications
curl --request POST \
  --url 'https://sandbox.api.hopae.com/connect/v1/verifications' \
  --user '{clientId}:{clientSecret}' \
  --header 'Content-Type: application/json' \
  --data '{
    "providerId": "frejaid"
  }'

{
  "verificationId": "058ff1aa613a40a883d367a07d7b3713",
  "status": "initiated",
  "providerId": "frejaid",
  "flowType": "qr",
   "flowDetails": {
    "qrData": "qr-deep-link-url"
  },
  "expiresAt": "2025-08-06T12:00:00Z",
  "createdAt": "2025-08-06T11:00:00Z"
}
Initiates a new identity verification session with the specified eID provider.

​
Headers

Basic authentication: set Authorization.username to your Client ID (client_id) and Authorization.password to your Client Secret (client_secret). The interface builds the header automatically.
​
Authorization
string
required
Direct API format: Basic <base64(client_id:client_secret)>.

​
Request Body

​
providerId
string
default:"frejaid"
required
The identifier for the desired eID provider.
​
redirectUri
string
default:"http://localhost:3000/callback"
URL to redirect to after a redirect-based verification.
​
userData
object
User information required by certain eID providers. See details
{
  "registrationId": "PNOLT-40504040001"
}
Some eID providers require additional userData fields to launch a verification. See the provider userData requirements for the full matrix, including required, conditional, and optional attributes per provider.

​
Response

​
verificationId
string
The unique identifier for the verification session
​
status
string
Current status of the verification. Possible values: initiated, pending, authenticating, completed, failed, expired, cancelled
​
providerId
string
The identifier of the eID provider
​
flowType
string
Type of verification flow. Possible values: qr, redirect, push
​
flowDetails
object
​
expiresAt
string
ISO 8601 timestamp when the verification session expires
​
createdAt
string
ISO 8601 timestamp when the verification session was created
curl --request POST \
  --url 'https://sandbox.api.hopae.com/connect/v1/verifications' \
  --user '{clientId}:{clientSecret}' \
  --header 'Content-Type: application/json' \
  --data '{
    "providerId": "frejaid"
  }'

{
  "verificationId": "058ff1aa613a40a883d367a07d7b3713",
  "status": "initiated",
  "providerId": "frejaid",
  "flowType": "qr",
   "flowDetails": {
    "qrData": "qr-deep-link-url"
  },
  "expiresAt": "2025-08-06T12:00:00Z",
  "createdAt": "2025-08-06T11:00:00Z"
}