Skip to navigation
API ReferenceAccount

Complete Onboarding

View as Markdown

The first-run wizard, submitted in one go.

Marking the account onboarded is what stops the dashboard showing the wizard again. It is set even when the seller skipped most of the fields — a wizard that reappears because someone declined to answer is a wizard they will learn to dismiss.

Authentication

X-API-Keystring

Your Outprice API key (starts with pw_).

Request

This endpoint expects an object.
countrystring or nullOptional
currencystring or nullOptional
business_namestring or nullOptional
productslist of stringsOptional
own_pricesmap from strings to doublesOptional

Response

Successful Response
account_idinteger
account_namestring
plan_tierstring
countrystring
currencystring
account_uidstring or nullOptional
user_uidstring or nullOptional
emailstring or nullOptional
onboardedbooleanOptionalDefaults to false
has_verified_targetbooleanOptionalDefaults to false

Errors

422
Unprocessable Entity Error