Skip to main content
GET
/
recipients
/
{recipient_id}
Get a specific recipient
curl --request GET \
  --url https://api.platform.dakota.xyz/recipients/{recipient_id} \
  --header 'x-api-key: <api-key>'
{
  "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"
    }
  ]
}

Authorizations

ā€‹
x-api-key
string
header
required

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"

Response

Recipient details

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.