Get external account requirements

Retrieve JSON Schema requirements for creating external accounts.

Pass src and dest currency codes to get the schema requirements for both the source and destination accounts in a currency pair. 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://api.gnosisramp.io/v1/external-accounts/requirements \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "src": "USD",
  "dest": "USDC_GNO",
  "source": {},
  "destination": {}
}

Authorizations

Authorization · string · header · required

HTTP Basic authentication using project clientId and clientSecret

Query Parameters

src · string · required

Source currency code (e.g., USD, EUR, BRL)

dest · string · required

Destination currency code (e.g., USDC_GNO, USDC_ETH, USDC_BASE)

Response

200

application/json

Requirements retrieved successfully

Paired external account requirements for a currency route

src · string · required

Source currency code

Example:

"USD"

dest · string · required

Destination currency code

Example:

"USDC_GNO"

source · object · required

JSON Schema defining the requirements for the source account (e.g., bank account fields)

destination · object · required

JSON Schema defining the requirements for the destination account (e.g., crypto address fields)