Create Beneficiary

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

POST /beneficiary

Create Beneficiary

cURL

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>",
  "__typename": "CreateOrganizationBeneficiary"
}
'

import requests

url = "https://api.sandbox.isometric.com/registry/v0/beneficiary"

payload = {
    "beneficiary_domain": "<string>",
    "beneficiary_name": "<string>",
    "__typename": "CreateOrganizationBeneficiary"
}
headers = {
    "x-client-secret": "<x-client-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-secret': '<x-client-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    beneficiary_domain: '<string>',
    beneficiary_name: '<string>',
    __typename: 'CreateOrganizationBeneficiary'
  })
};

fetch('https://api.sandbox.isometric.com/registry/v0/beneficiary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.isometric.com/registry/v0/beneficiary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'beneficiary_domain' => '<string>',
    'beneficiary_name' => '<string>',
    '__typename' => 'CreateOrganizationBeneficiary'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-client-secret: <x-client-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.isometric.com/registry/v0/beneficiary"

	payload := strings.NewReader("{\n  \"beneficiary_domain\": \"<string>\",\n  \"beneficiary_name\": \"<string>\",\n  \"__typename\": \"CreateOrganizationBeneficiary\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-secret", "<x-client-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.isometric.com/registry/v0/beneficiary")
  .header("x-client-secret", "<x-client-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"beneficiary_domain\": \"<string>\",\n  \"beneficiary_name\": \"<string>\",\n  \"__typename\": \"CreateOrganizationBeneficiary\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.isometric.com/registry/v0/beneficiary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-client-secret"] = '<x-client-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"beneficiary_domain\": \"<string>\",\n  \"beneficiary_name\": \"<string>\",\n  \"__typename\": \"CreateOrganizationBeneficiary\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "domain": "isometric.com",
  "id": "org_1GB56M1ST1S0GVNA",
  "name": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

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

CreateOrganizationBeneficiary

CreateIndividualBeneficiary

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

200

application/json

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"