Name Inquiry

This API validates a destination account before processing a transfer. It retrieves the account holder's name and relevant details based on the provided account number and institution code, ensuring accuracy before initiating the transaction.

Request Body

The request should be a JSON object containing the following fields:

Field Name	Type	Required	Description
sourceAccountNUBAN	string	FALSE	The NUBAN (bank account number) of the sender initiating the request.
destinationInstitutionCode	string	TRUE	The institution code of the recipient’s bank.
destinationAccountNUBAN	string	TRUE	The NUBAN (bank account number) of the recipient’s account.

Response Body

The response is a JSON object containing details of the recipient account.

Field Name	Type	Description
sessionID	string	Unique identifier for the request session.
transactionId	string	Unique transaction ID assigned to the name inquiry request.
destinationInstitutionCode	string	Institution code of the recipient’s bank.
destinationAccountNUBAN	string	The recipient’s NUBAN (bank account number).
destinationAccountName	string	The full name of the recipient account holder.
destinationAccountBankVerificationNumber	string	The BVN (Bank Verification Number) of the recipient.
destinationBankName	string	The official name of the recipient’s bank.
nameInquiryReference	string	Reference number for tracking the name inquiry transaction.

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

{
  "sourceAccountNUBAN": "0000000127",
  "destinationInstitutionCode": "000001",
  "destinationAccountNUBAN": "0000000001"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "sessionID": "292329jh235123991",
  "transactionId": "290j2jd5655512301",
  "destinationInstitutionCode": "000001",
  "destinationAccountNUBAN": "0000000001",
  "destinationAccountName": "Sample Customer 17",
  "destinationAccountBankVerificationNumber": "19192012",
  "destinationBankName": "STERLING BANK PLC",
  "nameInquiryReference": "290j2jd5655512301"
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🔴500| Source | Error | When |

Request Body#

Response Body#

Request

Request Code Samples

Responses

Request Body

Response Body