latestOpenAPI 3.0.12026-08-105551287.6 KB

c481fa2414f9

Identification sessions

Get an identification session

Returns a specific identification session for the person specified in the request URL.

get/v1/persons/{person_id}/identification_sessions/{identification_session_id}

Path parameters

person_idstring required

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

Example:dc1a6812a14f6cc338cd084208535bcdcper
identification_session_idstring required

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"
}