Get Onboarding Details
curl --request GET \
--url https://dev.api.baanx.com/v1/auth/register \
--header 'x-client-key: <x-client-key>'import requests
url = "https://dev.api.baanx.com/v1/auth/register"
headers = {"x-client-key": "<x-client-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-client-key': '<x-client-key>'}};
fetch('https://dev.api.baanx.com/v1/auth/register', 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://dev.api.baanx.com/v1/auth/register",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-client-key: <x-client-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://dev.api.baanx.com/v1/auth/register"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-client-key", "<x-client-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dev.api.baanx.com/v1/auth/register")
.header("x-client-key", "<x-client-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.api.baanx.com/v1/auth/register")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-client-key"] = '<x-client-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"email": "<string>",
"firstName": {},
"lastName": {},
"phoneNumber": {},
"verificationState": "<string>",
"addressLine1": {},
"city": {},
"countryOfResidence": "<string>"
}Authentication
Get Onboarding Details
Retrieve user onboarding details and current registration status
GET
/
v1
/
auth
/
register
Get Onboarding Details
curl --request GET \
--url https://dev.api.baanx.com/v1/auth/register \
--header 'x-client-key: <x-client-key>'import requests
url = "https://dev.api.baanx.com/v1/auth/register"
headers = {"x-client-key": "<x-client-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-client-key': '<x-client-key>'}};
fetch('https://dev.api.baanx.com/v1/auth/register', 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://dev.api.baanx.com/v1/auth/register",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-client-key: <x-client-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://dev.api.baanx.com/v1/auth/register"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-client-key", "<x-client-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dev.api.baanx.com/v1/auth/register")
.header("x-client-key", "<x-client-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.api.baanx.com/v1/auth/register")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-client-key"] = '<x-client-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"email": "<string>",
"firstName": {},
"lastName": {},
"phoneNumber": {},
"verificationState": "<string>",
"addressLine1": {},
"city": {},
"countryOfResidence": "<string>"
}Overview
Fetch user onboarding information by onboarding ID. This endpoint is useful for:- Checking current onboarding status
- Retrieving partially completed registration data
- Resuming an interrupted registration flow
- Verifying what information has been submitted
Request
Query Parameters
string
required
Onboarding ID from email verification stepFormat: UUIDExample:
100a99cf-f4d3-4fa1-9be9-2e9828b20ebbHeaders
string
required
Client API key for environment routingFormat: UUID string
This endpoint does not require authentication. It allows checking onboarding status during the registration process before a user account is fully created.
Response
Returns complete onboarding record with all submitted information:string
Onboarding ID
string
User’s email address
string | null
First name (null if not yet submitted)
string | null
Last name (null if not yet submitted)
string | null
Phone number (null if not verified)
string
KYC verification statusValues:
UNVERIFIED | PENDING | VERIFIED | REJECTEDstring | null
Primary address (null if not submitted)
string | null
City (null if not submitted)
string
Country of residence ISO code
Code Examples
curl -X GET "https://dev.api.baanx.com/v1/auth/register?onboardingId=100a99cf-f4d3-4fa1-9be9-2e9828b20ebb" \
-H "x-client-key: your-client-key"
async function getOnboardingStatus(onboardingId) {
const response = await fetch(
`https://dev.api.baanx.com/v1/auth/register?onboardingId=${onboardingId}`,
{
headers: {
'x-client-key': 'your-client-key'
}
}
);
const onboarding = await response.json();
// Determine next step based on what's missing
if (!onboarding.phoneNumber) {
return 'PHONE_VERIFICATION';
} else if (!onboarding.firstName) {
return 'PERSONAL_DETAILS';
} else if (!onboarding.addressLine1) {
return 'ADDRESS';
} else {
return 'COMPLETE';
}
}
Use Cases
Resume Interrupted Registration
async function resumeRegistration() {
const onboardingId = sessionStorage.getItem('onboardingId');
const onboarding = await getOnboardingStatus(onboardingId);
// Route to appropriate step
if (!onboarding.phoneNumber) {
navigateTo('/register/phone');
} else if (!onboarding.firstName) {
navigateTo('/register/personal-details');
} else if (!onboarding.addressLine1) {
navigateTo('/register/address');
}
}
Was this page helpful?