Get

Retrieve a paginated list of credential requests for your organization. You can filter requests by active status, search by name, filter by subject ID or agent ID, and paginate through results. Each request includes information about the credentials, subjects (users), security level, and creation date.

GET /v1/request

Get

cURL

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

200

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "securityLevel": "CONTACT",
      "createdAt": "2025-01-15T10:30:00Z",
      "credentials": [
        {
          "name": "Identity Document",
          "resourceType": "document"
        },
        {
          "name": "Consent Form",
          "resourceType": "consent"
        }
      ],
      "subjects": [
        {
          "id": "507f1f77bcf86cd799439011",
          "name": "John Doe",
          "did": "did:via:humanos:user-123",
          "contact": "[e-mail]"
        }
      ],
      "name": "Employee Onboarding Request"
    }
  ],
  "totalPages": 5
}

Query Parameters

pageIndex · number

Page number (0-indexed). Default is 0.

Example:

0

pageSize · number

Number of items per page. Minimum 5, maximum 100. Default is 20.

Required range: 5 <= x <= 100

Example:

20

active · boolean

Filter requests by active status. Accepts true/false as string or boolean.

Example:

true

search · string

Search query to filter requests by name. Case-insensitive partial match.

Example:

"onboarding"

subjectId · string

Filter requests by subject (user) ID. Must be a valid MongoDB ObjectId.

Example:

"507f1f77bcf86cd799439011"

agentId · string

Filter requests by agent ID. Must be a valid MongoDB ObjectId.

Example:

"507f1f77bcf86cd799439012"

securityLevel · enum<string>[]

Security level filter

Available options: CONTACT, ORGANIZATION_KYC, HUMANOS_KYC, HUMANOS_REVALIDATION

dateFrom · string<date-time>

Start date

dateTo · string<date-time>

End date

Response

200 - application/json

Successfully retrieved credential requests. Returns a paginated result with an array of credential request items and the total number of pages.

data · object[] · required

Array of credential requests matching the query parameters

Show child attributes

totalPages · number · required

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

Example:

5