Annuity Contracts
Update annuity contract
Financial terms and values; no custodian data or attachments. Numbers are masked. Imported annuity terms and parties are read-only except notes. Values use dollars; balances use cents. Party arrays replace submitted roles or accessible annuity parties. Only advisor valuations can be edited.
PATCH
/
v1
/
annuity_contracts
/
{id}
Update annuity contract
curl --request PATCH \
--url https://api.slant.app/v1/annuity_contracts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"carrier_key": "<string>",
"carrier_name": "<string>",
"contract_number": "<string>",
"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": [
{
"display_name": "<string>",
"participant_id": "<string>"
}
],
"book_id": "<string>"
}
'import requests
url = "https://api.slant.app/v1/annuity_contracts/{id}"
payload = {
"carrier_key": "<string>",
"carrier_name": "<string>",
"contract_number": "<string>",
"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": [
{
"display_name": "<string>",
"participant_id": "<string>"
}
],
"book_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
carrier_key: '<string>',
carrier_name: '<string>',
contract_number: '<string>',
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: [{display_name: '<string>', participant_id: '<string>'}],
book_id: '<string>'
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'carrier_key' => '<string>',
'carrier_name' => '<string>',
'contract_number' => '<string>',
'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' => [
[
'display_name' => '<string>',
'participant_id' => '<string>'
]
],
'book_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.slant.app/v1/annuity_contracts/{id}"
payload := strings.NewReader("{\n \"carrier_key\": \"<string>\",\n \"carrier_name\": \"<string>\",\n \"contract_number\": \"<string>\",\n \"product_code\": \"<string>\",\n \"product_name\": \"<string>\",\n \"status\": \"<string>\",\n \"tax_status\": \"<string>\",\n \"established_on\": \"2023-12-25\",\n \"issued_on\": \"2023-12-25\",\n \"anniversary_on\": \"2023-12-25\",\n \"matures_on\": \"2023-12-25\",\n \"notes\": \"<string>\",\n \"parties\": [\n {\n \"display_name\": \"<string>\",\n \"participant_id\": \"<string>\"\n }\n ],\n \"book_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.slant.app/v1/annuity_contracts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"carrier_key\": \"<string>\",\n \"carrier_name\": \"<string>\",\n \"contract_number\": \"<string>\",\n \"product_code\": \"<string>\",\n \"product_name\": \"<string>\",\n \"status\": \"<string>\",\n \"tax_status\": \"<string>\",\n \"established_on\": \"2023-12-25\",\n \"issued_on\": \"2023-12-25\",\n \"anniversary_on\": \"2023-12-25\",\n \"matures_on\": \"2023-12-25\",\n \"notes\": \"<string>\",\n \"parties\": [\n {\n \"display_name\": \"<string>\",\n \"participant_id\": \"<string>\"\n }\n ],\n \"book_id\": \"<string>\"\n}")
.asString();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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"carrier_key\": \"<string>\",\n \"carrier_name\": \"<string>\",\n \"contract_number\": \"<string>\",\n \"product_code\": \"<string>\",\n \"product_name\": \"<string>\",\n \"status\": \"<string>\",\n \"tax_status\": \"<string>\",\n \"established_on\": \"2023-12-25\",\n \"issued_on\": \"2023-12-25\",\n \"anniversary_on\": \"2023-12-25\",\n \"matures_on\": \"2023-12-25\",\n \"notes\": \"<string>\",\n \"parties\": [\n {\n \"display_name\": \"<string>\",\n \"participant_id\": \"<string>\"\n }\n ],\n \"book_id\": \"<string>\"\n}"
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
OAuth 2.0 Bearer Token from Clerk authentication
Path Parameters
Body
application/json
Available options:
variable_annuity, other_annuity Show child attributes
Show child attributes
Optional book context; must match the household.
Response
Successful financial resource access
Masked contract number; the full number is never returned.
Available options:
variable_annuity, other_annuity Show child attributes
Show child attributes
Available options:
advisor, integration Only placements in accessible books.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Update annuity contract
curl --request PATCH \
--url https://api.slant.app/v1/annuity_contracts/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"carrier_key": "<string>",
"carrier_name": "<string>",
"contract_number": "<string>",
"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": [
{
"display_name": "<string>",
"participant_id": "<string>"
}
],
"book_id": "<string>"
}
'import requests
url = "https://api.slant.app/v1/annuity_contracts/{id}"
payload = {
"carrier_key": "<string>",
"carrier_name": "<string>",
"contract_number": "<string>",
"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": [
{
"display_name": "<string>",
"participant_id": "<string>"
}
],
"book_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
carrier_key: '<string>',
carrier_name: '<string>',
contract_number: '<string>',
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: [{display_name: '<string>', participant_id: '<string>'}],
book_id: '<string>'
})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'carrier_key' => '<string>',
'carrier_name' => '<string>',
'contract_number' => '<string>',
'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' => [
[
'display_name' => '<string>',
'participant_id' => '<string>'
]
],
'book_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.slant.app/v1/annuity_contracts/{id}"
payload := strings.NewReader("{\n \"carrier_key\": \"<string>\",\n \"carrier_name\": \"<string>\",\n \"contract_number\": \"<string>\",\n \"product_code\": \"<string>\",\n \"product_name\": \"<string>\",\n \"status\": \"<string>\",\n \"tax_status\": \"<string>\",\n \"established_on\": \"2023-12-25\",\n \"issued_on\": \"2023-12-25\",\n \"anniversary_on\": \"2023-12-25\",\n \"matures_on\": \"2023-12-25\",\n \"notes\": \"<string>\",\n \"parties\": [\n {\n \"display_name\": \"<string>\",\n \"participant_id\": \"<string>\"\n }\n ],\n \"book_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.slant.app/v1/annuity_contracts/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"carrier_key\": \"<string>\",\n \"carrier_name\": \"<string>\",\n \"contract_number\": \"<string>\",\n \"product_code\": \"<string>\",\n \"product_name\": \"<string>\",\n \"status\": \"<string>\",\n \"tax_status\": \"<string>\",\n \"established_on\": \"2023-12-25\",\n \"issued_on\": \"2023-12-25\",\n \"anniversary_on\": \"2023-12-25\",\n \"matures_on\": \"2023-12-25\",\n \"notes\": \"<string>\",\n \"parties\": [\n {\n \"display_name\": \"<string>\",\n \"participant_id\": \"<string>\"\n }\n ],\n \"book_id\": \"<string>\"\n}")
.asString();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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"carrier_key\": \"<string>\",\n \"carrier_name\": \"<string>\",\n \"contract_number\": \"<string>\",\n \"product_code\": \"<string>\",\n \"product_name\": \"<string>\",\n \"status\": \"<string>\",\n \"tax_status\": \"<string>\",\n \"established_on\": \"2023-12-25\",\n \"issued_on\": \"2023-12-25\",\n \"anniversary_on\": \"2023-12-25\",\n \"matures_on\": \"2023-12-25\",\n \"notes\": \"<string>\",\n \"parties\": [\n {\n \"display_name\": \"<string>\",\n \"participant_id\": \"<string>\"\n }\n ],\n \"book_id\": \"<string>\"\n}"
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"
}
]
}