Create Face Liveness Session

POST

/core/kyc/liveness/session

Create Face Liveness Session

Starts a face liveness session for a client. The client must already have a verified BVN or NIN record. Use the returned sessionId and region in the liveness widget, then call POST /core/kyc/facecomparison.

POST /core/kyc/liveness/session

Request Body

Field Name	Type	Required	Description
clientId	Long	TRUE	Client to verify

Response

Field Name	Type	Description
sessionId	String	Liveness session id
region	String	Region to use with the liveness widget

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Body Params application/json

Example

{
  "clientId": 1
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/core/kyc/liveness/session' \
--header 'Content-Type: application/json' \
--data '{
  "clientId": 1
}'

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "sessionId": "a1b2c3d4-0000-1111-2222-333344445555",
  "region": "example-region"
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Modified at 2026-11-02 05:49:15

Get KYC Info

Get KYC Log Details

Create Face Liveness Session