Onboarding Context

GET

/api/onboard/context

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

Returns the merchant info, an optional pre-filled email, public plans, and any draft state already saved by the wizard. The wizard uses this to restore its state when a user comes back.

Authorizations

• Bearer

Responses

200

Context loaded.

Media type application/json

object

invitationId

string format: uuid

status

string

Allowed values: Pending Redeemed Used Expired Revoked

expiresAt

string format: date-time

email

string

nullable

merchant

object

id

string format: uuid

name

string

nullable

description

string

nullable

country

string

nullable

products

Array<object>

nullable

object

id

string format: uuid

name

string

nullable

description

string

nullable

plans

Array<object>

nullable

object

id

string format: uuid

name

string

nullable

description

string

nullable

price

number format: double

setupFee

number format: double

nullable

frequency

string

Allowed values: OneOff Daily Weekly Fortnightly Monthly Quarterly Yearly

trialDays

integer format: int32

minimumContractMonths

integer format: int32

nullable

cancellationFee

number format: double

nullable

questions

Array<object>

nullable

object

id

string format: uuid

order

integer format: int32

label

string

nullable

helpText

string

nullable

type

string

Allowed values: FreeText SingleChoice MultipleChoice

isRequired

boolean

maxLength

integer format: int32

nullable

options

Array<object>

nullable

object

id

string format: uuid

order

integer format: int32

value

string

nullable

label

string

nullable

draft

object

firstName

string

nullable

lastName

string

nullable

phone

string

nullable

addressLine1

string

nullable

city

string

nullable

state

string

nullable

postCode

string

nullable

country

string

nullable

selectedPlanId

string format: uuid

nullable

payment

object

type

string

Allowed values: Card BankAccount

brand

string

nullable

last4

string

nullable

expiryMonth

integer format: int32

nullable

expiryYear

integer format: int32

nullable

accountName

string

nullable

bsb

string

nullable

answers

object

key

additional properties

object

textValue

string

nullable

optionIds

Array<string>

nullable

Example

{
  "status": "Pending",
  "products": [
    {
      "plans": [
        {
          "frequency": "OneOff"
        }
      ],
      "questions": [
        {
          "type": "FreeText"
        }
      ]
    }
  ],
  "draft": {
    "payment": {
      "type": "Card"
    }
  }
}

401

Missing or non-onboarding-scoped token.

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"
}

404

Invitation backing the token no longer exists.

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"
}