Skip to main content
GET
/
request
/
{requestId}
Get Detail
curl --request GET \
  --url https://api.example.com/request/{requestId}
{
  "id": "507f1f77bcf86cd799439011",
  "securityLevel": "CONTACT",
  "createdAt": "2025-01-15T10:30:00Z",
  "subjects": [
    {
      "contacts": [
        {
          "id": "<string>",
          "contact": "<string>"
        }
      ],
      "identityStatus": "HUMANOS",
      "organization": {
        "contacts": [
          "[email protected]",
          "+351912345678"
        ]
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "contact": "[email protected]",
      "internalId": "internal-12345",
      "id": "did:web:humanos.tech:user:013a0628-fd20-4f73-a7d0-785e9f6e79c1",
      "kyc": "PENDING"
    }
  ],
  "credentials": [
    {
      "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": "[email protected]",
          "accepted": true,
          "decidedAt": "2025-06-01T12:00:00.000Z"
        }
      ]
    }
  ],
  "name": "Employee Onboarding Request",
  "language": "ENG",
  "redirectUrl": "https://example.com/callback",
  "internalId": "order-123",
  "canceledAt": "2025-01-16T08:00:00Z"
}

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

​
requestId
string
required

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

Example:

"507f1f77bcf86cd799439011"

Response

Returns complete information including W3C Verifiable Credentials, subjects, 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"

​
createdAt
string<date-time>
required

Date and time of the request creation

Example:

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

​
subjects
object[]
required

List of subjects with organization data

​
credentials
object[]
required

List of credentials created in this request

​
name
string | null

Name of the credential request

Example:

"Employee Onboarding Request"

​
language
string | null

Language to be sent both in the otp and displayed in the link to the user

Example:

"ENG"

​
redirectUrl
string | null

URL to redirect the subject after completing the request

Example:

"https://example.com/callback"

​
internalId
string | null

Internal identifier for the request

Example:

"order-123"

​
canceledAt
string<date-time> | null

Date and time the request was canceled, null if active

Example:

"2025-01-16T08:00:00Z"