HYBRID-CHAINDEVELOPERS
DOCUMENTATIONv2
GET

Trust & identity

List credentials

/api/v2/trust/credentials
AUTHENTICATIONBearer token · trust:readAUTHORITATIVE OWNERidentity-serviceCONTRACT AUTHORITYGenerated Rust OpenAPISTATUSSource ready · production listed

PURPOSE + BUSINESS CONTEXT

List identity and verification credentials visible to the subject.

WHEN THIS CALL IS USEFUL

Discover the subject's credential portfolio and reconcile lifecycle, issuer proof posture, and commitments before selecting one for a relying workflow.

OUTCOME · Discover

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

  • Gives people and agents a contract-backed way to discover credentials.
  • 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.
  • Use the live OpenAPI schema as the authority for the exact request shape and response model.
  • Resolve the applicable purpose, policy version, consent or role basis, and required assurance before relying on this result.

WHAT TO DO NEXT

  • Select one canonical identifier from the response and open its detail operation when the live contract exposes one.
  • 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 credentials only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Use the live OpenAPI schema as the authority for the exact request shape and response model.
  • Treat policy availability, consent, evidence capture, completed checks, review, decision, credential issuance, validity, and relying-party acceptance as separate facts.
  • Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.
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 the trust:read scope.EXAMPLEBearer hc_live_…

cursorqueryOptional

opaque stringnext_cursor from the preceding page; valid only for the same subject and filter set.EXAMPLEpage-two

limitqueryOptional

integer · 1–200 · default 50Maximum credentials to return.EXAMPLE50

statusqueryOptional

uppercase lifecycle state · 2–32Exact canonical credential lifecycle filter.EXAMPLEVALID

qqueryOptional

string · max 200, no control charactersCase-insensitive search term.EXAMPLEage

RESPONSES

Status and payload examples

200Cursor page of subject-owned credentials and commitment-level proof posture.Read completed · JSON RESPONSE+
{
  "items": [
    {
      "credential_id": "ffffffffffffffffffffffffffffffff",
      "credential_type": "IDENTITY_ATTESTATION",
      "issuer": "did:web:id.hybrid-chain.com",
      "status": "VALID",
      "valid_from": "2026-09-01T00:00:00Z",
      "valid_until": "2027-09-01T00:00:00Z",
      "updated_at": "2026-09-01T00:00:00Z",
      "proof_type": "HybridZkKnownDataProof2026",
      "issuer_signature_valid": true,
      "commitments": [
        {
          "key": "age_over_18",
          "commitment": "dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd",
          "encoding": "Hybrid-Chain-ZK-v1/NFC/TRIM/SHA-256",
          "proof_type": "HybridZkKnownDataProof2026",
          "value_type": "BOOLEAN",
          "assurance_level": "HC-IAL2",
          "verification_status": "VERIFIED"
        }
      ]
    }
  ],
  "next_cursor": null
}
INTEGRATION DECISION
CALLER ACTION
Accept the returned representation or receipt, then select one canonical identifier from the response and open its detail operation when the live contract exposes one.
RETRY SAFETY
For another page, send the returned opaque cursor unchanged with the same filters. Restart without a cursor when a new snapshot is required.
STATE RECONCILIATION
Use returned identifiers and versions as the comparison point for later reads. Refresh the subject, claim or credential version, issuer and reviewer authority, evidence commitment, decision, expiry, and revocation status.
422limit, status, q, or cursor is outside the published contract.Request must change · JSON RESPONSE+
{
  "code": "invalid_credential_query",
  "message": "limit, status, q, or cursor is outside the published contract."
}
INTEGRATION DECISIONinvalid_credential_query
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. A corrected read may be sent as a new attempt.
STATE RECONCILIATION
Compare the submitted values with the documented constraints before another call. 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.
401The bearer credential is missing or invalid.Authentication required · JSON RESPONSE+
{
  "code": "invalid_credentials",
  "message": "The bearer credential is missing or 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. Do not replay an expired signature.
STATE RECONCILIATION
Authentication failed before an authoritative read was returned for subject-scoped trust claims, evidence, credentials, reviews, decisions, presentations, and revocations.
ESCALATE WHEN
Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.
403The credential lacks exact trust:read authority.Authority or policy denied · JSON RESPONSE+
{
  "code": "insufficient_scope",
  "message": "The credential lacks exact trust:read authority."
}
INTEGRATION DECISIONinsufficient_scope
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 subject-scoped trust claims, evidence, credentials, reviews, decisions, presentations, and revocations.
ESCALATE WHEN
Escalate when subject binding, evidence minimization, issuer or reviewer authority, decision lineage, expiry, or revocation cannot be established.
503The authoritative Identity trust service is unavailable.Dependency unavailable or outcome uncertain · JSON RESPONSE+
{
  "code": "identity_unavailable",
  "message": "The authoritative Identity trust service is unavailable."
}
INTEGRATION DECISIONidentity_unavailable
CALLER ACTION
Treat the failure as transient and preserve the last known good representation without presenting it as fresh.
RETRY SAFETY
Retry with bounded exponential backoff and jitter; stop after the integration's failure budget is exhausted.
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

  • Continue only with next_cursor and preserve the same filters; never synthesize, decode, or reuse a cursor across subjects.
  • VALID alone is insufficient. Confirm the validity window, issuer signature posture, proof type, assurance, verification status, and relying policy immediately before use.
  • Credential issuance and revocation remain non-executable planning contracts. A readable credential grants no disclosure, payment, transfer, trading, or administrative authority. Responses are no-store.
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