Name Enquiry

The "Name Enquiry" endpoint allows customers to perform name inquiries on a customer's account. It facilitates retrieving recipient name information for verification before initiating a transfer.

POST /api/transfer/v1/NameEnquiry

You need to provide the necessary parameters, such as destinationAccountNumber,destinationInstitutionCode and other identifying information, to retrieve the name associated with the recipient account.

Headers

Name
Value

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique-reference}

Body

Name
Data Type (length)
Required
Description

destinationAccountNumber

string

The designated account number for which the name enquiry is performed

sourceAccountNumber

string

The sender's account number This field is required for transfer gateways like Interswitch, so you should always pass it.

destinationInstitutionCode

string

The institution code of the destination bank

amount

integer

The intended transfer amount in Kobo. This field is required for transfer gateways like Interswitch, so you should always pass it.

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request
curl --location -g '{{baseurl}}/api/transfer/v1/NameEnquiry' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "accountNumber": "string",
  "destinationInstitutionCode": "string"
}'
Respose: 200
{
  "destinationInstitutionCode": "string",
  "channelCode": "string",
  "accountNumber": "string",
  "accountName": "string",
  "transactionReference": "string",
  "bankVerificationNumber": "string",
  "address": "string",
  "kycLevel": "int",
  "responseCode": "string",
  "message": "string",
  "clientRef": "string",
  "sessionID": "string"
}

Last updated