POST/api/v2/crypto-virtual-accounts/bank-address-book

Register a the crypto on/off-ramp fiat external account

Registers an external bank account in the crypto on/off-ramp bankAddressBook for automatic fiat withdrawal delivery.

Authentication

Send your API key in the x-api-key header on every request.

Request body

application/json

Request body fields
Field	Type	Required
name	string	No
account_number	string	No
bank_name	string	No
account_holder_name	string	No
country	string	No
currency	string	No

Responses

201 — Created

Response 201 fields
Field	Type	Required
id	unknown	No
name	string	No
currency	string	No
bank_name	string	No
account_number	string	No
account_number_hint	string	No
account_holder_name	string	No
country	string	No
enabled	boolean	No
state	string	No
status	string	No

400 — Bad Request

Response 400 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

Example request

curl -X POST "https://{base_url}/api/v2/crypto-virtual-accounts/bank-address-book" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

This page is generated from the live OpenAPI specification and always matches the current API.