Get onboarding status

GET

/onboarding/status

const url = 'https://apisandbox.puurk.com/onboarding/status';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://apisandbox.puurk.com/onboarding/status \
  --header 'Authorization: Bearer <token>'

Returns the current onboarding status

Authorizations

firebase

Responses

200

Successful operation

application/json

object

status

Status of onboarding

string

Allowed values: pending in_progress completed

actions_completed

Map of completed actions to completion dates

object

key

additional properties

string format: date-time

required_actions_pending

Required actions not yet completed

Array<string>

Allowed values: merchant_account_active business_profile_complete agreement_signed user_created user_linked sales_tax_set tips_setting_set credits_added services_added products_added packages_added clients_added contract_signed offer_created template_offer_created offer_accepted payment_made

optional_actions_pending

Optional actions not yet completed

Array<string>

Example

{
  "status": "pending",
  "required_actions_pending": [
    "merchant_account_active"
  ],
  "optional_actions_pending": [
    "merchant_account_active"
  ]
}

401

Unauthorized