For the complete documentation index, see llms.txt. This page is also available as Markdown.

Banks List

Returns the complete list of Nigerian banks with their codes NIBSS/NIP for use in account verification.

Endpoint

GET /kyc/nga/banks

Authentication

Type
Location
Name

API Key

Header

x-api-key

Responses

200 Success

Response parameters

Parameter
Type
Description

serviceResultCode

integer

Code that indicates the overall result of the service execution. See Service Result Code

serviceTime

string

Processing time (milliseconds).

serviceResultLog

string

Descriptive field for the result of the service execution. Includes details when there is an error or exception in the module.

serviceTransactionId

string

Transaction identifier associated with the request processed by the API.

data

object

Object with the list of banks. See table below.

Response parameters — data

Parameter
Type
Description

banks

array

List of Nigerian banks. See table below.

totalBanks

integer

Total number of banks in the list.

Response parameters — data.banks[]

Parameter
Type
Description

bankCode

string

Bank code.

bankName

string

Bank name.

nipCode

string

Bank's NIP code.

Service Result Code

The serviceResultCode indicates the overall result of the service execution:

serviceResultCode
Description
HTTP code

200

The service execution was successful, the module processed the request correctly.

200

Response example

400 Bad Request

Error returned with the service envelope (serviceResultCode reflects the HTTP response code):

502 Bad Gateway

Returned when the service is temporarily unavailable or its response could not be interpreted. The body uses the service envelope with serviceResultCode: 500:

504 Gateway Timeout

Timeout error, returned with the service envelope:

Authentication errors (401/403) are rejected by the gateway before reaching the service and do not use the envelope serviceResultCode. Platform validation errors use the format application/problem+json. See Error handling for details on the three response forms.

Last updated