Simultaneously create a merchant, registration, and user record in a single request, associating them together.
This endpoint enables you to simultaneously create a merchant, registration, and user record in a single request, associating them together. It returns a compound JSON response containing:
merchant: Merchant recordregistration: Registration datauser: User record (created or associated)token: An ephemeral bearer token for immediate SSO into the platformmessage: A brief summary of the actions taken
Key Features:
Existing User Handling
If the specified user email already exists, it associates the user record and ignores the rest of the user fields. If the email is associated with a Stax Connect level user, the API will throw an error since you cannot generate ephemeral tokens for such users.
Self-Registration Field Permissions:
To simplify the self-registration process, you can automatically hide prefilled front-end fields by setting "hide_prefilled_fields": true in your payload.
Fields passed with the enroll route will be hidden from the user during the self-registration process.
Manually control field permissions using the field_permissions object within the registration parameter.
Next Steps:
Use the returned merchant.id, registration.id, or user.id to perform additional actions, such as uploading supporting documentation.