Gravv docs
Docs Agent Sign in Get API keys
API Reference

Get account capabilities

Lists the accounts a customer can open from their country: bank, currency, account types, token wallets, rails and the per-customer limit. Call it before you create an account. Send customer_id, or country with customer_type. If you send customer_id without customer_type, the response lists options for both types.

The route is under /v1, but it is the first step of a v2 account. The API rejects unknown query parameters.

GEThttps://api.gravv.xyz/v1/accounts/capabilities

Query Parameters

Customer to check. Their profile address gives the country when you do not send country.

Residence country as an ISO 3166-1 alpha-2 or alpha-3 code

Residence state, such as US-NY or NY

Customer type to list options for

Possible values: individual, business

Three-letter ISO 4217 code to filter by

Responses

Status Description
200 Account options
400 Invalid filter, unknown parameter, or no country to use
503 Gravv could not read the customer profile. Retry.
504 The request took more than 10 seconds. Retry.

200 response

The residence country Gravv used, as an alpha-2 code

The ISO 3166-2 subdivision Gravv used, or empty

The customer_type filter you sent

One entry per bank and currency

Display name of the bank

Bank code, such as lead_bank

Omitted when you filtered by customer_type

Possible values: individual, business

Account types you can send as account_type

Possible values: operating, yield, revenue

Possible values: main, sub_account, virtual, multi_currency

Features that accounts of this option support

Wallets that Gravv opens with the account

The maximum number of accounts one customer can open. Null means no limit.

True when the customer must first be registered with the bank

Rails for moving money in and out of the account

Possible values: low, medium, high

Residence countries this bank does not serve

Residence subdivisions this bank does not serve

Present when you did not send customer_id

 
{
"data": {
"country": "US",
"subdivision": "US-CA",
"customer_type": "individual",
"options": [
  {
    "bank_name": "Example Bank",
    "bank_code": "lead_bank",
    "currency": "USD",
    "account_types": [
      "operating"
    ],
    "categories": [
      "main",
      "sub_account"
    ],
    "features": {
      "collections": true,
      "fx_conversion": true,
      "internal_transfers": true,
      "balance_lookup": true,
      "negative_balance": false,
      "fbo_account": false
    },
    "token_wallets": [
      {
        "network": "polygon",
        "asset": "USDC"
      }
    ],
    "max_accounts_per_customer": null,
    "requires_customer_record": true,
    "rails": [
      {
        "rail": "ach",
        "title": "ACH",
        "description": "US bank transfer",
        "currency": "USD",
        "settlement_time": "1-3 business days",
        "cost": "low"
      }
    ],
    "excluded_countries": [
      "CU",
      "IR",
      "KP",
      "SY"
    ],
    "excluded_subdivisions": []
  }
]
},
"error": null
}

400 response

{
"data": null,
"error": "a customer country is required: supply country (ISO-3166 alpha-2) or a customer_id whose profile has an address"
}

Authorization

  • ApiKeyAuth
Was this page helpful?
ESC