Skip to main content
POST
/
beneficiary
Create Beneficiary
curl --request POST \
  --url https://api.sandbox.isometric.com/registry/v0/beneficiary \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "beneficiary_domain": "<string>",
  "beneficiary_name": "<string>"
}
'
{
  "domain": "isometric.com",
  "id": "<string>",
  "name": "<string>"
}

Authorizations

​
Authorization
string
header
required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

​
x-client-secret
string
required

A secret token identifying the client connecting to the API

Body

application/json
​
beneficiary_domain
string
required

A publicly visible organisation domain name to be put on the retirement certificate

Maximum string length: 256
​
beneficiary_name
string
required

A publicly visible name to be put on the retirement certificate

Maximum string length: 256

Response

Successful Response

​
domain
string | null
required
Example:

"isometric.com"

​
id
string
required
Required string length: 20 - 37
​
name
string
required