Update Mailing Address

curl --request POST \
  --url https://api.example.com/v1/auth/register/mailing-address \
  --header 'Content-Type: application/json' \
  --data '
{
  "onboardingId": "<string>",
  "addressLine1": "<string>",
  "addressLine2": "<string>",
  "city": "<string>",
  "zip": "<string>",
  "usState": "<string>"
}
'

import requests

url = "https://api.example.com/v1/auth/register/mailing-address"

payload = {
    "onboardingId": "<string>",
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "usState": "<string>"
}
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>'
  })
};

fetch('https://api.example.com/v1/auth/register/mailing-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/mailing-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>'
  ]),
  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/mailing-address"

	payload := strings.NewReader("{\n  \"onboardingId\": \"<string>\",\n  \"addressLine1\": \"<string>\",\n  \"addressLine2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"usState\": \"<string>\"\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/mailing-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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/auth/register/mailing-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}"

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

{
  "accessToken": "<string>",
  "onboardingId": "<string>",
  "user": {}
}

POST

auth

mailing-address

Update Mailing Address

curl --request POST \
  --url https://api.example.com/v1/auth/register/mailing-address \
  --header 'Content-Type: application/json' \
  --data '
{
  "onboardingId": "<string>",
  "addressLine1": "<string>",
  "addressLine2": "<string>",
  "city": "<string>",
  "zip": "<string>",
  "usState": "<string>"
}
'

import requests

url = "https://api.example.com/v1/auth/register/mailing-address"

payload = {
    "onboardingId": "<string>",
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "zip": "<string>",
    "usState": "<string>"
}
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>'
  })
};

fetch('https://api.example.com/v1/auth/register/mailing-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/mailing-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>'
  ]),
  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/mailing-address"

	payload := strings.NewReader("{\n  \"onboardingId\": \"<string>\",\n  \"addressLine1\": \"<string>\",\n  \"addressLine2\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip\": \"<string>\",\n  \"usState\": \"<string>\"\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/mailing-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}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/auth/register/mailing-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}"

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

{
  "accessToken": "<string>",
  "onboardingId": "<string>",
  "user": {}
}

Overview

Submit mailing address for US residents. This is the final step in the registration process for US users who have a different mailing address than their physical address. After successful submission, an access token is returned and registration is complete.

This endpoint is only for US residents with different mailing addresses. Non-US residents complete registration at the physical address step.

Request

Body

string

required

Onboarding ID from previous step

string

required

Primary mailing address lineExample: 23 Werrington Bridge Rd

string

Secondary address line (optional)Example: Milking Nook

string

required

City nameExample: Peterborough

string

required

ZIP codeExample: PE6 7PP

string

required

US state postal abbreviationExample: CA

Response

string

Access token for authenticated API requestsRegistration is now completeExample: US_100a99cf-f4d3-4fa1-c321-2e9833440ebb

string

Final onboarding ID

object

Complete user object with all details

Code Examples

const response = await fetch('https://dev.api.baanx.com/v1/auth/register/mailing-address', {
  method: 'POST',
  headers: {
    'x-client-key': 'your-client-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    onboardingId: sessionStorage.getItem('onboardingId'),
    addressLine1: 'PO Box 123',
    city: 'New York',
    zip: '10001',
    usState: 'NY'
  })
});

const { accessToken, user } = await response.json();

// Registration complete!
localStorage.setItem('access_token', accessToken);
console.log('Registration complete!', user);

// Redirect to dashboard
window.location.href = '/dashboard';

After receiving the access token, store it securely and redirect the user to your main application.

Registration Complete

At this point, the user has completed all registration steps:

Email verification
Phone verification
Personal details
Physical address
Mailing address (US only)

The user can now access all authenticated endpoints using the access token.

Next Steps

Get User Profile

Fetch complete user profile

View Card Status

Access user’s card information

Overview

Authentication

User

Card

Orders

Wallet

Delegation

Consent

Referral

Webhooks

Update Mailing Address

Overview

Request

Body

Response

Code Examples

Registration Complete

Next Steps

Get User Profile

View Card Status

​Overview

​Request

​Body

​Response

​Code Examples

​Registration Complete

​Next Steps

Get User Profile

View Card Status

Overview

Request

Body

Response

Code Examples

Registration Complete

Next Steps