Sign Up Flow
Purpose of This Endpoint
This endpoint provides the onboarding flow tree up to the email entry step. It does not return the full tree of all possible onboarding steps, but only the structure needed until the user reaches the stage where they must enter their email (the first form step).
Each node in the returned structure contains:
key – unique identifier (library code or step ID).
title – headline for display.
description – optional additional text.
icon – optional icon (can be provided as a name to map to frontend assets or as a direct image URL).
type – defines how the step should be rendered:
choice → selection screen (children represent options).
form → registration form step (meta includes user_type and available methods).
info → informational screen (meta includes structured content).
next_step_type – the type of the following step (choice, form, info, or null).
meta – additional data depending on the type:
For form: includes methods (e.g. social, email) and user_type.
For info: includes at least title and intro_content; may also contain warning_content and conclusion_content.
children – nested steps leading to the next stage.
Frontend Rendering Logic
Start screen
Render using data.title and data.description.
Next step handling
If the selected path leads to a form → this is where the onboarding flow stops in this endpoint (the email entry step).
If the path leads to another choice → render its children.
If the path leads to an info → render a modal/page with HTML content from meta.
⚠️ Important note:
This endpoint is designed to guide the user only until they reach the email input stage. The actual registration form submission and any further steps beyond that are handled by other endpoints.
Endpoint
GET /api/v1/signup/onboarding
Request Headers
{
"X-API-Key": "your_tenant_api_key",
"Content-Type": "application/json"
}
Request Body
{}
Expected Response
{
"success": true,
"message": "Data retrieved successfully",
"data": {
"title": "Which Best Describes You?",
"description": "<p><b>Trainer or Professional</b></p><p>I'm a service dog trainer, doctor, therapist, support professional, or caregiver helping a handler.</p><p><b>Handler or Supporter</b></p><p>I have a service dog, I’m training one for myself, I’m in the process of getting one, or I’m a friend or family member helping someone who is.</p>",
"next_step_type": "choice",
"children": [
{
"key": "trainer_professional",
"title": "Trainer or Professional",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "choice",
"meta": [],
"children": [
{
"key": "2",
"title": "Are you a Trainer or Professional Caregiver? ",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "choice",
"meta": [],
"children": [
{
"key": "trainer",
"title": "I'm a Service Dog Trainer",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "form",
"meta": [],
"children": [
{
"key": "4",
"title": "Sign up Form",
"description": null,
"icon": null,
"type": "form",
"next_step_type": null,
"meta": {
"methods": [
"social",
"email"
],
"user_type": "trainer"
}
}
]
},
{
"key": "caregiver",
"title": "I’m a Professional Caregiver",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "form",
"meta": [],
"children": [
{
"key": "6",
"title": "Sign up Form",
"description": null,
"icon": null,
"type": "form",
"next_step_type": null,
"meta": {
"methods": [
"social",
"email"
],
"user_type": "caregiver"
}
}
]
}
]
}
]
},
{
"key": "handler_supporter",
"title": "Handler or Supporter",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "choice",
"meta": [],
"children": [
{
"key": "8",
"title": "Are you a Handler, Friend or Family Member",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "choice",
"meta": [],
"children": [
{
"key": "handler",
"title": "I'm a Handler",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "choice",
"meta": [],
"children": [
{
"key": "10",
"title": "What type of animal are you registering?",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "choice",
"meta": [],
"children": [
{
"key": "service_dog",
"title": "Service dog",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "form",
"meta": [],
"children": [
{
"key": "12",
"title": "Sign up Form",
"description": null,
"icon": null,
"type": "form",
"next_step_type": null,
"meta": {
"methods": [
"social",
"email"
],
"user_type": "handler"
}
}
]
},
{
"key": "emotional_support",
"title": "Emotional support animal",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "info",
"meta": [],
"children": [
{
"key": "14",
"title": "Emotional Support Animals",
"description": null,
"icon": null,
"type": "info",
"next_step_type": null,
"meta": {
"title": "Emotional Support Animals",
"intro_content": " <h1>\n Emotional Support Animals (ESAs) are an important type of working dog—but they are not Service Dogs\n </h1>\n\n <p>\n ESAs provide comfort through their presence. They are not required to be trained to do tasks related to a disability.\n Because of that, they are not allowed in public places like stores, restaurants, or transportation under the Americans\n with Disabilities Act (ADA).\n </p>\n\n <p><b>But they are recognized under a different law:</b></p>\n <p>The Fair Housing Act (FHA). This means you may have the right to live with an ESA in no-pet housing.</p>\n\n <p><b>To qualify:</b></p>\n <p>\n A licensed mental health professional must confirm that your ESA helps with a mental or emotional health need.\n </p>\n",
"warning_content": "<p>Valid letters must come from a local licensed mental health professional</b> with whom you have a real\n therapeutic relationship — not just from a website or a paid letter.</p>",
"conclusion_content": "<p>Landlords can ask for documentation, but you don't need to share your diagnosis.</p>\n <ul>\n <li>Service Dogs help one person by performing trained tasks related to their medical condition.</li>\n <li>Emotional Support Animals (ESAs) provide comfort through their presence but are not trained to do specific tasks.</li>\n <li>Therapy Dogs provide emotional support to others in group settings like hospitals, schools, and nursing homes.</li>\n </ul>\n "
}
}
]
},
{
"key": "therapy_dog",
"title": "Therapy dog",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "info",
"meta": [],
"children": [
{
"key": "16",
"title": "Therapy Dogs",
"description": null,
"icon": null,
"type": "info",
"next_step_type": null,
"meta": {
"title": "Therapy Dogs",
"intro_content": "\n <h1>\n Therapy Dogs are an important kind of working dog—but they are not Service Dogs\n </h1>\n\n <ul>\n <li><b>Therapy Dogs are trained to support others.</b> They visit places like hospitals, schools, or care facilities to bring comfort to groups of people.</li>\n <li><b>They don’t work for a single person</b> like Service Dogs do, and they are not protected under the Americans with Disabilities Act (ADA).</li>\n <li><b>Therapy Dogs do not have public access rights.</b> They can’t go into restaurants, stores, or public transportation—unless specifically invited by the facility.</li>\n <li><b>There are no official certifications or registrations required.</b> Each facility can set its own expectations for how Therapy Dogs behave and what kind of training they need.</li>\n </ul>\n ",
"warning_content": "\n <p>Some handlers train their Service Dog to also do Therapy Dog work.</p>\n <p>This is a personal choice—but it’s not always a good idea.</p>\n ",
"conclusion_content": "\n <ul>\n <li>Service Dogs are trained to focus on their handler.</li>\n <li>Therapy Dogs are trained to focus on other people.</li>\n <li>That difference can be confusing for the dog and might cause stress.</li>\n </ul>\n\n <p><b>We don’t recommend it—but we trust handlers to decide what’s best for their own team.</b></p>\n\n <ul>\n <li><b>Service Dogs</b> help one person by performing trained tasks related to their medical condition.</li>\n <li><b>Emotional Support Animals (ESAs)</b> provide comfort through their presence but are not trained to do specific tasks.</li>\n <li><b>Therapy Dogs</b> provide emotional support to others in group settings like hospitals, schools, and nursing homes.</li>\n </ul>\n "
}
}
]
}
]
}
]
},
{
"key": "family",
"title": "I'm a Friend or Family Member",
"description": null,
"icon": null,
"type": "choice",
"next_step_type": "form",
"meta": [],
"children": [
{
"key": "18",
"title": "Sign up Form",
"description": null,
"icon": null,
"type": "form",
"next_step_type": null,
"meta": {
"methods": [
"social",
"email"
],
"user_type": "family"
}
}
]
}
]
}
]
}
]
}
}
22 September 2025