Skip to main content
POST
Create Beneficiary

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

Unique organization domain name for corporate beneficiaries. The domain is not displayed on the registry.

Maximum string length: 256
Example:

"acme.com"

beneficiary_name
string
required

A publicly visible name shown on the retirement certificate and registry

Maximum string length: 256
Example:

"Acme Corporation"

__typename
string
default:CreateOrganizationBeneficiary

Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.

Allowed value: "CreateOrganizationBeneficiary"

Response

Successful Response

domain
string | null
required
Example:

"isometric.com"

id
string
required
Required string length: 20 - 37
Examples:

"org_1GB56M1ST1S0GVNA"

"org_1CP8EQDNQSBXTMR2"

name
string
required
Example:

"Isometric"