v1

latestOpenAPI 3.0.02026-08-0442100147.0 KB
Verifications

Create Verification

Initiates a new identity verification session with the specified eID provider.

post/v1/verifications

Request body

providerIdstring required

The identifier for the desired eID provider.

redirectUristring uri

URL to redirect to after a redirect-based verification.

webhookUrlstring uri

URL to receive asynchronous status updates.

userDataobject

User information required by certain eID providers.

Example request

{
  "providerId": "bankidse",
  "userData": {
    "email": "user@example.com"
  }
}

Response

Verification session created successfully.

verificationIdstring
status'initiated' | 'pending'
providerIdstring
flowType'qr' | 'redirect' | 'push'
expiresAtstring date-time
createdAtstring date-time