Skip to main content
POST
/
v1
/
banks
/
resolve
Resolve Account
curl --request POST \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/banks/resolve \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>' \
  --data '
{
  "number": "Provide account number",
  "code": "Provide bank code"
}
'
{
  "status": "success",
  "message": "resolve was successfully",
  "data": {
    "accountName": "DEMO CARBON BUSINESS",
    "accountNumber": "6009490194",
    "bank": {
      "code": "565",
      "name": "Carbon Microfinance Bank"
    },
    "uptime": 100
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcarbon.co/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This endpoint resolves account details by using the bank code and account number.

​
Endpoint

POST /v1/banks/resolve

​
Headers

x-carbon-key: <your_api_key>

​
Request Body

{
  "number": "1234567890",
  "code": "058"
}

​
Response

{
  "status": "success",
  "message": "resolve was successfully",
  "data": {
    "accountName": "John Doe",
    "accountNumber": "1234567890",
    "bank": {
      "code": "058",
      "name": "Guarantee Trust Bank"
    },
    "uptime": 100
  }
}

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Body

application/json

Provide the required values for the request body.

​
number
string
required

Provide 10 digit account number e.g 6009490194

​
code
string
required

Provide bank code e.g 565

Response

200 - application/json

OK

The response is of type object.