---
updatedAt: 2026-09-11T20:23:47.000Z
agentTools:
  projectIndex: https://docs.staxpayments.com/llms.txt
---

# API Merchant Enrollment

Learn how to implement streamlined merchant enrollment using Stax's Hybrid API approach, combining automated enrollment with pre-built signup components for optimal integration.

# Getting Started with Hybrid API Enrollment

If you're using the **Full API Enrollment** or **Hybrid API Enrollment**, continue reading. For the **White-Glove Enrollment** option, please refer to the [Stax Connect documentation](/docs/white-glove-enrollment).

By combining the Stax Enrollment API with our pre-built Signup Application, the **Hybrid API Enrollment** flow allows you to quickly implement a streamlined merchant enrollment process. This approach offers the benefits of automation without the need to develop the entire solution within your app.

## Enrollment Process Overview

<Tabs>
  <Tab title="Step 1: Enroll Merchant">
    **POST /admin/enroll**
    
    - Simultaneously create a merchant, registration, and user record
    - Receive an ephemeral bearer token to facilitate SSO into the platform
  </Tab>
  <Tab title="Step 2: Single Sign-On">
    **Utilize SSO Integration**
    
    - Redirect merchants to the Stax Signup Application
    - Allow merchants to complete their application securely
    - Leverage pre-built UI components for a seamless experience
  </Tab>
</Tabs>

## API Reference Guide

Use these endpoints to implement and manage your merchant enrollment workflow:

<Cards columns="2">
  <Card title="Enroll a Merchant" href="/reference/enroll-a-merchant" icon="fa-user-plus">
    Initialize the merchant enrollment process and create all necessary records.
  </Card>
  <Card title="Update Registration Data" href="/reference/update-merchant-registration-data" icon="fa-edit">
    Modify merchant information during the registration process.
  </Card>
  <Card title="Add Documentation" href="/reference/add-file-to-merchant-registration" icon="fa-file-upload">
    Upload supporting documents required for merchant approval.
  </Card>
  <Card title="Monitor Status" href="/reference/get-merchant-registration-data" icon="fa-chart-line">
    Track the underwriting and approval status of merchant applications.
  </Card>
  <Card title="Terms & Conditions" href="/reference/retrieve-terms-and-conditions" icon="fa-file-contract">
    Retrieve the latest terms and conditions for merchant agreements.
  </Card>
</Cards>

## Testing & Development

<Accordion title="Testing Merchant Enrollment" icon="fa-flask">
  **Important Testing Considerations:**

  - **API Limitations**: Underwriting fields cannot be changed via the API directly
  - **Test Mode**: Use Stax Connect Test Mode to simulate different application and merchant statuses during testing
  - **Partnership Support**: Contact your partnership resource for more information on testing the merchant enrollment flow

  **Testing Best Practices:**
  - Test various merchant scenarios (approvals, rejections, pending states)
  - Validate SSO token functionality and expiration
  - Ensure proper error handling for failed enrollment attempts
  - Test document upload functionality with various file types
</Accordion>