Register

Account Creation - Face Biometric Authentication API

The Account Creation API enables clients to create wallets for their users by verifying their identities through facial biometrics using either BVN or NIN. The account creation journey differs slightly based on the account tier and the identity document used.

How does it work?

The Account Creation API allows clients request the creation of customized wallets. These wallets can only be managed and operated using the channel or application of choice by the requesting client.

  1. The client performs face biometric authentication using end users' BVN or NIN using the face biometric authentication web app.

  2. The client makes a request on behalf of the customer to generate an account.

  3. The client gets a PENDING status of while awaiting account generation.

  4. Client receives a notification of wallet details via a callback URL.

Prerequisites

A valid x-api-key assigned by the bank.

A face biometric authentication UI flow that integrates with the provided facial prompt URL.

A callback webhook URL configured to receive account details.

https://face-verification-dev.azurewebsites.net/?{identifierType}={identifierValue}&x_tk{x-api-key}

Go Live

Face Biometric Authentication Journey

Access the Face Biometric Authentication web app using the BaseURL above. A successful face biometric authentication by end user via the web app would return a correlationId to the client, with which to initiate account generation request.

The Face Biometric Authentication web app makes use of several key parameters to note:

  1. identifierType = Either BVN or NIN

  2. identifierValue = Value of either BVN or NIN.

  3. x_tk = Value of x-api-key assigned by the bank to client.

Additional/Optional Parameters

cb_uri = A callback URI to be passed by the client if details of correlationId is to be delivered to the client's server-side application.

For callback URL ->

{{BASE_URL }}/?nin={{ NIN }}&x_tk={{ x-api-key }}&cb_uri={{ CALLBACK_URL}}

Where callback url is provided, a POST request would be made to the callback with the payload.

POST - {value of callback URI passed by client}

  {
      "success": true,
      "c_id": {value of correlationID},
      "id": {value of BVN_OR_NIN used},
      "id_type": "bvn" //or "nin"
  }

rd_uri =A redirect URI to be passed by the client if details of correlationId is to be delivered by a return to the client's web application.

For redirect URL ->

{{ BASE_URL }}/?nin={{ NIN }}&x_tk={{ x-api-key }}&rd_uri={{ REDIRECT_URL }}

On success of face biometric authentication, redirect to

{{REDIRECT_URL }}/?success=true&&c_id=${{ CorrelationID_HERE }}&id=${{ value of BVN_OR_NIN }}&id_type=${{ "bvn" or "nin" }}

Note

Values ofcb_uriandrd_urishould maintain the format

https://{domain_name_of_client_web_application}

On success of face biometric authentication, if no redirect or callback URLs are provided redirect would occur at

{{ BASE_URL }}/?success=true&&c_id=${{ ID_HERE }}&id=${{ BVN_OR_NIN }}&id_type=${{ "bvn" or "nin" }}