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 are returned in W3C-compliant format and can be cryptographically verified

GET /request/{requestId}

Get Detail

cURL

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

200

{
  "id": "507f1f77bcf86cd799439011",
  "securityLevel": "CONTACT",
  "subjects": [
    {
      "contact": "[e-mail]",
      "did": "did:via:humanos:user-abc123",
      "internalId": "internal-12345",
      "name": "John Doe"
    }
  ],
  "createdAt": "2025-01-15T10:30:00Z",
  "credentials": [
    {
      "id": "507f1f77bcf86cd799439011",
      "resourceType": "DOCUMENT",
      "status": "PENDING",
      "proofs": [
        "<array>"
      ],
      "data": [
        {
          "label": "Consent statement",
          "type": "string",
          "value": "I consent to the terms and conditions",
          "hidden": false,
          "fields": [
            {}
          ]
        }
      ],
      "name": "Identity Document",
      "internalId": "internal-12345"
    }
  ],
  "issuer": {
    "did": "did:via:humanos:issuer-abc123",
    "name": "Acme Corporation"
  },
  "name": "Employee Onboarding Request",
  "agent": {
    "did": "did:via:humanos:agent-abc123",
    "name": "Travel Assistant Agent"
  }
}

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

requestId · string · required

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

Example:

"507f1f77bcf86cd799439011"

Response

200

application/json

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

id · string · required

Unique identifier for the request

Example:

"507f1f77bcf86cd799439011"

securityLevel · enum<string> · required

Identity level required for all subjects in this request

Available options: CONTACT, ORGANIZATION_KYC, HUMANOS_KYC, HUMANOS_REVALIDATION

Example:

"CONTACT"

subjects · SubjectEntity · object[] · required

List of subjects (users) associated with this request (minified: name, did, contact)

Show child attributes

createdAt · string<date-time> · required

Date and time of the request creation

Example:

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

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

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