Skip to content

Complete Onboarding

POST
/api/onboard/complete
curl --request POST \
--url https://example.com/api/onboard/complete \
--header 'Authorization: Bearer <token>'

Atomically creates the Member, PaymentMethod and Subscription, marks the invitation as Used, and returns the new identifiers. The onboarding JWT is no longer useful after this call — the portal should clear the cookie.

Member created.

Media type application/json
object
outcome
string
Allowed values: Ok InvitationNotFound InvitationNotEditable Incomplete PlanNoLongerAvailable
memberId
string format: uuid
nullable
subscriptionId
string format: uuid
nullable
missingField
string
nullable
Example
{
"outcome": "Ok"
}

Some required draft fields are still missing.

Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Example generated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Invitation is no longer in the Redeemed state.

Media type application/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Example generated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}