Represents a set of services used for biometric authentication and identity proofing of the end user. — 5 operation path(s) and 4 webhook(s) in Infobip's published OpenAPI.
{
"openapi":"3.1.0",
"info":{
"title":"Infobip OpenAPI Specification",
"description":"OpenAPI Specification that contains all public endpoints and webhooks.",
"contact":{
"name":"Infobip support",
"email":"support@infobip.com"
},
"version":"3.210.0",
"x-generatedAt":"2026-07-23T15:24:02.70882158Z"
},
"tags":[
{
"name":"connectivity",
"description":"Powerful infrastructure and tools that connect you to the world.\n",
"x-type":"category",
"x-displayName":"Connectivity"
},
{
"name":"biometrics",
"description":"Represents a set of services used for biometric authentication and identity proofing of the end user.",
"x-type":"product",
"x-displayName":"Biometrics"
},
{
"name":"scenario",
"description":"",
"x-type":"section",
"x-displayName":"Scenario"
},
{
"name":"extraction-session",
"description":"",
"x-type":"section",
"x-displayName":"Extraction session"
},
{
"name":"kyc-session",
"description":"",
"x-type":"section",
"x-displayName":"KYC session"
},
{
"name":"enrollment-session",
"description":"",
"x-type":"section",
"x-displayName":"Enrollment session"
},
{
"name":"verification-session",
"description":"",
"x-type":"section",
"x-displayName":"Verification session"
}
],
"paths":{
"/biometrics/1/scenarios":{
"get":{
"tags":[
"connectivity",
"biometrics",
"scenario"
],
"summary":"Get Scenarios",
"description":"This function is used to retrieve all scenarios enabled for your account.",
"operationId":"get-biometrics-scenarios",
"parameters":[
{
"name":"applicationTypes",
"in":"query",
"description":"One or more application types to filter scenarios. If none is set, then scenarios for all application types are returned in the response. Example: `?applicationTypes=extraction,kyc`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string",
"description":"Application type identifier."
}
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.ScenarioResponse"
},
"examples":{
"OK":{
"summary":"OK",
"description":"OK",
"value":{
"scenarios":[
{
"name":"CODE_EXTRACTION_QR",
"description":"Scenario for default code extraction.",
"applicationType":"EXTRACTION"
},
{
"name":"PASSPORT_MRZ_STANDARD",
"description":"Scan MRZ and image from passport, extract MRZ data and ask for selfie to compare it with the scanned image.",
"applicationType":"KYC"
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Not found":{
"summary":"Not found",
"description":"Not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_UNKNOWN_APPLICATION",
"text":"Application cannot be found. Check application name in url parameter!"
}
}
}
}
}
}
}
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Too Many Requests":{
"summary":"Too Many Requests",
"description":"Too Many Requests",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"biometrics:manage"
]
}
},
"/biometrics/1/extraction/sessions":{
"get":{
"tags":[
"connectivity",
"biometrics",
"extraction-session"
],
"summary":"Get Extraction Session",
"description":"This function is used to retrieve a session by `sessionId` received in [Create Extraction Session](#platform-connectivity/biometrics/create-biometrics-extraction-session) response.",
"operationId":"get-biometrics-extraction-session",
"parameters":[
{
"name":"X-Session-Id",
"in":"header",
"description":"Session ID header.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"efc373be-ab6d-4c63-b798-1f65b7b4b2b3"
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GetSessionResponse"
},
"examples":{
"OK":{
"summary":"OK",
"description":"OK",
"value":{
"session":{
"scenarioName":"SOME_SCENARIO_NAME",
"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,
"status":"ACTIVE",
"id":"efc373be-ab6d-4c63-b798-1f65b7b4b2b3",
"applicationType":"KYC",
"createdAt":"2021-11-02T14:15:45.7058838Z",
"validUntil":"2021-11-02T14:25:45.7059354Z"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Not found":{
"summary":"Not found",
"description":"Not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_SESSION_NOT_FOUND",
"text":"Session not found. Check session ID!"
}
}
}
}
}
}
}
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Too Many Requests":{
"summary":"Too Many Requests",
"description":"Too Many Requests",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"biometrics:manage"
]
},
"post":{
"tags":[
"connectivity",
"biometrics",
"extraction-session"
],
"summary":"Create Extraction Session",
"description":"This function is used to initiate a session. It is the very first step for extraction application.",
"operationId":"create-biometrics-extraction-session",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.ExtractionSessionRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.CreatedSessionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"description":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_ACCOUNT_VALIDATION",
"text":"Account does not have scenario enabled."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Too Many Requests":{
"summary":"Too Many Requests",
"description":"Too Many Requests",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"biometrics:manage"
]
},
"delete":{
"tags":[
"connectivity",
"biometrics",
"extraction-session"
],
"summary":"Abort Extraction Session",
"description":"This function is used to abort the session. Use `sessionId` received in the [Create Extraction Session](#platform-connectivity/biometrics/create-biometrics-extraction-session) response.",
"operationId":"delete-biometrics-extraction-session",
"parameters":[
{
"name":"X-Session-Id",
"in":"header",
"description":"Session ID header.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"efc373be-ab6d-4c63-b798-1f65b7b4b2b3"
}
],
"responses":{
"204":{
"description":"Aborted successfully"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Not found":{
"summary":"Not found",
"description":"Not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_SESSION_NOT_FOUND",
"text":"Session not found. Check session ID!"
}
}
}
}
}
}
}
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Too Many Requests":{
"summary":"Too Many Requests",
"description":"Too Many Requests",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"biometrics:manage"
]
}
},
"/biometrics/1/kyc/sessions":{
"get":{
"tags":[
"connectivity",
"biometrics",
"kyc-session"
],
"summary":"Get KYC Session",
"description":"This function is used to retrieve a session by `sessionId` received in the [Create KYC Session](#platform-connectivity/biometrics/create-biometrics-kyc-session) response.",
"operationId":"get-biometrics-kyc-session",
"parameters":[
{
"name":"X-Session-Id",
"in":"header",
"description":"Session ID header.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"efc373be-ab6d-4c63-b798-1f65b7b4b2b3"
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GetSessionResponse"
},
"examples":{
"OK":{
"summary":"OK",
"description":"OK",
"value":{
"session":{
"scenarioName":"SOME_SCENARIO_NAME",
"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,
"status":"ACTIVE",
"id":"efc373be-ab6d-4c63-b798-1f65b7b4b2b3",
"applicationType":"KYC",
"createdAt":"2021-11-02T14:15:45.7058838Z",
"validUntil":"2021-11-02T14:25:45.7059354Z"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Not found":{
"summary":"Not found",
"description":"Not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_SESSION_NOT_FOUND",
"text":"Session not found. Check session ID!"
}
}
}
}
}
}
}
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Too Many Requests":{
"summary":"Too Many Requests",
"description":"Too Many Requests",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"biometrics:manage"
]
},
"post":{
"tags":[
"connectivity",
"biometrics",
"kyc-session"
],
"summary":"Create KYC Session",
"description":"This function is used to initiate a session. It is the very first step for KYC application.",
"operationId":"create-biometrics-kyc-session",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.KycSessionRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.CreatedSessionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"description":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_ACCOUNT_VALIDATION",
"text":"Account does not have scenario enabled."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Too Many Requests":{
"summary":"Too Many Requests",
"description":"Too Many Requests",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"biometrics:manage"
]
},
"delete":{
"tags":[
"connectivity",
"biometrics",
"kyc-session"
],
"summary":"Abort KYC Session",
"description":"This function is used to abort the session. Use `sessionId` received in the [Create KYC Session](#platform-connectivity/biometrics/create-biometrics-kyc-session) response.",
"operationId":"delete-biometrics-kyc-session",
"parameters":[
{
"name":"X-Session-Id",
"in":"header",
"description":"Session ID header.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"efc373be-ab6d-4c63-b798-1f65b7b4b2b3"
}
],
"responses":{
"204":{
"description":"Aborted successfully"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Not found":{
"summary":"Not found",
"description":"Not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_SESSION_NOT_FOUND",
"text":"Session not found. Check session ID!"
}
}
}
}
}
}
}
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Too Many Requests":{
"summary":"Too Many Requests",
"description":"Too Many Requests",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"biometrics:manage"
]
}
},
"/biometrics/1/enrollment/sessions":{
"get":{
"tags":[
"connectivity",
"biometrics",
"enrollment-session"
],
"summary":"Get Enrollment Session",
"description":"This function is used to retrieve a session by `sessionId` received in the [Create Enrollment Session](#platform-connectivity/biometrics/create-biometrics-enrollment-session) response.",
"operationId":"get-biometrics-enrollment-session",
"parameters":[
{
"name":"X-Session-Id",
"in":"header",
"description":"Session ID header.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"efc373be-ab6d-4c63-b798-1f65b7b4b2b3"
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GetSessionResponse"
},
"examples":{
"OK":{
"summary":"OK",
"description":"OK",
"value":{
"session":{
"scenarioName":"SOME_SCENARIO_NAME",
"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,
"status":"ACTIVE",
"id":"efc373be-ab6d-4c63-b798-1f65b7b4b2b3",
"applicationType":"KYC",
"createdAt":"2021-11-02T14:15:45.7058838Z",
"validUntil":"2021-11-02T14:25:45.7059354Z"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Not found":{
"summary":"Not found",
"description":"Not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_SESSION_NOT_FOUND",
"text":"Session not found. Check session ID!"
}
}
}
}
}
}
}
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Too Many Requests":{
"summary":"Too Many Requests",
"description":"Too Many Requests",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"biometrics:manage"
]
},
"post":{
"tags":[
"connectivity",
"biometrics",
"enrollment-session"
],
"summary":"Create Enrollment Session",
"description":"This function is used to initiate a session. It is the very first step for Enrollment application.",
"operationId":"create-biometrics-enrollment-session",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.EnrollmentSessionRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.CreatedSessionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"description":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_ACCOUNT_VALIDATION",
"text":"Account does not have scenario enabled."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Too Many Requests":{
"summary":"Too Many Requests",
"description":"Too Many Requests",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"biometrics:manage"
]
},
"delete":{
"tags":[
"connectivity",
"biometrics",
"enrollment-session"
],
"summary":"Abort Enrollment Session",
"description":"This function is used to abort the session. Use `sessionId` received in the [Create Enrollment Session](#platform-connectivity/biometrics/create-biometrics-enrollment-session) response.",
"operationId":"delete-biometrics-enrollment-session",
"parameters":[
{
"name":"X-Session-Id",
"in":"header",
"description":"Session ID header.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"efc373be-ab6d-4c63-b798-1f65b7b4b2b3"
}
],
"responses":{
"204":{
"description":"Aborted successfully"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Not found":{
"summary":"Not found",
"description":"Not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_SESSION_NOT_FOUND",
"text":"Session not found. Check session ID!"
}
}
}
}
}
}
}
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Too Many Requests":{
"summary":"Too Many Requests",
"description":"Too Many Requests",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"biometrics:manage"
]
}
},
"/biometrics/1/verification/sessions":{
"get":{
"tags":[
"connectivity",
"biometrics",
"verification-session"
],
"summary":"Get Verification Session",
"description":"This function is used to retrieve a session by `sessionId` received in the [Create Verification Session](#platform-connectivity/biometrics/create-biometrics-verification-session) response.",
"operationId":"get-biometrics-verification-session",
"parameters":[
{
"name":"X-Session-Id",
"in":"header",
"description":"Session ID header.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"efc373be-ab6d-4c63-b798-1f65b7b4b2b3"
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GetSessionResponse"
},
"examples":{
"OK":{
"summary":"OK",
"description":"OK",
"value":{
"session":{
"scenarioName":"SOME_SCENARIO_NAME",
"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,
"status":"ACTIVE",
"id":"efc373be-ab6d-4c63-b798-1f65b7b4b2b3",
"applicationType":"KYC",
"createdAt":"2021-11-02T14:15:45.7058838Z",
"validUntil":"2021-11-02T14:25:45.7059354Z"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Not found":{
"summary":"Not found",
"description":"Not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_SESSION_NOT_FOUND",
"text":"Session not found. Check session ID!"
}
}
}
}
}
}
}
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"examples":{
"Too Many Requests":{
"summary":"Too Many Requests",
"description":"Too Many Requests",
"value":{
"requestError":{
"serviceException":{
"messageId":"EC_TOO_MANY_REQUESTS",
"text":"Too many requests."
}
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/openapi/infobip-biometrics-openapi.json