Skip to main content
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>'
{
  "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

​
onboardingId
string
required
Onboarding ID from email verification stepFormat: UUIDExample: 100a99cf-f4d3-4fa1-9be9-2e9828b20ebb

​
Headers

​
x-client-key
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:
​
id
string
Onboarding ID
​
email
string
User’s email address
​
firstName
string | null
First name (null if not yet submitted)
​
lastName
string | null
Last name (null if not yet submitted)
​
phoneNumber
string | null
Phone number (null if not verified)
​
verificationState
string
KYC verification statusValues: UNVERIFIED | PENDING | VERIFIED | REJECTED
​
addressLine1
string | null
Primary address (null if not submitted)
​
city
string | null
City (null if not submitted)
​
countryOfResidence
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"

​
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');
  }
}