Skip to main content

Start a new KYC session

POST 
/sessions/start

Start a New KYC Session​

This endpoint starts a new KYC session by sending a request to the server, which returns a session ID that can be used to track the process.
Note that initiating the session will not deduct any credits unless the session is completed.

Request Body Details​

The request requires customer data, including information about the country and document type.
You can get the list of all valid countryIso and documentType combinations here.

For more detailed guidance on what data needs to be sent in the request, refer to the Customer Data Payload documentation.
This page provides a comprehensive overview of all the properties accepted by the API based on the specific country and document type combination.

Example Flow​

  1. Initiate Session: Send the customer data to the startSession endpoint.
  2. Response: The server returns a session ID, which is used to track and authenticate the KYC process.
  3. Credits: No credits are deducted upon initiating the session. Credits are deducted only when the session is completed.

Additional Information​

For more information on how to dynamically configure the customer data payload, including the required fields for specific countries and document types, refer to the following documentation:

Request​

Responses​