Enroll a Merchant

This endpoint enables you to simultaneously create a merchant, registration, and user record in a single request, associating them together.

Response Data

Returns a compound JSON response containing merchant record, registration data, user record, ephemeral bearer token, and action summary.

Single Request

Create and associate multiple records simultaneously, streamlining the merchant enrollment process.

Key Features

Existing User Handling

If the specified user email already exists, the system will:

Associate the existing user record
Ignore the remaining user fields in the request
Throw an error if the email is associated with a Stax Connect level user (ephemeral tokens cannot be generated for such users)

Self-Registration Field Permissions

Simplify the self-registration process with automatic field management:

Automatic Field Hiding:

Set "hide_prefilled_fields": true in your payload
Fields passed with the enroll route will be hidden from the user during self-registration

Manual Control:

Use the field_permissions object within the registration parameter
Manually control which fields are visible or required during registration

Response Structure

The API returns a comprehensive response object containing:

merchant: Complete merchant record with all associated data
registration: Registration data and configuration settings
user: User record (newly created or existing associated user)
token: Ephemeral bearer token for immediate SSO into the platform
message: Summary of all actions taken during the enrollment process

Next Steps

Continue Integration

Use the returned merchant.id, registration.id, or user.id to perform additional actions, such as uploading supporting documentation or configuring additional merchant settings.