Get Detail

Retrieve detailed information about a specific credential request. This includes complete W3C Verifiable Credential data for each credential, subject information, agent details (if applicable), and issuer information. The credentials returned are in W3C-compliant format and can be cryptographically verified. Only non-canceled requests belonging to your organization are returned.

GET /v1/request/{requestId}

Get Detail

cURL

curl --request GET \
  --url https://api.example.com/v1/request/{requestId}

200

{
  "id": "507f1f77bcf86cd799439011",
  "createdAt": "2025-01-15T10:30:00Z",
  "securityLevel": "CONTACT",
  "credentials": [
    {
      "id": "507f1f77bcf86cd799439011",
      "data": {
        "@context": [
          "https://www.w3.org/ns/credentials/v2"
        ],
        "id": "https://example.com/credentials/123",
        "type": [
          "VerifiableCredential"
        ],
        "credentialSubject": {
          "id": "did:via:humanos:user-123",
          "name": "John Doe"
        },
        "issuer": "did:via:humanos:issuer-123",
        "issuanceDate": "2025-01-15T10:30:00Z",
        "expirationDate": "2026-01-15T10:30:00Z",
        "validFrom": "2025-01-15T10:30:00Z",
        "validUntil": "2026-01-15T10:30:00Z",
        "proof": [
          {
            "proofValue": "z6Mk..."
          }
        ],
        "name": "<string>",
        "resourceType": "<string>",
        "status": "PENDING",
        "required": true
      },
      "internalId": "internal-credential-123",
      "name": "Identity Document",
      "resourceType": "document"
    }
  ],
  "subjects": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "John Doe",
      "did": "did:via:humanos:user-123",
      "contact": "[e-mail]"
    }
  ],
  "issuer": {
    "id": "507f1f77bcf86cd799439013",
    "did": {
      "id": "507f1f77bcf86cd799439014",
      "did": "did:via:humanos:issuer-123",
      "active": true,
      "revoked": false,
      "keys": [
        {
          "publicKeyMultibase": "z6Mk..."
        }
      ]
    },
    "name": "Acme Corporation"
  },
  "name": "Employee Onboarding Request",
  "agent": {
    "id": "507f1f77bcf86cd799439011",
    "did": {
      "id": "507f1f77bcf86cd799439012",
      "did": "did:via:humanos:agent-123",
      "active": true,
      "revoked": false,
      "keys": [
        {
          "publicKeyMultibase": "z6Mk..."
        }
      ]
    },
    "name": "Travel Assistant Agent",
    "description": "AI assistant for travel bookings",
    "apiKey": {
      "key": "ak_abc123xyz",
      "name": "Travel Agent API Key"
    }
  }
}

Path Parameters

requestId · string · required

Unique identifier of the credential request. Must be a valid MongoDB ObjectId.

Example:

"507f1f77bcf86cd799439011"

Response

200

application/json

Successfully retrieved credential request details. Returns complete information including W3C Verifiable Credentials, subjects, agent (if applicable), and issuer details.

id · string · required

Unique identifier for the credential request

Example:

"507f1f77bcf86cd799439011"

createdAt · string<date-time> · required

Date and time when the request was created

Example:

"2025-01-15T10:30:00Z"

securityLevel · enum<string> · required

Security level required for this request

Available options: CONTACT, ORGANIZATION_KYC, HUMANOS_KYC, HUMANOS_REVALIDATION

Example:

"CONTACT"

credentials · object[] · required

List of credentials included in this request. Each credential contains W3C Verifiable Credential data that can be cryptographically verified.

Show child attributes

subjects · object[] · required

List of subjects (users) associated with this request. Each subject represents a user who will receive credentials.

Show child attributes

issuer · object · required

Issuer information (your organization) that created this request

Show child attributes

name · string | null

Name of the credential request

Example:

"Employee Onboarding Request"

agent · object

Agent information if this request was created by an agent. Null if created directly by the organization.

Show child attributes