Create FBO Account Alias
curl --request POST \
--url https://api.beachdepository.com/v1/fbo-accounts/{id}/aliases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"aliasVaultId": "<string>",
"source": "<string>"
}
'import requests
url = "https://api.beachdepository.com/v1/fbo-accounts/{id}/aliases"
payload = {
"aliasVaultId": "<string>",
"source": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({aliasVaultId: '<string>', source: '<string>'})
};
fetch('https://api.beachdepository.com/v1/fbo-accounts/{id}/aliases', 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.beachdepository.com/v1/fbo-accounts/{id}/aliases",
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([
'aliasVaultId' => '<string>',
'source' => '<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.beachdepository.com/v1/fbo-accounts/{id}/aliases"
payload := strings.NewReader("{\n \"aliasVaultId\": \"<string>\",\n \"source\": \"<string>\"\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.beachdepository.com/v1/fbo-accounts/{id}/aliases")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"aliasVaultId\": \"<string>\",\n \"source\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beachdepository.com/v1/fbo-accounts/{id}/aliases")
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 \"aliasVaultId\": \"<string>\",\n \"source\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyFBO Account Aliases
Create FBO Account Alias
Add an alternate vault ID to an FBO account
POST
/
fbo-accounts
/
{id}
/
aliases
Create FBO Account Alias
curl --request POST \
--url https://api.beachdepository.com/v1/fbo-accounts/{id}/aliases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"aliasVaultId": "<string>",
"source": "<string>"
}
'import requests
url = "https://api.beachdepository.com/v1/fbo-accounts/{id}/aliases"
payload = {
"aliasVaultId": "<string>",
"source": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({aliasVaultId: '<string>', source: '<string>'})
};
fetch('https://api.beachdepository.com/v1/fbo-accounts/{id}/aliases', 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.beachdepository.com/v1/fbo-accounts/{id}/aliases",
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([
'aliasVaultId' => '<string>',
'source' => '<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.beachdepository.com/v1/fbo-accounts/{id}/aliases"
payload := strings.NewReader("{\n \"aliasVaultId\": \"<string>\",\n \"source\": \"<string>\"\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.beachdepository.com/v1/fbo-accounts/{id}/aliases")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"aliasVaultId\": \"<string>\",\n \"source\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.beachdepository.com/v1/fbo-accounts/{id}/aliases")
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 \"aliasVaultId\": \"<string>\",\n \"source\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAdds an alternate vault ID (alias) to an FBO account. Intake can then resolve this ID to the same account as the canonical
vaultId.
The account must already have a canonical vault ID. An alias must be 7–20 digits and cannot be in use by another FBO account.
Permission: fbo_accounts:update
Path parameters
string
required
The FBO account ID
Request body
string
required
Alternate vault ID. Digits only (spaces and hyphens are stripped). Must be 7–20 digits.
string
Optional label for where the alias came from (for example
legacy or import). Defaults to
api.Response
Returns the created alias.{
"data": {
"id": "ja7aliasnew",
"fboAccountId": "m97fbo456",
"aliasVaultId": "1234567",
"source": "api",
"isActive": true,
"updatedAt": "2025-06-15T09:00:00.000Z",
"createdAt": "2025-06-15T09:00:00.000Z"
}
}
This endpoint supports the
Idempotency-Key header. Replaying a request with the same key returns
the original response instead of creating a second alias.⌘I