Checks
List reports
Scope: reports:read
Reports in your workspace, newest first, as summaries. Fetch a single report for its check results.
AuthorizationBearer <token>
Use Authorization: Bearer vrf_live_... or vrf_test_....
In: header
Query Parameters
page?integer
Zero-based page index.
Range
0 <= valueDefault
0size?integer
Items per page.
Range
1 <= value <= 200Default
20search?string
Free-text search. Supported fields vary by resource.
status?string
| Status | Meaning |
|---|---|
DRAFT | Created with draft: true. Nothing runs until launched. |
PENDING_CONSENT | Waiting for the subject to approve. |
PENDING_PAYMENT | Waiting for a candidate or third-party payment. |
RUNNING | Checks are executing. |
PARTIAL | Some checks have results and others do not. |
READY | Every check has finished. |
FAILED | The report could not complete. |
CANCELLED | Stopped before completion. |
Value in
- "DRAFT"
- "PENDING_CONSENT"
- "PENDING_PAYMENT"
- "RUNNING"
- "PARTIAL"
- "READY"
- "FAILED"
- "CANCELLED"
subjectType?string
Whether the subject is a person or a registered company. Each check declares which subject types it accepts.
Value in
- "INDIVIDUAL"
- "COMPANY"
from?string
Inclusive start date.
Format
dateto?string
Inclusive end date.
Format
dateResponse Body
application/json
curl -X GET "https://example.com/api/v1/reports"{ "page": 0, "size": 0, "totalElements": 0, "totalPages": 0, "first": true, "last": true, "content": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "subjectName": "string", "subjectType": "INDIVIDUAL", "status": "DRAFT", "riskScore": 0, "checksCount": 0, "completedChecksCount": 0, "createdAt": "2019-08-24T14:15:22Z" } ]}