Get external account requirements

Retrieve JSON Schema requirements for creating external accounts.

Returns country-specific requirements for bank accounts or blockchain-specific requirements for crypto addresses. The schemas include validation rules, field formats, and supported currencies/rails for dynamic form generation.

GET /external-accounts/requirements

Get external account requirements

cURL

curl --request GET \
  --url https://app.gnosisramp.com/api/v1/external-accounts/requirements \
  --header 'Authorization: Bearer <token>'

200

{
  "countryCode": "US",
  "schema": {}
}

Authorizations

clientCredentialsbearerToken

Authorization · string · header · required

OAuth2 client credentials flow for API authentication

Query Parameters

countryCode · string

ISO 3166-1 alpha-2 country code (e.g., US, BR, AR). Must provide either countryCode or blockchain, not both.

Required string length: 2

blockchain · string

Blockchain name (e.g., ETH, BTC, SOL, TRON, BASE, POL, ARB, OP, GNOSIS). Must provide either countryCode or blockchain, not both.

Response

200

application/json

Requirements retrieved successfully

Option 1

Option 2

Country-specific external account requirements

countryCode · string · required

ISO 3166-1 alpha-2 country code

Required string length: 2

Example:

"US"

schema · object · required

JSON Schema defining the requirements for bank accounts in this country