POST
/
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": "isometric.com",
  "beneficiary_name": "John Smith"
}'
{
  "domain": "isometric.com",
  "id": "org_1GB56M1ST1S0GVNA",
  "name": "Isometric"
}

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

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Body

application/json
​
beneficiary_domain
string
required

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

Maximum length: 256
Example:

"isometric.com"

​
beneficiary_name
string
required

A publicly visible name to be put on the retirement certificate

Maximum length: 256
Example:

"John Smith"

Response

200
application/json
Successful Response
​
domain
string | null
required
Example:

"isometric.com"

​
id
string
required
Required string length: 20 - 36
Example:

"org_1GB56M1ST1S0GVNA"

​
name
string
required
Example:

"Isometric"

Was this page helpful?