Skip to main content
POST
cURL
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