Face match lookup

POST/v1/nin/face-match/lookup

Authorization

api-key

x-api-key<token>

In: header

Header Parameters

Idempotency-Key?string

Optional. Unique key identifying this request attempt for idempotency.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

nin*string

National Identification Number (NIN)

Length11 <= length <= 11

enterpriseId*string

Enterprise ID for the request

requestReason*string

Reason for the request

livelinessImages*array<>

Array of liveliness images for face matching

Items1 <= items <= 10

selfieImage*

Selfie image for face matching

provisionalId?string

Provisional ID for tracking

provisionalIdName?string

Provisional ID name/description

Response Body

`application/json`

curl -X POST "https://example.com/v1/nin/face-match/lookup" \  -H "Content-Type: application/json" \  -d '{    "nin": "11111111111",    "enterpriseId": "ENT4SANDBOX",    "requestReason": "creditBackgroundCheck",    "livelinessImages": [      {        "image": "data:image/jpeg;base64,BASE64_STRING_HERE"      }    ],    "selfieImage": {      "image": "--imagebase64--"    }  }'

{  "success": true,  "statusCode": 200,  "message": "Request processed successfully",  "timestamp": "2025-10-20T16:30:00.000Z",  "path": "/v1/auth/register",  "data": {    "data": {},    "status": 0,    "verificationId": {},    "charged": 0  }}