HYBRID-CHAINDEVELOPERS
DOCUMENTATIONv2
PATCH

User Profile Data

Update current profile

/api/v2/me
AUTHENTICATIONBearer token · profile:writeAUTHORITATIVE OWNERidentity-profileCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

Update allowlisted current-profile fields through the authoritative Identity profile service.

WHEN THIS CALL IS USEFUL

Call this when an identity, compliance, relying-party, or trust agent workflow needs to apply the documented current profile 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 · Revise and reconcile

What changes

Updates only the allowlisted current profile fields and version accepted by the authoritative owner; it grants no adjacent authority.

WHY IT MATTERS

  • Gives people and agents a contract-backed way to advance current profile.
  • 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

  • Authenticate at the documented boundary: bearer+scope.
  • Supply the required request (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 current profile 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 current profile only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Supply the required request (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
AuthorizationheaderRequired

Bearer tokenCredential containing profile:write authority.EXAMPLEBearer hc_live_…

X-Request-IDheaderOptional

stringOptional caller correlation identifier. The gateway emits the effective value on the response.

namesbodyOptional

string | ProfileNamesUpdatenames accepted by this operation. Omit it when the corresponding optional behavior is not needed.

preferencesbodyOptional

string | ProfilePreferencesUpdatepreferences accepted by this operation. Omit it when the corresponding optional behavior is not needed.

REQUEST

JSON body example

{
  "names": "example-names",
  "preferences": "example-preferences"
}

RESPONSES

Status and payload examples

200Mutation accepted and canonical state returned.Mutation completed · JSON RESPONSE+
{
  "account_type": "example-account-type",
  "activated": true,
  "client_id": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "created_at": "2026-09-02T18:30:00Z",
  "display_name": "example-display-name",
  "email": "[email protected]",
  "metadata": "example-metadata",
  "names": {
    "company_name": "example-company-name",
    "first_name": "example-first-name",
    "last_name": "example-last-name",
    "middle_name": "example-middle-name"
  },
  "phone": "example-phone",
  "preferences": {
    "base_currency": "USD",
    "language": "example-language",
    "locale": "example-locale",
    "theme": "example-theme",
    "timezone": "example-timezone"
  },
  "profile_uuid": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "scopes": [
    "example-scope"
  ],
  "subject": "example-subject",
  "tenant_uuid": "01K4A7M4N8Y2Q6R9T3V5W7X1ZB",
  "two_factor_enabled": true,
  "username": "example-username"
}
INTEGRATION DECISION
CALLER ACTION
Accept the returned representation or receipt, then re-read current profile 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.
400Unknown or invalid editable fieldRequest must change · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
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.
401Bearer credential is missing, expired, or invalid.Authentication required · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
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 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.
503The authoritative service or read model is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "the supplied Hybrid credential is invalid"
}
INTEGRATION DECISIONinvalid_credentials
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

  • Update allowlisted current-profile fields through the authoritative Identity profile service. Authoritative owner: identity-profile.
  • The Rust gateway validates the public contract and routes only to the authoritative owner; clients never address internal services directly.
  • The tables and examples are derived from the current gateway source OpenAPI. Re-fetch the deployed OpenAPI before execution; deployment status is shown separately on this page.
  • Only parameters present in the OpenAPI operation are accepted; undocumented query keys fail closed with HTTP 422.

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/personaldataPROFILE: Submit Profile Data
POST/api/v1/profile/metadataPROFILE: Submit Meta Data
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 ↗