Skip to main content
PUT
/
recipients
/
{recipient_id}
Update a recipient
curl --request PUT \
  --url https://api.platform.dakota.xyz/recipients/{recipient_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "name": "Acme Corporation",
  "address": {
    "street1": "123 Main St",
    "street2": "Apt 4B",
    "street3": "Building C",
    "city": "San Francisco",
    "region": "California",
    "postal_code": "94105",
    "country": "US"
  }
}
'
{
  "id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
  "name": "Acme Corporation",
  "address": {
    "street1": "123 Main St",
    "street2": "Apt 4B",
    "street3": "Building C",
    "city": "San Francisco",
    "region": "California",
    "postal_code": "94105",
    "country": "US"
  },
  "status": "active",
  "destinations": [
    {
      "destination_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
      "destination_type": "crypto",
      "name": "My Ethereum Wallet",
      "crypto_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "family": "evm",
      "network_id": "ethereum-mainnet"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.dakota.xyz/llms.txt

Use this file to discover all available pages before exploring further.

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

ā€‹
recipient_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

Updated 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

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 updated 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

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.