Customers overview
Use the Customers API to create customer records, list customers, retrieve an individual customer, and update customer information.
Create a customer or browse the operations in this category.
Follow the end-to-end customer onboarding guide.
How it works
The customer is the root record that everything else in Gravv attaches to. KYC verification, accounts, wallets, cards and transfers all reference a customer_id. A typical onboarding sequence is:
- Create the customer with their personal or business details.
- Verify the customer through KYC.
- Open accounts, wallets or cards for the verified customer.
For step-by-step examples, see Customers and KYC recipes.
Endpoints
| Endpoint | Description |
|---|---|
POST /v1/customers |
Create a customer record |
GET /v1/customers |
List customers, newest first, filtered by status, type, kyc_status or keyword, with page and items_per_page. The API ignores the email, sort, from and to parameters today |
GET /v1/customers/{customer_id} |
Retrieve a single customer |
PUT /v1/customers/{customer_id} |
Update a customer. Only the non-empty fields you send change |
When you update a customer, the customer_id in the path selects the customer, and the API overwrites any customer_id in the body with it. Updates are partial. Only fields you send with a non-empty value change, so you can't clear a field by sending "". The response is a confirmation message, not the customer. Call Get a customer to read it back.
Authentication
All requests use https://api.gravv.xyz/v1/ and authenticate with the Api-Key header. See Authentication for details.