Skip to main content
POST
/
recipients
cURL
curl --request POST \
  --url https://sandbox.onconsul.com/v1/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "nickname": "<string>"
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "email": "jsmith@example.com",
  "id": "<string>",
  "on_platform": true,
  "nickname": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.onconsul.com/llms.txt

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

Create a new recipient by providing their email address and an optional nickname. When you later send a payout to this recipient, they receive a Consul wallet where they can save, spend, or withdraw their funds.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
email
string<email>
required
Required string length: 1 - 255
​
nickname
string
Required string length: 1 - 255

Response

OK

​
created_at
string<date-time>
required
​
display_name
string
required
​
email
string<email>
required
​
id
string
required
​
on_platform
boolean
required
​
nickname
string