Create a Profile

Creates a profile that represents a transaction participant, such as the client’s own entity or an external counterparty. A profile is transaction-direction agnostic. The same profile can support both send-to and receive-from transaction directions. Profiles are a prerequisite for all digital asset operations, including blockchain address whitelisting and payout execution.

Please ensure that the correct information is submitted.

flowchart LR

  S((Start)):::start --> A[👤 1. Create a Profile]:::highlight --> B[🛡️ 2. Whitelist Blockchain Address]:::step --> C[💸 3. Create Payout]:::step

  

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

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

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

  

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

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

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

📘

Create a recipient profile

Endpoint

https://www.bankingcircleconnect.com/api/v1/digital-assets/profiles

Purpose

Creates a profile representing a transaction counterparty.

Usage

Use this endpoint to define a counterparty before performing any transaction. Create one profile per counterparty and ensure all information provided is accurate and complete, as profiles are reused across different transaction flows.

Choose recipient type (kind)

When creating a profile, you must specify the type of entity the profile represents. This is done using the kind field, which determines how the profile is structured and used in subsequent transactions

Request Body

To create a profile for your organisation:

To create a profile for an external business entity:

To create a profile for a natural person:

Duplication check on profiles:

A duplication check is performed at the time of profile creation based on a combination of key attributes, depending on the profile type for a given client:

Self (own organisation):

label

External Corporate (business entity):
taxIdentificationNumber (TIN) + country + entityName + address

External Individual (third-party individual):
firstName + lastName + country + dateOfBirth + address

💡

Profile ID

A profileId is returned upon creation. Store this value securely, as it is required for subsequent operations.

Example

Create Profile

{
  "kind": "self",
  "label": "Primary treasury profile",
  "companyNumber": "123456789"
}

Response

{
  "kind": "self",
  "companyNumber": "123456789",
  "label": "Primary treasury profile",
  "id": "prof_01hx2zq3k4m5n6p7q8r9",
  "status": "Created",
  "createdAt": "2026-04-29T09:00:00+00:00",
  "updatedAt": "2026-04-29T09:00:00+00:00"
}

Retrieve Profiles

ℹ️

Fetch a single profile

Endpoint

https://www.bankingcircleconnect.com/api/v1/digital-assets/profiles/{id}

Purpose

Retrieves a specific profile by its unique identifier.

Usage

Used to validate profile details and status before downstream operations.

ℹ️

List profiles

Endpoint

https://www.bankingcircleconnect.com/api/v1/digital-assets/profiles

Purpose

Retrieves all profiles associated with the authenticated client.

Usage

Typically used after profile creation to obtain entities for downstream operations.

⚠️

Important

Uses cursor-based pagination.

Coming Soon