Skip to main content
GET
Get Onboarding by ID
This endpoint allows you to fetch detailed onboarding information using a specific onboarding ID. This is typically used when tracking onboarding processes or when you need to retrieve onboarding details from a stored reference.

Path Parameters

string
required
The unique identifier of the onboarding record to retrieve

Response

string
The unique identifier for this onboarding record
string
The store ID associated with this onboarding
string
The company ID that owns the store
string
Current status of the onboarding process
Common statuses: “pending”, “in_progress”, “completed”, “failed”
string
When the onboarding process was initiated (ISO 8601 format)
string
When the onboarding record was last updated
string
When the onboarding process was completed (null if not completed)
object
Status breakdown for each delivery platform
array
Array of completed onboarding steps

Response Example

Use Cases

use-case
Monitor the progress of ongoing onboarding processes
Check status periodically during onboarding to track progress
use-case
Investigate onboarding issues or failures
Step-by-step status helps identify where problems occurred
use-case
Maintain records of when stores were onboarded and activated
Useful for compliance and business analytics
use-case
Synchronize onboarding status with external systems
Ensure external systems reflect current onboarding state

Error Scenarios

error
The specified onboarding_id doesn’t existStatus Code: 404Solution: Verify the onboarding ID or check if onboarding was initiated
error
User doesn’t have permission to view this onboarding recordStatus Code: 403Solution: Ensure user has appropriate permissions for the associated company
error
Onboarding record exists but data is inconsistentStatus Code: 500Solution: Contact support for data recovery
Real-time Data: Onboarding information is updated in real-time as processes complete, providing accurate current status.
Data Retention: Onboarding records are preserved for audit and troubleshooting purposes, even after completion.