First-run onboarding status.

GET

/v1/account/onboarding

curl --request GET \
  --url https://api.share2.us/v1/account/onboarding \
  --header 'Authorization: Bearer <token>'

• Production API
• Local API

Whether the user has completed onboarding and still needs to accept the current terms version.

Authorizations

• bearerAuth
• deviceAuth

Responses

200

Onboarding status.

Media typeapplication/json

object

onboarded

boolean

consent_required

boolean

consent_version

string

Example^generated

{
  "onboarded": true,
  "consent_required": true,
  "consent_version": "example"
}

default

Standard error envelope.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "quota_exceeded"
  }
}