Sign in
latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

User APIs
auth

Initiate Signup

Start a new signup session.

  • Validates password / plan / subscription_period at the schema layer
  • Rejects emails already registered as real users
  • Stages an Okta user (activate=false) so Okta's password-policy checks surface synchronously
  • Creates a PendingSignup in DRAFT with the staged okta_user_id, issues a verification code, sends the verification email, and transitions to EMAIL_VERIFICATION_IN_PROGRESS.
post/api/v1/auth/signup/initiate

Headers

x-captcha-tokenstring required

Request body

emailstring email required
passwordstring required
first_namestring required

User's first/given name

last_namestring required

User's last/family name

company_namestring nullable

Optional company name to be used as the client name

selected_plan_idstring required

Plan ID: 'business' or 'professional'

subscription_periodstring required

Subscription billing period: 'monthly' or 'annual'

signup_tou_idstring required

UUID of the Terms of Use version accepted by the user

marketing_opt_inboolean
fbpstring nullable

Meta _fbp browser cookie

fbcstring nullable

Meta _fbc click ID cookie

marketing_consentboolean

Visitor granted the CMP's marketing category. Defaults to False so a caller that omits it sends no Meta CAPI event (PRO-3255).

Response

Successful Response

session_idstring required
emailstring required
statusstring required
capi_event_idstring nullable