Retrieve Onboarding Status
Retrieve the current onboarding status for a merchant (lightweight endpoint)
Overview
Retrieves the current onboarding status for a merchant using the onboarding reference number. This is a lightweight endpoint that returns only essential status information without the full onboarding data.Authentication
This endpoint requires JWT Bearer Token authentication.Path Parameters
"550e8400-e29b-41d4-a716-446655440000"referenceNumber returned when you successfully submit an onboarding request via the Onboard Merchant endpoint.Response
Success Response
Status Code:200 OK
NEW: Merchant completed onboarding, awaiting initial approvalPENDING: Merchant updated form after decline, awaiting re-approvalAPPROVED: Merchant has been approvedDECLINED: Merchant was declined and needs to update their form
"NEW""550e8400-e29b-41d4-a716-446655440000""Acme Store""2024-01-15T10:30:00Z""2024-01-20T14:45:00Z"ApprovedAt, DeclinedAt, or PendingAt. Returns null if no status change has occurred (still in NEW status)."Missing required documents: SEC Registration Certificate"onboardingStatus is DECLINED. Set to null for other statuses.Response Examples
Error Responses
400 Bad Request - Invalid Reference Number Format
400 Bad Request - Invalid Reference Number Format
400400 Bad Request - Record Does Not Exist
400 Bad Request - Record Does Not Exist
400- The authenticated user has no associated business account
- The business account has no associated business record
- The onboarding record was deleted
400 Bad Request - Reference Number Mismatch
400 Bad Request - Reference Number Mismatch
400401 Unauthorized
401 Unauthorized
Status Flow Diagram
The onboarding status follows this flow:NEW
DECLINED (Optional)
declinedReason field contains the reason for rejection. Merchant needs to update their information.PENDING (Optional)
Polling Best Practices
Implement Smart Polling
Implement Smart Polling
Exponential Backoff
Exponential Backoff
Cache Status Results
Cache Status Results
Stop Polling on Terminal Status
Stop Polling on Terminal Status
Use Cases
Dashboard Status Widget
Automated Polling
Conditional UI Updates
Notification Triggers
Status Comparison Table
| Status | Is Approved? | Is Declined? | Is Pending? | Description |
|---|---|---|---|---|
NEW | ❌ | ❌ | ❌ | Merchant completed onboarding, awaiting initial review |
PENDING | ❌ | ✅ (was) | ✅ | Merchant updated form after decline, awaiting re-approval |
APPROVED | ✅ | ❌ | ❌ | Merchant has been approved |
DECLINED | ❌ | ✅ | ❌ | Merchant was declined, needs to update form |
When to Use This Endpoint
- Use This Endpoint
- Use Full Data Endpoint
- Polling for status changes
- Dashboard status displays
- Quick status checks
- Determining if full data fetch is needed
- Triggering status-based workflows
- Mobile applications (reduced bandwidth)
Troubleshooting
Reference Number Mismatch
Reference Number Mismatch
Onboarding reference number mismatchCause: Trying to access an onboarding record that doesn’t belong to your accountSolution:- Verify you’re using the correct JWT token
- Each onboarding record can only be accessed by the account that created it
- Ensure you’re not mixing sandbox and production reference numbers
Polling Never Completes
Polling Never Completes
- Onboarding awaiting manual admin approval
- Application is in review queue
- Additional documentation may be required
- Implement maximum polling attempts (recommended: 30-60 minutes)
- Contact support if status hasn’t changed after reasonable time
- Check for any notifications or emails from the approval team
Declined Reason Not Showing
Declined Reason Not Showing
declinedReason is null even though status is DECLINEDPossible Causes:- Admin declined without providing a reason (rare)
- Data synchronization issue
- Fetch full onboarding data using Retrieve Onboarding Data
- Contact support for clarification
Next Steps
Retrieve Full Data
Onboard Merchant
Create Account
Authentication Guide
Authorizations
JWT Bearer token authentication
Path Parameters
The onboarding reference number (UUID v4 format)
Response
Onboarding status retrieved successfully
Current status of the merchant's onboarding application
NEW, PENDING, APPROVED, DECLINED Unique identifier for the onboarding record
Trading name or DBA name of the merchant
Timestamp when the onboarding record was created
Timestamp of the most recent status change
Reason provided when declining the application (only present when status is DECLINED)