Get annuity contract

GET

annuity_contracts

{id}

curl --request GET \
  --url https://api.slant.app/v1/annuity_contracts/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.slant.app/v1/annuity_contracts/{id}', 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.slant.app/v1/annuity_contracts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.slant.app/v1/annuity_contracts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.slant.app/v1/annuity_contracts/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "carrier_key": "<string>",
  "carrier_name": "<string>",
  "contract_number": "<string>",
  "contract_type": "variable_annuity",
  "product_code": "<string>",
  "product_name": "<string>",
  "status": "<string>",
  "tax_status": "<string>",
  "established_on": "2023-12-25",
  "issued_on": "2023-12-25",
  "anniversary_on": "2023-12-25",
  "matures_on": "2023-12-25",
  "notes": "<string>",
  "parties": [
    {
      "role": "owner",
      "display_name": "<string>",
      "participant_type": "Person",
      "participant_id": "<string>",
      "id": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "term_authority": "advisor",
  "data_provider": "<string>",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "registration_type": "<string>",
  "placements": [
    {
      "id": "<string>",
      "book_id": "<string>",
      "household_id": "<string>",
      "business_id": "<string>",
      "trust_id": "<string>",
      "placement_authority": "advisor"
    }
  ],
  "current_values": {},
  "values": [
    {
      "id": "<string>",
      "kind": "accumulation_value",
      "amount": "<string>",
      "as_of_date": "2023-12-25",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "annuity_contract_id": "<string>",
      "source_kind": "integration"
    }
  ]
}

Authorizations

Authorization

string

header

required

OAuth 2.0 Bearer Token from Clerk authentication

Headers

Authorization

string

Path Parameters

string

required

Response

Successful financial resource access

string

required

carrier_key

string | null

carrier_name

string

contract_number

string

Masked contract number; the full number is never returned.

contract_type

enum<string>

Available options:

variable_annuity,

other_annuity

product_code

string | null

product_name

string | null

status

string | null

tax_status

string | null

established_on

string<date> | null

issued_on

string<date> | null

anniversary_on

string<date> | null

matures_on

string<date> | null

notes

string | null

parties

object[]

Show child attributes

created_at

string<date-time>

updated_at

string<date-time>

term_authority

enum<string>

Available options:

advisor,

integration

data_provider

string | null

last_synced_at

string<date-time> | null

registration_type

string | null

placements

object[]

Only placements in accessible books.

Show child attributes

current_values

object

Show child attributes

values

object[]

Show child attributes

⌘I

Get annuity contract

curl --request GET \
  --url https://api.slant.app/v1/annuity_contracts/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.slant.app/v1/annuity_contracts/{id}', 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.slant.app/v1/annuity_contracts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.slant.app/v1/annuity_contracts/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.slant.app/v1/annuity_contracts/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "carrier_key": "<string>",
  "carrier_name": "<string>",
  "contract_number": "<string>",
  "contract_type": "variable_annuity",
  "product_code": "<string>",
  "product_name": "<string>",
  "status": "<string>",
  "tax_status": "<string>",
  "established_on": "2023-12-25",
  "issued_on": "2023-12-25",
  "anniversary_on": "2023-12-25",
  "matures_on": "2023-12-25",
  "notes": "<string>",
  "parties": [
    {
      "role": "owner",
      "display_name": "<string>",
      "participant_type": "Person",
      "participant_id": "<string>",
      "id": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "term_authority": "advisor",
  "data_provider": "<string>",
  "last_synced_at": "2023-11-07T05:31:56Z",
  "registration_type": "<string>",
  "placements": [
    {
      "id": "<string>",
      "book_id": "<string>",
      "household_id": "<string>",
      "business_id": "<string>",
      "trust_id": "<string>",
      "placement_authority": "advisor"
    }
  ],
  "current_values": {},
  "values": [
    {
      "id": "<string>",
      "kind": "accumulation_value",
      "amount": "<string>",
      "as_of_date": "2023-12-25",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "annuity_contract_id": "<string>",
      "source_kind": "integration"
    }
  ]
}

Getting started

Endpoints

Get annuity contract

Authorizations

Headers

Path Parameters

Response