Create KYC Session

This function is used to initiate a session. It is the very first step for KYC application.

post/biometrics/1/kyc/sessions

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header Authorization
- or API key in header Authorization
- or HTTP basic
- or OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token

Request body

scenarioNamestring required

Request a specific scenario within the application. To get possible values call Get Scenarios with the following query parameter: ?applicationTypes=kyc. Check scenario descriptions in the response to find the scenario you need, and copy its name.

partnerReferencestring

Your (usually unique) identifier of the end user performing the scenario. Will be sent together with the rest of the information via the webhook.

successUrlstring

End user will be sent to this URL after the selected scenario has been successfully completed.

cancelUrlstring

End user will be sent to this URL if they cancel the scenario.

retainDataboolean

Indicates whether Infobip should store and retain data. This value overrides value in account configuration.

Example request

{
  "scenarioName": "KYC_PASSPORT_HRV",
  "locationInfo": {
    "country": "HRV",
    "language": "en-US"
  },
  "partnerReference": "MyRef-jqhof",
  "webhook": {
    "url": "https://example.com/webhook",
    "type": "ON_END"
  },
  "successUrl": "https://example.com/success",
  "cancelUrl": "https://example.com/cancel",
  "retainData": true
}

Response

sessionIdstring

Unique session identifier.

redirectUrlstring

URL with sessionId to be sent to the end user which would then directly apply the scenario.

Example response

{
  "sessionId": "efc373be-ab6d-4c63-b798-1f65b7b4b2b3",
  "redirectUrl": "https://example.com/web/?sessionId=efc373be-ab6d-4c63-b798-1f65b7b4b2b3"
}

Changes

No recorded changes to this operation across all 1 revision of this API.