Skip to main content
GET
/
credential
/
{credentialId}
Get Credential
curl --request GET \
  --url https://api.example.com/credential/{credentialId}
{
  "id": "urn:via:credential:550e8400-e29b-41d4-a716-446655440000",
  "resourceType": "DOCUMENT",
  "status": "DRAFT",
  "w3cCredential": {
    "@context": [
      "https://www.w3.org/ns/credentials/v2",
      "https://via.humanos.dev/ns/v1"
    ],
    "id": "did:web:humanos.techcredential:uuid",
    "type": [
      "VerifiableCredential",
      "VIAMandate"
    ],
    "issuer": "did:web:humanos.tech",
    "validFrom": "2025-01-01T00:00:00Z",
    "validUntil": null,
    "credentialSubject": {
      "id": "did:web:humanostech:issuer-uuid",
      "mandate": {
        "grantor": [
          "did:web:humanos:contact:"
        ],
        "scope": "humanos.credential.request",
        "context": {
          "authorizedDIDs": [
            "did:web:humanos.tech:issuer-uuid",
            "did:web:humanos.tech:agent:uuid"
          ]
        }
      }
    },
    "evidences": [
      {
        "id": "did:web:humanos.tech::evidence:uuid",
        "digestSRI": "sha256-abc123",
        "location": "https://api.humanos.dev/evidences/did:web:humanos.tech::evidence:uuid"
      }
    ],
    "proofs": [
      {
        "type": "DataIntegrityProof",
        "cryptosuite": "eddsa-jcs-2022",
        "verificationMethod": "did:web:humanos.tech:platform:550e8400-e29b-41d4-a716-446655440000#key-1",
        "created": "2026-05-02T10:15:30.000Z",
        "proofPurpose": "assertionMethod",
        "proofValue": "z2pcVdSdoMTrkYP9rVdz..."
      }
    ]
  },
  "name": "Credential Name",
  "description": "Document to be requested on onboarding",
  "internalId": "internal-12345",
  "tags": [
    "<string>"
  ],
  "decisions": [
    {
      "id": "urn:via:decision:550e8400-e29b-41d4-a716-446655440001",
      "contact": "grantor@example.com",
      "accepted": true,
      "decidedAt": "2025-06-01T12:00:00.000Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://humanos.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
API-Version
string

Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today's date.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-03-03"

Path Parameters

​
credentialId
string
required

Identifier of the credential

Example:

"urn:via:credential:550e8400-e29b-41d4-a716-446655440000"

Response

​
id
string
required
Example:

"urn:via:credential:550e8400-e29b-41d4-a716-446655440000"

​
resourceType
string
required

The type of resource for this credential (e.g., DOCUMENT, CONSENT, FORM)

Example:

"DOCUMENT"

​
status
enum<string>
required

The status of the credential

Available options:
DRAFT,
ACTIVE,
REJECTED,
CANCELED,
REVOKED,
EXPIRED
Example:

"DRAFT"

​
w3cCredential
object
required

The W3C Verifiable Credential following the VIA protocol specification.

While the credential is in DRAFT status, this object is in building mode: evidences, proofs, and other fields may still be attached or modified as grantors review and decide. The proofs array will be empty at this stage.

Once all grantors have accepted (or the request window expires), the status transitions out of DRAFT and cryptographic signature proofs are attached. At that point the credential is fully sealed and can be passed for verification as defined by the VIA protocol.

Example:
{
  "@context": [
    "https://www.w3.org/ns/credentials/v2",
    "https://via.humanos.dev/ns/v1"
  ],
  "id": "did:web:humanos.techcredential:uuid",
  "type": ["VerifiableCredential", "VIAMandate"],
  "issuer": "did:web:humanos.tech",
  "validFrom": "2025-01-01T00:00:00Z",
  "validUntil": null,
  "credentialSubject": {
    "id": "did:web:humanostech:issuer-uuid",
    "mandate": {
      "grantor": ["did:web:humanos:contact:"],
      "scope": "humanos.credential.request",
      "context": {
        "authorizedDIDs": [
          "did:web:humanos.tech:issuer-uuid",
          "did:web:humanos.tech:agent:uuid"
        ]
      }
    }
  },
  "evidences": [
    {
      "id": "did:web:humanos.tech::evidence:uuid",
      "digestSRI": "sha256-abc123",
      "location": "https://api.humanos.dev/evidences/did:web:humanos.tech::evidence:uuid"
    }
  ],
  "proofs": [
    {
      "type": "DataIntegrityProof",
      "cryptosuite": "eddsa-jcs-2022",
      "verificationMethod": "did:web:humanos.tech:platform:550e8400-e29b-41d4-a716-446655440000#key-1",
      "created": "2026-05-02T10:15:30.000Z",
      "proofPurpose": "assertionMethod",
      "proofValue": "z2pcVdSdoMTrkYP9rVdz..."
    }
  ]
}
​
name
string
Example:

"Credential Name"

​
description
string
Example:

"Document to be requested on onboarding"

​
internalId
string

Identifier to help you identify the credential in your own system. We recommend using a unique value.

Example:

"internal-12345"

​
tags
string[]
​
decisions
array[]

Whether each grantor accepted or rejected the credential and information about the grantor contact. The id field carries the decision URN.

Example:
[
  {
    "id": "urn:via:decision:550e8400-e29b-41d4-a716-446655440001",
    "contact": "grantor@example.com",
    "accepted": true,
    "decidedAt": "2025-06-01T12:00:00.000Z"
  }
]