GET /accounts/me/balance

Returns the outstanding and overdue balance for the authenticated account.

URL: GET https://api.geocerta.io/accounts/me/balance

Sandbox URL: GET https://api-staging.geocerta.io/accounts/me/balance

Authentication required. Include your API key in the api-key header. See Authentication.

Response

200 OK — returns the account balance.

Response fields

Field Type Description
name string Account name
email string Account email
outstanding number Total amount outstanding (GBP)
overdue number Amount past due date (GBP)

Errors

Status Message Cause
401 Unauthorized Missing or invalid API key
404 No account associated with the API key API key is not linked to an account

Example

curl "https://api.geocerta.io/accounts/me/balance" \
  -H "api-key: YOUR_API_KEY"