Skip to main content
POST
/
customers
/
{id}
/
recipients
Create a new recipient
curl --request POST \
  --url https://api.platform.dakota.xyz/customers/{id}/recipients \
  --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",
    "city": "San Francisco",
    "country": "US",
    "street2": "Apt 4B",
    "street3": "Building C",
    "region": "California",
    "postal_code": "94105"
  }
}
'
{
  "id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
  "name": "Acme Corporation",
  "status": "active",
  "address": {
    "street1": "123 Main St",
    "city": "San Francisco",
    "country": "US",
    "street2": "Apt 4B",
    "street3": "Building C",
    "region": "California",
    "postal_code": "94105"
  },
  "destinations": [
    {
      "destination_id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
      "destination_type": "crypto",
      "name": "My Ethereum Wallet",
      "crypto_address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "family": "evm",
      "network_id": "ethereum-mainnet"
    }
  ]
}

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

​
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
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

Body

application/json

Recipient details

Request for creating or updating a recipient entity.

​
name
string
required

Name of the recipient entity

Example:

"Acme Corporation"

​
address
Address · object
required

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

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
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 | US Fiat Destination Response · object | IBAN Fiat Destination Response · object)[]

List of destinations associated with this recipient.

Response for a crypto destination.