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

{
  "verificationId": "058ff1aa613a40a883d367a07d7b3713",
  "status": "initiated",
  "providerId": "bankidse",
  "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. Supports PKCE for enhanced security.

​
Headers

​
Authorization
string
default:"Basic NVNaZHUwZm46NVNaZHUwZm4="
required
Basic authentication header. Format: Basic <base64(clientId:clientSecret)>
For testing, use 5SZdu0fn for both clientId and clientSecret

​
Request Body

​
providerId
string
default:"bankidse"
required
The identifier for the desired eID provider.
​
redirectUri
string
URL to redirect to after a redirect-based verification.
​
userData
object
User information required by certain eID providers.
{
  "email": "user@example.com"
}

​
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.connect.hopae.com/api/v1/verifications' \
  --user '{clientId}:{clientSecret}' \
  --header 'Content-Type: application/json' \
  --data '{
    "providerId": "bankidse"
  }'

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