v1

latestOpenAPI 3.1.02026-08-042784116.2 KB

Create Hosted Signup Session

Provides a URL for directing a user through the hosted signup experience. Upon successful completion the user will be redirected to the callback_url. The returned legal entity id will not be active until the user has completed their signup. If a subsequent signup needs to be generated for a user the returned legal_entity_id from the first should be included in the request.

post/accounts/signup/sessions

Query parameters

verboseboolean

Headers

authorizationstring nullable

Request body

business_namestring required
user_emailstring required
callback_urlstring required
legal_entity_idstring nullable
external_company_idstring nullable

Response

Successful Response

signup_urlstring required

This is a deprecated field, please use url

urlstring required

This is a session scoped URL which allows users to completed the signup process.

created_atstring required
expires_atstring required
legal_entity_idstring required