Retrieves the registration data used by our underwriting team during onboarding.
Overview
This endpoint retrieves the registration data used by our underwriting team during onboarding, providing real-time insights into merchant status and approval processes.
Key Features
Monitor application approval status with detailed substatus information and underwriting notes.
Track merchant account activation status to determine payment processing eligibility.
Support for merchants who can start processing while requirements are pending.
Status Monitoring Details
Underwriting Status Monitoring
Primary Status Field
underwriting_status: Indicates the status of the merchant's application.
null: No decision has been made yetAPPROVED: The application has been approvedPENDED: The application is pending further information or actionREJECTED: The application has been rejected
Additional Status Information
underwriting_substatuses: An array containing objects that provide detailed reasons for the underwriting status. Useful for understanding specific requirements or issues.
underwriting_note: A human-readable note from Stax's underwriting team, informing the merchant of any additional documents or information needed to approve the application for payment processing.
Integration Notes
- Use these fields to understand the real-time status of a merchant
- See our Underwriting Overview for more details about the underwriting process
- Webhooks: Listen for
update_underwritingevents when these fields change
Account Status Monitoring
Conditional Approval
Overview
Applicable for Partners with Conditional Approval Enabled
Conditional Approval allows merchants to begin processing payments while certain requirements remain pending (e.g., missing banking information).
Key Points
- Funds may be held until the merchant fulfills the remaining requirements for full approval
- If
underwriting_statusis "APPROVED" and there are entries inunderwriting_substatuses, the account is conditionally approved - This enables faster merchant onboarding while maintaining compliance requirements
Implementation Tips
Use webhook events to stay up to date on status changes without polling the API constantly.
Check both underwriting_status and account_status to determine full merchant readiness.
IMPORTANT: When testing merchant enrollment, note that underwriting fields cannot be changed directly via the API; however, Stax Connect Test Mode can be used by our partner developers to simulate different application and merchant statuses. Talk to your partnership resource for more information on testing the merchant enrollment flow.