Verify token

Overview

Validate the supplied Passport bearer token and restore the SPA session. Return the authenticated user, their company, theme, white-label and (for account companies) plan context. Mirrors the login payload minus the freshly-issued token. It echoes the bearer token from the request.

Prerequisites

  • A bearer token. Callable with Partner and Account tokens.

Base URL

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://development-api.shoutaboutus.com

Endpoint

GET /api/v1/verify-token

Authentication

  • Requires a bearer token in the Authorization: Bearer <bearer-token> header.

  • Who can call it: Partner and Account tokens.

  • Authentication uses a Passport bearer token.

  • The target is always the authenticated user.

  • There is no partner/account-tree scoping.

  • The returned account's bundle_id reflects whichever role's token was supplied.

Rate limit

  • No rate limit.

Request

  • Header: Authorization: Bearer <bearer-token> (required).
  • No path params, query params, or body.

Response

  • data.token (string) — the same bearer token you sent, echoed back
  • data.user (object) — id, username, email, inactive_at (nullable), email_verified_at, phone_number, first_name, last_name, title, role (or "User"), total_location
  • data.company (object) — id, name, bundle_id, plus appended enable_insight_report (0/1), enable_competitive_analysis (0/1), dormant_accounts_enabled (0/1), companyindustry_id, company_industry (id/name), is_sub_partner (0/1), and company_option (company_id, who_will_pay, enable_generic_alert, enable_insight_report, enable_competitive_analysis)
  • data.theme_options (string) — JSON string
  • data.white_label (object) — logo, white_url, favicon, title, status, login_logo, company_id, email_templates_enabled
  • data.plan (object|null) — only when company.bundle_id == 3; same plan+features shape as login. Null otherwise.

401 "Unauthenticated." if the token is missing/invalid.

200 Success · 200

{
  "data": {
    "token": "<bearer-token>",
    "user": {
      "id": 8,
      "email": "[email protected]"
    },
    "company": {
      "id": 9,
      "name": "HiPages",
      "bundle_id": 1,
      "companyindustry_id": 7,
      "company_industry": { "id": 7, "name": "Trades & Services" },
      "is_sub_partner": 0
    },
    "theme_options": null,
    "white_label": {},
    "plan": null
  }
}

Errors

StatusMeaning
401Returned "Unauthenticated." if the token is missing/invalid
500Unexpected server error

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/verify-token" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'

Did this page help you?