Skip to main content
POST
Create a new recipient

Authorizations

x-api-key
string
header
required

Headers

x-idempotency-key
string<uuid>
required

Unique key to ensure request idempotency. If the same key is used within a certain time window, the original response will be returned instead of executing the request again.

Path Parameters

customer_id
string
required

KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Pattern: ^[0-9A-Za-z]{27}$
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

Body

application/json

Recipient details

Request for creating or updating a recipient entity.

Address Requirements:

  • Optional for crypto-only recipients (can be omitted or null)
  • Required before adding fiat destinations (ACH, Wire, SWIFT)

Migration Path: Recipients created without addresses can be updated later to add an address when fiat capabilities are needed.

name
string
required

Name of the recipient entity

Required string length: 3 - 140
Example:

"Acme Corporation"

address
Address · object

Physical address of the recipient.

  • Optional when creating/updating crypto-only recipients
  • Required for recipients that will have fiat destinations (ACH, Wire, SWIFT)
  • Can be added later via PUT /recipients/{id} to enable fiat capabilities

Response

Recipient created successfully

Response containing recipient details.

id
string
required

KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Pattern: ^[0-9A-Za-z]{27}$
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

name
string
required

Name of the recipient entity.

Example:

"Acme Corporation"

status
enum<string>
required

Current status of the recipient

Available options:
unused,
active,
frozen
Example:

"active"

address
Address · object | null

Standardized physical address format used throughout the Dakota platform for user and entity addresses.

destinations
Crypto Destination Response · object · Crypto Destination Response · object · Crypto Destination Response · object · US Fiat Destination Response · object · IBAN Fiat Destination Response · object[]

List of destinations associated with this recipient.

Response for a crypto destination.