Skip to main content

Start registration process and create static link

POST 
/v1/registrations

Preview: The API is in development or testing phases and the interface could still change slightly.

Starts a registration process with the provided form values. This endpoint:

  1. POST /v1/registrations → Starts processInstance → Returns JSON with redirectUrl
  2. FE redirects user to /identity/v1/auth?processInstanceId=[id]
  3. /v1/auth → Redirects user to Keycloak/BQID for enrollment
  4. User completes enrollment (scans QR, verifies identity)
  5. /v1/auth/callback → Sets process owner, collects tokens → Redirects to application
  6. Application receives user at /idm/l2/process/[processInstanceId]
    Scope: []

Request​

Responses​

Create registration and started successfully. Note that the API returns HTTP 200 even for validation errors, with the error information included in the response body.