ReferenceApi
Complete account onboarding
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
organizationName*string
organizationSlug?string
productRoles*array<>
invitationToken?string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/auth/onboarding" \ -H "Content-Type: application/json" \ -d '{ "organizationName": "string", "productRoles": [ "buyer" ] }'{ "session": { "authenticated": true, "subject": { "subjectId": "string", "organizationId": "string", "type": "user" }, "provider": "better-auth", "authMethods": { "emailPassword": true, "magicLink": true, "passkey": true, "wallet": true, "google": true, "github": true }, "user": { "userId": "string", "email": "user@example.com", "name": "string", "image": "string" }, "activeOrganization": { "organizationId": "string", "name": "string", "slug": "string", "membershipRole": "owner", "productRoles": [ "buyer" ] }, "organizations": [], "productRoles": [], "capabilities": [], "platformRoles": [ "user" ], "platformCapabilities": [], "onboardingRequired": false }}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string", "errors": [ { "detail": "string", "pointer": "string" } ]}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string"}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string"}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string"}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string"}{ "type": "about:blank", "title": "string", "status": 0, "detail": "string", "instance": "string", "requestId": "string", "code": "string"}