Sign in
latestOpenAPI 3.0.12026-08-105551287.6 KB

c481fa2414f9

Identification sessions

Create an identification session

-> "Creates an identification session for the person specified in the request URL based on the identification method(s) supplied in the request. Note that if the customer is not eligible for one of the identification methods, then this endpoint will return an error. Use the eligibility checking endpoint to verify this beforehand:" + GET /v1/persons/{person_id}/identification_eligibility_checks

post/v1/persons/{person_id}/identification_sessions

Path parameters

person_idstring required

The unique ID of the person resource created for a customer.

Example:dc1a6812a14f6cc338cd084208535bcdcper

Request body

callback_urlstring

The callback URL to call when the identification session is completed.

identification_methodsstring[]

Identification methods to use to identify the customer.

Example request

{
  "callback_url": "someurl.com",
  "identification_methods": [
    "idnow"
  ]
}

Response

Successful result of the operation

idstring

ID of the identification session.

urlstring

The URL of the identification session.

callback_urlstring

The callback URL of the identification session.

identification_methodsstring[]

The allowed identification methods for the session.

status'authorization_required' | 'confirmation_required' | 'confirmed' | 'created' | 'expired' | 'identification_data_required' | 'pending' | 'pending_successful' | 'rejected' | 'successful'

The current status of the identification session.

Example response

{
  "id": "acdede097f821bd8037465d691f69506ises",
  "url": "https://person-onboarding.solaris-staging.de/9AXlUH0ptsZoFef2n8LKiqpEAizdJTjVQ4tzZeu1LpvqbK201REXFG_EBwiGTw0PLlHWCaA7NLOOcUh1u_a7HUpp7wYMNlGnzALka-v_9MVOxOIfN73lFjFg7JMtBdJO",
  "callback_url": "https://www.callbackurl.com",
  "identification_methods": [
    "idnow"
  ],
  "status": "created"
}