Get consumer onboarding status and requirements
LogsGET /onboarding
Returns the signed-in person's onboarding record: profile, notification consent, accepted terms, the list of requirements still to complete, the computed status and the current terms version. Clients use it to decide which onboarding steps to show.
Returns
200 Consumer onboarding
Show attributes
statusone of
not_started,in_progress,completeprofilenotification_consenttermsrequirementsShow child attributes
currently_dueeventually_duepast_duepending_verificationerrorsShow child attributes
requirementcodeone of
information_requested,document_rejectedreason
current_terms_version
curl -X GET "$CONSUMER_API/onboarding" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$CONSUMER_API/onboarding", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$CONSUMER_API/onboarding",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$CONSUMER_API/onboarding", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"status": "not_started",
"profile": {},
"notification_consent": true,
"terms": {},
"requirements": {
"currently_due": [
"currently due"
],
"eventually_due": [
"eventually due"
],
"past_due": [
"past due"
],
"pending_verification": [
"pending verification"
],
"errors": [
{
"requirement": "requirement",
"code": "information_requested",
"reason": "Leitura confirmada no local."
}
]
},
"current_terms_version": "current terms version"
}