Blockchain whitelisting controls which on-chain addresses are allowed to interact with your account. Before any funds can be transferred or received, the relevant addresses must be explicitly approved through the whitelisting process.

Addresses are direction-specific:

• to-address: Whitelisted for outgoing transfers (sending funds)

  Newly added to-addresses are subject to a 24-hour cool down period before they can be used

• from-address: Whitelisted for incoming transfers (receiving funds)

  Newly added from-addresses are available for immediate use

flowchart LR

  S((Start)):::start -->

  A([👤 1. Create a Profile]):::step -->

  B([🛡️ 2. Whitelist Blockchain Address]):::highlight -->

  C([💸 3. Create Payout]):::step

  

  %% Base theme (your primary)

  classDef step fill:#C7E5DE,stroke:#5FA8A0,color:#1F3C3A,stroke-width:2px,rx:14,ry:14;

  

  %% Highlighted step (only step 2)

  classDef highlight fill:#A8DCD1,stroke:#2F7F77,color:#0F2F2D,stroke-width:3px,rx:16,ry:16;

  

  %% Start marker

  classDef start fill:#FFFFFF,stroke:#2F7F77,color:#0F2F2D,stroke-width:2px;

  

  %% “Journey line” (thicker path)

  linkStyle 0 stroke:#2F7F77,stroke-width:3px;

  linkStyle 1 stroke:#2F7F77,stroke-width:3px;

  linkStyle 2 stroke:#2F7F77,stroke-width:3px;

Whitelist a to-address

📘

Applies to to-address (outgoing transfers)

Endpoint

https://www.bankingcircleconnect.com/api/v1/digital-assets/blockchain-whitelisting/sending-to-addresses

Purpose

Whitelists a blockchain address that your account is allowed to send funds to.

Usage

Use this endpoint to whitelist a destination address before initiating a payout, ensuring funds can only be sent to approved addresses.

Request body

💡

Address ID

An addressId is returned upon successful whitelisting. Store this value securely, as it is required for future operations.

Example

Whitelist to-address

{
  "profileId": "prof_01hx2zq3k4m5n6p7q8r9",
  "address": "0x1111111111111111111111111111111111111111",
  "custodyDetails": {
    "custody": "custodial",
    "vaspCode": "COINBASE"
  }
}

Response

{
  "id": "addrto_01hzxjkhq4m2wtqv43w8v9n8ck",
  "profileId": "prof_01hx2zq3k4m5n6p7q8r9",
  "companyNumber": "123456789",
  "address": "0x1111111111111111111111111111111111111111",
  "custody": "custodial",
  "vaspCode": "COINBASE",
  "validAt": "2026-04-29T09:00:00+00:00",
  "status": "Submitted"
}

⚠️

Important

• Only EVM-compatible networks are supported

• A valid profile must be provided

• Addresses must be approved before they can be used

• Newly added to-addresses are subject to a 24-hour cool down period before they can be used, helping ensure that changes are intentional and controlled

  🔖 During this period, you can check the address status at any time, and we’ll share the exact time when it will be ready to use

Address Lifecycle

flowchart LR

  A[📨 Submitted]:::state --> B[✅ Whitelisted]:::ok

  A --> C[⛔ Blocked]:::bad

  

  classDef state fill:#C7E5DE,stroke:#5FA8A0,color:#1F3C3A,stroke-width:2px,rx:12,ry:12;

  classDef ok fill:#DFF3EE,stroke:#2F7F77,color:#0F2F2D,stroke-width:2px,rx:12,ry:12;

  classDef bad fill:#FFE8E8,stroke:#D66B6B,color:#5B1B1B,stroke-width:2px,rx:12,ry:12;

  

  linkStyle 0 stroke:#2F7F77,stroke-width:3px;

  linkStyle 1 stroke:#D66B6B,stroke-width:2px;

Manage to-Addresses

📘

Delete to-address

Endpoint

https://www.bankingcircleconnect.com/api/v1/digital-assets/blockchain-whitelisting/sending-to-addresses/{id}

Purpose

Removes a whitelisted blockchain address.

Usage

Use this endpoint to remove an address that is no longer required or should no longer be allowed for outgoing transfers.

📘

List to-addresses

Endpoint

https://www.bankingcircleconnect.com/api/v1/digital-assets/blockchain-whitelisting/sending-to-addresses

Purpose

Retrieves whitelisted blockchain addresses associated with the account.

Usage

Use this endpoint to obtain the addressId required for payouts and to verify whether an address is ready for use.

Whitelist from-address

📘

Applies to from-address (incoming transfers).

Endpoint

https://www.bankingcircleconnect.com/api/v1/digital-assets/blockchain-whitelisting/receiving-from-addresses

Purpose

Whitelists a blockchain address.

Usage

Use this endpoint to whitelist addresses that are allowed to send funds to the account (incoming transfers).

Request body:

💡

Address ID

An addressId is returned upon successful whitelisting. Store this value securely, as it is required for subsequent operations.

Example

Whitelist a from-address

{
  "profileId": "prof_01hx2zq3k4m5n6p7q8r9",
  "address": "0x1111111111111111111111111111111111111111",
  "custodyDetails": {
    "custody": "custodial",
    "vaspCode": "COINBASE"
  }
}

Response

{
  "id": "addrto_01hzxjkhq4m2wtqv43w8v9n8ck",
  "profileId": "prof_01hx2zq3k4m5n6p7q8r9",
  "companyNumber": "123456789",
  "address": "0x1111111111111111111111111111111111111111",
  "custody": "custodial",
  "vaspCode": "COINBASE",
  "validAt": "2026-04-29T09:00:00+00:00",
  "status": "Submitted"
} 

⚠️

Important

• Only EVM-compatible networks are supported
• A valid profile is required
• Addresses must be approved before use
• The from-addresses can be used immediately without delay.

Address Lifecycle

flowchart LR

  A[📨 Submitted]:::state --> B[✅ Whitelisted]:::ok

  A --> C[⛔ Blocked]:::bad

  

  classDef state fill:#C7E5DE,stroke:#5FA8A0,color:#1F3C3A,stroke-width:2px,rx:12,ry:12;

  classDef ok fill:#DFF3EE,stroke:#2F7F77,color:#0F2F2D,stroke-width:2px,rx:12,ry:12;

  classDef bad fill:#FFE8E8,stroke:#D66B6B,color:#5B1B1B,stroke-width:2px,rx:12,ry:12;

  

  linkStyle 0 stroke:#2F7F77,stroke-width:3px;

  linkStyle 1 stroke:#D66B6B,stroke-width:2px;

Manage the from-Addresses

ℹ️

Delete from-address

Endpoint

https://www.bankingcircleconnect.com/api/v1/digital-assets/blockchain-whitelisting/receiving-from-addresses/{id}

Purpose

Removes a whitelisted blockchain address.

Usage

Use this endpoint to remove an address that is no longer authorised to send funds to the account.

ℹ️

List from-addresses

Endpoint

https://www.bankingcircleconnect.com/api/v1/digital-assets/blockchain-whitelisting/receiving-from-addresses

Purpose

Retrieves whitelisted blockchain addresses for incoming transfers.

Usage

Use this endpoint to obtain the addressId and verify whether an address is approved to send funds to the account.

Coming Soon