curl --request GET \
--url https://api.example.com/requestimport requests
url = "https://api.example.com/request"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/request', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/request"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/request")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "507f1f77bcf86cd799439011",
"securityLevel": "CONTACT",
"subjects": [
{
"contact": "user@example.com",
"identityStatus": "HUMANOS",
"id": "did:web:humanos.tech:user:73ebefdd-a549-4873-aad9-def80c40c8c8",
"internalId": "internal-12345",
"kyc": "PENDING",
"secondaryContact": "+351912345678"
}
],
"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
}{
"statusCode": 400,
"message": "dateFrom is required when dateTo is provided",
"error": "Bad Request"
}List Requests
Retrieve a paginated list of your credential requests
Each request includes information about the request, credentials, subjects (users) and chosen security level
Optional query parameters filter the results: search (matches request or credential name), dateFrom/dateTo (creation-date range), subject (by contact, id, or internalId), internalId, and securityLevel
Use pageIndex and pageSize to page through the results
curl --request GET \
--url https://api.example.com/requestimport requests
url = "https://api.example.com/request"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/request', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/request"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/request")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "507f1f77bcf86cd799439011",
"securityLevel": "CONTACT",
"subjects": [
{
"contact": "user@example.com",
"identityStatus": "HUMANOS",
"id": "did:web:humanos.tech:user:73ebefdd-a549-4873-aad9-def80c40c8c8",
"internalId": "internal-12345",
"kyc": "PENDING",
"secondaryContact": "+351912345678"
}
],
"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
}{
"statusCode": 400,
"message": "dateFrom is required when dateTo is provided",
"error": "Bad Request"
}Headers
Pin request, response, and webhook shapes to a specific dated API version (YYYY-MM-DD). Omit to use the version pinned to your API key (set when the key is created; new keys default to the latest version). New integrations should target the latest version.
^\d{4}-\d{2}-\d{2}$"2026-09-01"
Query Parameters
Zero-based page index. 0 returns the first page.
0
Number of items per page
5 <= x <= 10010
Search query to filter by. Is case-insensitive and does not need to match the entire value.
100"example"
Filter from date (will be converted to start of day in UTC)
"2025-01-01"
Filter to date (will be converted to end of day in UTC). Requires dateFrom.
"2025-12-31"
Filter by subject (nested object with contact, id, or internalId).
"user@example.com"
Identifier to help you identify the request in your own system. We recommend using a unique value.
"internal-12345"
Filter by security level. Can be a single value or array
CONTACT, ORGANIZATION_KYC, HUMANOS_KYC, HUMANOS_REVALIDATION ["CONTACT", "ORGANIZATION_KYC"]
Response
Returns a paginated list of credential requests plus the total number of pages available.