API reference/Platform foundation/Identity

GETLive

Current principal

Returns the authenticated user, token kind, granted scopes, and canonical-profile readiness.

/v1/me

Authorization

Credential

oauth_user_or_client

Required scopes

profile:read

Implementation note

Call this first. `profileReadiness` reports whether the canonical profile can generate artifacts: `{ "status": "ready"|"partial"|"empty", "missingRequired": [...], "suggestedOptional": [...], "remediation": [...] }`. Each entry in `remediation` maps one missing/suggested slug to the concrete action that satisfies it — `{ "item", "requirement", "method", "endpoint", "tool", "field" }` (e.g. `summary` → `PATCH /v1/profile`, tool `profile_update`, field `summary`) — so no guessing which endpoint clears a gap. When status is not `ready`, onboard the user (see `import-create`) before job commands — `job-tailor`, `artifacts-generate`, `job-match`, and `job-gap-analysis` fail with `profile_incomplete` until the required fields exist.

Error responses

401Authentication required

No valid credentials were supplied. Attach a Bearer access token and retry.

402Upgrade required

The authenticated user's plan does not include this capability. `feature` names the gated capability, `requiredPlan` the cheapest plan that unlocks it, `currentPlan` the user's plan today, and `upgradeUrl` links to checkout. This is a plan gate, not a transient error — retrying without upgrading fails again; surface `upgradeUrl` to the user instead. Dormant until a plan that grants the feature is active, so a route that documents it may not currently return it.

403Insufficient scope

The token is valid but lacks the OAuth scope (or token kind) this endpoint requires.