Balance Query API: Check Account Balance

Query your current account balance. Returns the total available credit balance associated with your API key.

Code example:

curl --location 'https://api.checknumber.ai/v1/balance' \
--header 'X-API-Key: API-KEY'

Response example for successful request

{
    "balance": 9850.50
}

Response example for unauthorized request

{
    "error": "unauthorized",
    "message": "Access key is required (X-API-Key or X-Access-Key)"
}

HTTP request

GET https://api.checknumber.ai/v1/balance

Request Headers

Header	Description
X-API-Key	string, Your API key (required). Also accepted as X-Access-Key

Response Fields

Field	Description	Example
balance	Total available balance for the API key (credits)	9850.50

Status Codes

Status	Description
200	Request successful, balance returned
401	Unauthorized, API key is missing or invalid
502	Balance query failed, upstream service error