Skip to content

API reference

The Gravv API is a REST API that uses standard HTTP methods and returns JSON responses. All requests go to the base URL:

https://api.gravv.xyz/v1/

Authentication

Gravv generates two key types for each environment:

  • Public Key for client-side use
  • Secret Key for server-side use

You can find both keys in your Gravv Dashboard.

Every request requires an Api-Key header, which is your Secret Key:

curl -X GET https://api.gravv.xyz/v1/accounts \
  -H "Api-Key: <your-api-key>" \
  -H "x-tenant-id: <your-tenant-id>"

Send all requests over HTTPS. Requests without a valid Api-Key return a 401 Unauthorized response. For more information on obtaining and rotating your keys, see Authentication.

Request headers

The request headers for the Gravv API are as follows:

Header Description
Api-Key Your API key for authentication.
x-tenant-id Your business identifier.
Idempotency-Key A unique key to prevent duplicate write requests.

Every POST operations requires an Idempotency-Key header to safely retry requests without creating duplicates.

Endpoints

The API reference contains the following endpoint groups:

  • Customers

    Create and manage customer details.

  • Know Your Customer (KYC)

    Verify customer identity and manage compliance checks.

  • Features

    Check eligibility for and activate product features for your customers.

  • Accounts

    Create and manage multi-currency accounts.

  • External accounts

    Add and manage external bank accounts and mobile money recipients for outbound transfers.

  • Transfers

    Send funds internally, externally, and internationally.

  • Transactions

    Retrieve transaction history and details across accounts.

  • Webhooks

    Receive real-time event notifications for payments, transfers, cards, and more.