API Reference
Accounts v2 overview
Use the Accounts v2 API to open a bank account for a customer at the bank you choose, read accounts with their balances and status reasons, and send the data or documents the bank asks for.
Create an account or browse the operations in this category.
Learn how accounts, wallets and KYC fit together.
How it works
- Call
GET /v1/accounts/capabilitiesto choose abank_code,currencyandaccount_type. The route is under/v1, but it is the first step of a v2 account. - Call
GET /v2/accounts/requirementsto see the fields and documents that bank needs. - Call
POST /v2/accounts. The customer must have completed KYC. The response has only theaccount_idandstatus: pending. - Follow the
applications.accounts.*webhooks, or readGET /v2/accounts/{id}untilstatusisactive. That read returns theapplication_id, which the create response does not. Whenrequires_user_actionis true, readstatus_reasonand answer it withPATCH /v2/accounts/applications/{application_id}. For an account you open with v2, Gravv sendsapplications.accounts.completed, neveraccount.activated.
For step-by-step examples, see Accounts (v2) recipes.
Endpoints
| Endpoint | Description |
|---|---|
GET /v1/accounts/capabilities |
List the account options a customer can open, with each option's bank_code |
POST /v2/accounts |
Open a bank account, with a token wallet where the bank offers one |
GET /v2/accounts |
List your accounts with bank details and balances |
GET /v2/accounts/requirements |
Get the fields and documents a bank needs for a currency and customer type |
GET /v2/accounts/applications |
List account applications |
GET /v2/accounts/applications/{application_id} |
Get one application and what it waits for |
PATCH /v2/accounts/applications/{application_id} |
Send the data or documents the bank asked for |
GET /v2/accounts/{id} |
Get one account with its balances and status reason |
POST /v2/accounts/simulate/deposit |
Make a test deposit land on an account, in sandbox only |
Authentication
All requests use https://api.gravv.xyz and authenticate with the Api-Key header. See Authentication for details.
Was this page helpful?