JavaScript
import Augustus from '@augustusbank/typescript-sdk';
const client = new Augustus({
apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});
const accountHolder = await client.accountHolders.create({
account_program_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
beneficiary_data: {
country_of_citizenship: 'US',
date_of_birth: '2019-12-27',
identification: { type: 'ssn', value: '732-66-9102' },
legal_name: 'x',
residential_address: {
city: 'x',
country: 'US',
postal_code: 'x',
state: 'xx',
street_line_1: 'x',
},
},
});
console.log(accountHolder.id);curl --request POST \
--url https://api.augustus.com/v1/account_holders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"beneficiary_data": {
"legal_name": "<string>",
"residential_address": {
"street_line_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "US",
"street_line_2": "<string>"
},
"date_of_birth": "2023-12-25",
"identification": {
"type": "ssn",
"value": "<string>"
},
"country_of_citizenship": "US"
}
}
'import requests
url = "https://api.augustus.com/v1/account_holders"
payload = {
"account_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"beneficiary_data": {
"legal_name": "<string>",
"residential_address": {
"street_line_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "US",
"street_line_2": "<string>"
},
"date_of_birth": "2023-12-25",
"identification": {
"type": "ssn",
"value": "<string>"
},
"country_of_citizenship": "US"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.augustus.com/v1/account_holders",
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([
'account_program_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'beneficiary_data' => [
'legal_name' => '<string>',
'residential_address' => [
'street_line_1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => 'US',
'street_line_2' => '<string>'
],
'date_of_birth' => '2023-12-25',
'identification' => [
'type' => 'ssn',
'value' => '<string>'
],
'country_of_citizenship' => 'US'
]
]),
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.augustus.com/v1/account_holders"
payload := strings.NewReader("{\n \"account_program_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"beneficiary_data\": {\n \"legal_name\": \"<string>\",\n \"residential_address\": {\n \"street_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"US\",\n \"street_line_2\": \"<string>\"\n },\n \"date_of_birth\": \"2023-12-25\",\n \"identification\": {\n \"type\": \"ssn\",\n \"value\": \"<string>\"\n },\n \"country_of_citizenship\": \"US\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.augustus.com/v1/account_holders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_program_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"beneficiary_data\": {\n \"legal_name\": \"<string>\",\n \"residential_address\": {\n \"street_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"US\",\n \"street_line_2\": \"<string>\"\n },\n \"date_of_birth\": \"2023-12-25\",\n \"identification\": {\n \"type\": \"ssn\",\n \"value\": \"<string>\"\n },\n \"country_of_citizenship\": \"US\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.augustus.com/v1/account_holders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_program_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"beneficiary_data\": {\n \"legal_name\": \"<string>\",\n \"residential_address\": {\n \"street_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"US\",\n \"street_line_2\": \"<string>\"\n },\n \"date_of_birth\": \"2023-12-25\",\n \"identification\": {\n \"type\": \"ssn\",\n \"value\": \"<string>\"\n },\n \"country_of_citizenship\": \"US\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"type": "account_holder",
"beneficiary_data": {
"legal_name": "<string>",
"residential_address": {
"street_line_1": "<string>",
"street_line_2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "US"
},
"date_of_birth": "2023-12-25",
"identification": {
"type": "ssn",
"value": "<string>"
},
"country_of_citizenship": "US"
},
"created_at": "2023-11-07T05:31:56Z"
}Account Holders
Create account holder
Creates a new account holder and starts asynchronous processing.
POST
/
v1
/
account_holders
JavaScript
import Augustus from '@augustusbank/typescript-sdk';
const client = new Augustus({
apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});
const accountHolder = await client.accountHolders.create({
account_program_id: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
beneficiary_data: {
country_of_citizenship: 'US',
date_of_birth: '2019-12-27',
identification: { type: 'ssn', value: '732-66-9102' },
legal_name: 'x',
residential_address: {
city: 'x',
country: 'US',
postal_code: 'x',
state: 'xx',
street_line_1: 'x',
},
},
});
console.log(accountHolder.id);curl --request POST \
--url https://api.augustus.com/v1/account_holders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"account_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"beneficiary_data": {
"legal_name": "<string>",
"residential_address": {
"street_line_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "US",
"street_line_2": "<string>"
},
"date_of_birth": "2023-12-25",
"identification": {
"type": "ssn",
"value": "<string>"
},
"country_of_citizenship": "US"
}
}
'import requests
url = "https://api.augustus.com/v1/account_holders"
payload = {
"account_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"beneficiary_data": {
"legal_name": "<string>",
"residential_address": {
"street_line_1": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "US",
"street_line_2": "<string>"
},
"date_of_birth": "2023-12-25",
"identification": {
"type": "ssn",
"value": "<string>"
},
"country_of_citizenship": "US"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.augustus.com/v1/account_holders",
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([
'account_program_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'beneficiary_data' => [
'legal_name' => '<string>',
'residential_address' => [
'street_line_1' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => 'US',
'street_line_2' => '<string>'
],
'date_of_birth' => '2023-12-25',
'identification' => [
'type' => 'ssn',
'value' => '<string>'
],
'country_of_citizenship' => 'US'
]
]),
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.augustus.com/v1/account_holders"
payload := strings.NewReader("{\n \"account_program_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"beneficiary_data\": {\n \"legal_name\": \"<string>\",\n \"residential_address\": {\n \"street_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"US\",\n \"street_line_2\": \"<string>\"\n },\n \"date_of_birth\": \"2023-12-25\",\n \"identification\": {\n \"type\": \"ssn\",\n \"value\": \"<string>\"\n },\n \"country_of_citizenship\": \"US\"\n }\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.augustus.com/v1/account_holders")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"account_program_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"beneficiary_data\": {\n \"legal_name\": \"<string>\",\n \"residential_address\": {\n \"street_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"US\",\n \"street_line_2\": \"<string>\"\n },\n \"date_of_birth\": \"2023-12-25\",\n \"identification\": {\n \"type\": \"ssn\",\n \"value\": \"<string>\"\n },\n \"country_of_citizenship\": \"US\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.augustus.com/v1/account_holders")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"account_program_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"beneficiary_data\": {\n \"legal_name\": \"<string>\",\n \"residential_address\": {\n \"street_line_1\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"US\",\n \"street_line_2\": \"<string>\"\n },\n \"date_of_birth\": \"2023-12-25\",\n \"identification\": {\n \"type\": \"ssn\",\n \"value\": \"<string>\"\n },\n \"country_of_citizenship\": \"US\"\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"type": "account_holder",
"beneficiary_data": {
"legal_name": "<string>",
"residential_address": {
"street_line_1": "<string>",
"street_line_2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "US"
},
"date_of_birth": "2023-12-25",
"identification": {
"type": "ssn",
"value": "<string>"
},
"country_of_citizenship": "US"
},
"created_at": "2023-11-07T05:31:56Z"
}Authorizations
Bearer token for authentication with Augustus Banking API
Headers
Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.
Body
application/json
Account holder parameters
ID of the account program to create the account holder under.
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$Personal information of the account holder.
- Option 1
- Option 2
Show child attributes
Show child attributes
Response
200 - application/json
Account holder created successfully
Unique identifier of the account holder.
Pattern:
^[0-9a-fA-F]{24}$Resource type discriminator.
Available options:
account_holder Current account holder status.
Available options:
pending, active, closed Beneficiary details used to create this account holder.
- Option 1
- Option 2
Show child attributes
Show child attributes
ISO 8601 UTC timestamp when the account holder was created.
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Was this page helpful?
⌘I