Skip to main content
GET
/
request
List Requests
curl --request GET \
  --url https://api.example.com/request
{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "securityLevel": "CONTACT",
      "subjects": [
        {
          "contact": "user@example.com",
          "identityStatus": "HUMANOS",
          "id": "did:web:humanos.tech:user:013a0628-fd20-4f73-a7d0-785e9f6e79c1",
          "internalId": "internal-12345",
          "kyc": "PENDING"
        }
      ],
      "credentials": [
        {
          "id": "urn:via:credential:550e8400-e29b-41d4-a716-446655440000",
          "resourceType": "DOCUMENT",
          "status": "DRAFT",
          "name": "Credential Name",
          "description": "Document to be requested on onboarding",
          "internalId": "internal-12345"
        }
      ],
      "createdAt": "2025-01-15T10:30:00Z",
      "name": "Employee Onboarding Request",
      "language": "ENG",
      "redirectUrl": "https://example.com/callback",
      "internalId": "order-123",
      "canceledAt": "2025-01-16T08:00:00Z"
    }
  ],
  "totalPages": 5
}

Documentation Index

Fetch the complete documentation index at: https://docs.humanos.id/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"

Query Parameters

​
pageIndex
number
default:0

Page number

Example:

0

​
pageSize
number
default:10

Number of items per page

Required range: 5 <= x <= 100
Example:

10

​
search
string

Search query to filter by. Is case-insensitive and does not need to match the entire value.

Maximum string length: 100
Example:

"example"

​
subject
string

Filter by subject (nested object with contact, id, or internalId).

Example:

"user@example.com"

​
internalId
string

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

Example:

"internal-12345"

​
securityLevel
enum<string>[]

Filter by security level. Can be a single value or array

Available options:
CONTACT,
ORGANIZATION_KYC,
HUMANOS_KYC,
HUMANOS_REVALIDATION
Example:
["CONTACT", "ORGANIZATION_KYC"]
​
dateFrom
string<date-time>

Filter from date (will be converted to start of day)

Example:

"2025-01-01"

​
dateTo
string<date-time>

Filter to date (will be converted to end of day). Requires dateFrom.

Example:

"2025-12-31"

Response

200 - application/json
​
data
object[]
required

Array of your credential requests matching the query parameters

​
totalPages
number
required

Total number of pages available based on the page size and total count

Example:

5