DOCUMENTATIONv2

POST

User Profile Data

Reset password

/api/v2/password-resets

AUTHENTICATIONNone · publicAUTHORITATIVE OWNERidentity-profile · identity-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Apply the requested transition to reset password through the authoritative trust service boundary.

WHEN THIS CALL IS USEFUL

Use once with the delivered reset credential and a policy-compliant replacement password.

OUTCOME · Create or advance

What changes

Consumes the reset credential, replaces password verifiers, and revokes every active interactive session.

WHY IT MATTERS

Gives people and agents a contract-backed way to advance reset password.
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 token (body), new_password (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 reset password 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 reset password only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required token (body), new_password (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.

MACHINE CONTRACT

The exact deployed parameters, schemas, responses, security requirements, and Hybrid-Chain agent metadata are authoritative at this operation's production OpenAPI JSON Pointer. The readable tables below add integration guidance; the deployed OpenAPI controls if guidance and the machine contract ever differ.

Open the authoritative production contract ↗

EXTENDED INTEGRATION GUIDANCE

Readable request and response reference

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

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

tokenbodyRequired

one-time hcat_ credential30-minute password-reset token delivered out of band.

new_passwordbodyRequired

printable string · 12–128Replacement password subject to current strength policy.

REQUEST

JSON body example

{
  "token": "hcat_…",
  "new_password": "A-Different#Password2048"
}

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 account schema.

400invalid_security_requestThe account lifecycle request is invalid.

400missing_idempotency_keyA nonempty Idempotency-Key is required for this mutation.

401invalid_credentialsThe bearer, password, activation, or reset credential is invalid.

403step_up_requiredFresh purpose-bound authenticator verification is required.

404account_closure_not_foundThe account closure request was not found.

409security_conflictThe requested account transition conflicts with current security state.

409account_closure_conflictThe account closure transition conflicts with current lifecycle state.

503identity_security_unavailableThe authoritative Identity security service is temporarily unavailable.

RESPONSES

Status and payload examples

200Password replaced and sessions revoked.Mutation completed · JSON RESPONSE+

{
  "status": "PASSWORD_UPDATED",
  "sessions_revoked": true
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then re-read reset password 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 specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.

400The token shape or replacement password is invalid.Request must change · JSON RESPONSE+

{
  "code": "invalid_security_request",
  "message": "The token shape or replacement password is invalid."
}

INTEGRATION DECISIONinvalid_security_request

CALLER ACTION: Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY: Do not retry the same invalid request. This mutation has no documented idempotent replay contract. Reconcile state before considering another attempt.
STATE RECONCILIATION: Compare the submitted values with the documented constraints before another call. Refresh the specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

403The token is invalid, expired, or already consumed.Authority or policy denied · JSON RESPONSE+

{
  "code": "step_up_required",
  "message": "The token is invalid, expired, or already consumed."
}

INTEGRATION DECISIONstep_up_required

CALLER ACTION: Verify the exact scope, tenant or workspace membership, owner boundary, step-up purpose, feature policy, and resource eligibility. Never broaden authority automatically.
RETRY SAFETY: Do not retry until the missing authority or policy condition has been deliberately resolved with least privilege.
STATE RECONCILIATION: Confirm the caller and resource resolve to the same authority boundary for the authenticated profile, tenant brand, referral, funding, and account-lifecycle projections.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

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

{
  "code": "identity_security_unavailable",
  "message": "Identity is unavailable."
}

INTEGRATION DECISIONidentity_security_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 specific profile or account projection and compare tenant, profile, lifecycle, and version identifiers before retrying.
ESCALATE WHEN: Escalate when a fresh session resolves to an unexpected tenant or profile, or when an account lifecycle receipt cannot be found after reconciliation.

OPERATIONAL NOTES

Security and lifecycle guarantees

Every existing interactive session is invalid after success; require a new login on every device.
Do not retry an ambiguous result with another password. Attempt a fresh login or begin a new reset transaction.

UPGRADING FROM V1

Legacy calls replaced by this operation

If you maintain an older integration, use this map to find the V2 replacement. Do not translate the old request field-for-field: rebuild it from the V2 parameters and schemas above because identity, authorization, replay protection, and response semantics may have changed.

POST/api/v1/profile/newpasswordPROFILE: Reset Password

DOCUMENTATION STATUS

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-09-11T06:35:11.572Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation ↗Return to the V2 directory ↗