Update onboarding progress

POST

/onboarding/progress

const url = 'https://apisandbox.puurk.com/onboarding/progress';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"status":"pending","actions_completed":{"additionalProperty":"2026-04-15T12:00:00Z"},"required_actions_pending":["merchant_account_active"],"optional_actions_pending":["merchant_account_active"]}'
};

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

curl --request POST \
  --url https://apisandbox.puurk.com/onboarding/progress \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "pending", "actions_completed": { "additionalProperty": "2026-04-15T12:00:00Z" }, "required_actions_pending": [ "merchant_account_active" ], "optional_actions_pending": [ "merchant_account_active" ] }'

Update onboarding progress for a provider

Authorizations

firebase

Request Body^required

Onboarding progress update

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>

Responses

200

Progress updated

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>

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

400

Invalid input

401

Unauthorized

Update onboarding progress

Authorizations

Request Bodyrequired

Responses

200

Example

400

401

Request Body^required