Onboarding

Track onboarding progress for your account. Requires authentication.

Get onboarding status

GET /v1/onboarding/status

Returns the onboarding checklist step completion status. Steps vary by deployment mode.

Example

curl https://api.zyntem.dev/v1/onboarding/status \
  -H "Authorization: Bearer zyn_test_abc123def456..."

Response 200 OK

Hosted deployment:

{
  "deployment_mode": "hosted",
  "steps": [
    { "key": "create_account", "completed": true, "completed_at": "2026-03-01T10:00:00Z" },
    { "key": "get_test_api_key", "completed": true, "completed_at": "2026-03-01T10:01:00Z" },
    { "key": "read_quickstart", "completed": false },
    { "key": "create_location", "completed": false },
    { "key": "first_test_transaction", "completed": false },
    { "key": "explore_dashboard", "completed": false },
    { "key": "create_live_api_key", "completed": false }
  ]
}

On-premise deployment:

{
  "deployment_mode": "on_premise",
  "steps": [
    { "key": "purchase_license", "completed": true, "completed_at": "2026-03-01T10:00:00Z" },
    { "key": "download_agent", "completed": true, "completed_at": "2026-03-02T09:00:00Z" },
    { "key": "verify_agent", "completed": true, "completed_at": "2026-03-02T09:00:00Z" },
    { "key": "create_location", "completed": false },
    { "key": "first_test_transaction", "completed": false },
    { "key": "configure_country", "completed": false },
    { "key": "first_live_transaction", "completed": false }
  ]
}

Step object

Field	Type	Description
key	string	Step identifier
completed	boolean	Whether the step is complete
completed_at	datetime	When the step was completed (null if incomplete)