POST

Identity sessions and federation

Refresh session

/api/v2/auth/session-refreshes

AUTHENTICATIONNone · publicService owneridentity-serviceContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

Rotate a single-use refresh credential and issue the next V2 credential pair.

When to use it

Call this when an identity, compliance, relying-party, or trust agent workflow needs to apply the documented refresh session transition after re-reading the current authoritative state so it can make a purpose-limited identity or assurance decision with current policy and lifecycle state.

OUTCOME · Create or advance

What changes

Creates or advances only the refresh session resource described by this contract after authorization, validation, policy, and idempotency gates pass.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance refresh session.
Separates subject identity, consent, evidence, provider output, review, issuer credentials, and relying-party acceptance instead of collapsing them into a universal trust score.

ISOLATION + AUTHORITY

Bearer subject, tenant, purpose, policy version, role, issuer, reviewer, provider, and relying-party boundaries remain distinct. The response or transition grants no payment, custody, settlement, publisher, matching, or trading authority and must not expose regulated evidence beyond the live schema.

BEFORE YOU CALL

No bearer credential is required; apply bounded filters and canonical public identifiers where the contract provides them.
Supply the required refresh_token (body) exactly as defined by the live contract.
Resolve the applicable purpose, policy version, consent or role basis, and required assurance before relying on this result.

WHAT TO DO NEXT

Re-read refresh session using the canonical identifier returned by this operation.
Reconcile an ambiguous response with the same idempotency key before attempting another mutation.
Use the returned lifecycle state and policy version to choose the next least-privilege trust action; do not infer a missing stage.

AGENT GUIDANCE

Use refresh session only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required refresh_token (body) exactly as defined by the live contract.
Treat policy availability, consent, evidence capture, completed checks, review, decision, credential issuance, validity, and relying-party acceptance as separate facts.
After a timeout or conflict, read authoritative state before deciding whether an equivalent retry is safe.

Contract reference

Use the deployed OpenAPI for exact parameters, schemas and security requirements. The tables below provide integration guidance.

Open this operation in OpenAPI

Request and response

Make the request

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

refresh_tokenbodyRequired

hcmr_ opaque credentialCurrent single-use refresh credential.

REQUEST

JSON body example

{
  "refresh_token": "hcmr_…"
}

STABLE ERROR CODES

Branch on the code, then follow the recovery action

These codes are published by the authoritative gateway contract for this endpoint. Treat message as safe diagnostic text; integrations should branch on code and HTTP status.

STATUSCODEMEANING

400invalid_jsonThe JSON body is malformed or fails the published identity-security schema.

400invalid_security_requestThe session, scope, public key, proof, or purpose-bound security request is invalid.

401invalid_credentialsThe bearer, client assertion, or proof-of-possession credential is invalid.

403step_up_requiredFresh purpose-bound authenticator verification or stronger authority is required.

404signing_key_not_foundThe requested signing-key or workload-client resource was not found.

409security_conflictThe requested identity-security transition conflicts with current state.

503identity_security_unavailableThe authoritative Identity security service is temporarily unavailable.

RESPONSES

Status and payload examples

200Replacement access and refresh credential pair.Mutation completed · JSON RESPONSE+

{
  "data": {
    "access_token": "hcm_…",
    "refresh_token": "hcmr_…",
    "token_type": "Bearer",
    "expires_in": 900,
    "refresh_expires_in": 2500000,
    "client_id": "client-01",
    "session_id": "9b51ed4c9c8f4aec85d1bd5520e40557",
    "scopes": [
      "profile:read"
    ]
  }
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read refresh session using the canonical identifier returned by this operation.
RETRY SAFETY: Do not repeat a successful mutation merely to confirm it. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt.
STATE RECONCILIATION: Persist returned identifiers, versions, commitments, and receipts. Refresh the subject, claim or credential version, issuer and reviewer authority, evidence commitment, decision, expiry, and revocation status.

401The refresh credential is invalid, expired, reused, or revoked.Authentication required · JSON RESPONSE+

{
  "code": "invalid_session_credential",
  "message": "The refresh credential is invalid, expired, reused, or revoked."
}

INTEGRATION DECISIONinvalid_session_credential

CALLER ACTION: Discard the rejected credential, complete the documented authentication or reassertion flow, and rebuild any request signature with fresh timestamps and nonces.
RETRY SAFETY: Retry only with a newly valid credential and fresh replay-protection values. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt.
STATE RECONCILIATION: Assume the outcome is unknown only when the connection failed after transmission; otherwise authentication failed before domain work. Refresh the subject, claim or credential version, issuer and reviewer authority, evidence commitment, decision, expiry, and revocation status.
ESCALATE WHEN: Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.

503Identity session management is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+

{
  "code": "identity_unavailable",
  "message": "Identity session management is unavailable."
}

INTEGRATION DECISIONidentity_unavailable

CALLER ACTION: Preserve the exact request and treat the outcome as uncertain until authoritative state proves whether it committed.
RETRY SAFETY: Reconcile before retrying. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt. Use bounded backoff with jitter.
STATE RECONCILIATION: Refresh the subject, claim or credential version, issuer and reviewer authority, evidence commitment, decision, expiry, and revocation status.
ESCALATE WHEN: Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.

OPERATIONAL NOTES

Security and lifecycle guarantees

A successful exchange invalidates the submitted refresh token before returning its replacement.
Responses carry Cache-Control: no-store and Pragma: no-cache.

Reference version and availability details

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-10-02T23:27:55.510Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation Return to the V2 directory