Sign in

v2

latestOpenAPI 3.1.02026-08-054181117.0 KB

Create Beneficiary

Create a new beneficiary for your organization to retire on behalf of.

post/beneficiary

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Request body

OR

Example request

{
  "beneficiary_name": "Acme Corporation",
  "beneficiary_domain": "acme.com"
}

Response

Successful Response

idstring required
namestring required
domainstring nullable required

Example response

{
  "id": "org_1GB56M1ST1S0GVNA",
  "name": "Isometric",
  "domain": "isometric.com"
}