Update Physical Address
curl --request POST \
--url https://api.example.com/v1/auth/register/address \
--header 'Content-Type: application/json' \
--data '
{
"onboardingId": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"zip": "<string>",
"usState": "<string>",
"isSameMailingAddress": true
}
'import requests
url = "https://api.example.com/v1/auth/register/address"
payload = {
"onboardingId": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"zip": "<string>",
"usState": "<string>",
"isSameMailingAddress": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
onboardingId: '<string>',
addressLine1: '<string>',
addressLine2: '<string>',
city: '<string>',
zip: '<string>',
usState: '<string>',
isSameMailingAddress: true
})
};
fetch('https://api.example.com/v1/auth/register/address', 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.example.com/v1/auth/register/address",
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([
'onboardingId' => '<string>',
'addressLine1' => '<string>',
'addressLine2' => '<string>',
'city' => '<string>',
'zip' => '<string>',
'usState' => '<string>',
'isSameMailingAddress' => true
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/auth/register/address"
payload := strings.NewReader("{\n \"onboardingId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"usState\": \"<string>\",\n \"isSameMailingAddress\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/auth/register/address")
.header("Content-Type", "application/json")
.body("{\n \"onboardingId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"usState\": \"<string>\",\n \"isSameMailingAddress\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/auth/register/address")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"onboardingId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"usState\": \"<string>\",\n \"isSameMailingAddress\": true\n}"
response = http.request(request)
puts response.read_body{
"accessToken": "<string>",
"onboardingId": "<string>",
"user": {}
}Authentication
Update Physical Address
Submit physical address during registration onboarding
POST
/
v1
/
auth
/
register
/
address
Update Physical Address
curl --request POST \
--url https://api.example.com/v1/auth/register/address \
--header 'Content-Type: application/json' \
--data '
{
"onboardingId": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"zip": "<string>",
"usState": "<string>",
"isSameMailingAddress": true
}
'import requests
url = "https://api.example.com/v1/auth/register/address"
payload = {
"onboardingId": "<string>",
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"zip": "<string>",
"usState": "<string>",
"isSameMailingAddress": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
onboardingId: '<string>',
addressLine1: '<string>',
addressLine2: '<string>',
city: '<string>',
zip: '<string>',
usState: '<string>',
isSameMailingAddress: true
})
};
fetch('https://api.example.com/v1/auth/register/address', 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.example.com/v1/auth/register/address",
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([
'onboardingId' => '<string>',
'addressLine1' => '<string>',
'addressLine2' => '<string>',
'city' => '<string>',
'zip' => '<string>',
'usState' => '<string>',
'isSameMailingAddress' => true
]),
CURLOPT_HTTPHEADER => [
"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.example.com/v1/auth/register/address"
payload := strings.NewReader("{\n \"onboardingId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"usState\": \"<string>\",\n \"isSameMailingAddress\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/v1/auth/register/address")
.header("Content-Type", "application/json")
.body("{\n \"onboardingId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"usState\": \"<string>\",\n \"isSameMailingAddress\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/auth/register/address")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"onboardingId\": \"<string>\",\n \"addressLine1\": \"<string>\",\n \"addressLine2\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"usState\": \"<string>\",\n \"isSameMailingAddress\": true\n}"
response = http.request(request)
puts response.read_body{
"accessToken": "<string>",
"onboardingId": "<string>",
"user": {}
}Overview
Submit user’s physical residential address. This is required for KYC verification and compliance purposes. For US residents, you can optionally specify a separate mailing address. For non-US residents, mailing address must be the same as physical address.Request
Body
string
required
Onboarding ID from previous step
string
required
Primary address lineExample:
23 Werrington Bridge Rdstring
Secondary address line (optional)Example:
Milking Nookstring
required
City nameExample:
Peterboroughstring
required
Postal/ZIP codeExample:
PE6 7PPstring
US state postal abbreviationRequired only if:
countryOfResidence = USExample: CAboolean
required
Whether mailing address is same as physicalMust be true unless:
countryOfResidence = USExample: trueResponse
string
Access token (only if registration complete)Returned when
isSameMailingAddress = true OR non-US residentExample: US_100a99cf-f4d3-4fa1-c321-2e9833440ebbstring
Updated onboarding ID
object
Updated user object with address
Code Examples
const response = await fetch('https://dev.api.baanx.com/v1/auth/register/address', {
method: 'POST',
headers: {
'x-client-key': 'your-client-key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
onboardingId: sessionStorage.getItem('onboardingId'),
addressLine1: '23 Werrington Bridge Rd',
addressLine2: 'Milking Nook',
city: 'Peterborough',
zip: 'PE6 7PP',
isSameMailingAddress: true
})
});
const { accessToken, user } = await response.json();
if (accessToken) {
// Registration complete
localStorage.setItem('access_token', accessToken);
console.log('Registration complete!');
} else {
// US resident - need mailing address
console.log('Proceed to mailing address step');
}
If
accessToken is returned, registration is complete. Otherwise, proceed to mailing address step (US only).Next Steps
Update Mailing Address
Add mailing address (US residents only)
Was this page helpful?
⌘I