Skip to main content
GET
Get a specific recipient

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