Register a regulatory evidence bundle (RPT-016) for a check
POST /api/v1/reports/rpt-016
POST https://api.trustverify.co.uk/api/v1/reports/rpt-016
Registers a ZIP evidence bundle for an existing check. includeTypes may only name report types this API produces for that check type (see GET /api/v1/reports/{reportType}/{checkId}); anything else is rejected with 400 and unavailableTypes, so a registered bundle can never promise a document the archive will not contain. Omit includeTypes to get the report for the check's own type (a kyc check → ["RPT-001"]).
Request body#
| Field | Type | Description |
|---|---|---|
| checkIdrequired | string | An existing check id from a previous /api/v1 call |
| includeTypes | array of string | Report types to render into the ZIP. Defaults to the report for the check's own type. |
| regulatorRef | string |
Example request#
curl -sS -X POST 'https://api.trustverify.co.uk/api/v1/reports/rpt-016' \
-H "Authorization: Bearer $TRUSTVERIFY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"checkId": "chk_123",
"includeTypes": [
"RPT-001"
]
}'Responses#
202 Bundle registered — poll the returned downloadUrl. includeTypes echoes what the ZIP will contain.
| Field | Type | Description |
|---|---|---|
| bundleIdrequired | string | |
| checkIdrequired | string | |
| statusrequired | string: "generating" | |
| includeTypesrequired | array of string | |
| regulatorRefrequired | string,null | |
| estimatedReadyAtrequired | string | |
| downloadUrlrequired | string |
400 checkId missing, or includeTypes names a report type this API cannot produce for this check
| Field | Type | Description |
|---|---|---|
| errorrequired | string: "validation_failed" | |
| coderequired | string: "UNSUPPORTED_REPORT_TYPES" | "NO_REPORTS_FOR_CHECK_TYPE" | "EMPTY_INCLUDE_TYPES" | |
| messagerequired | string | |
| unavailableTypes | array of object | |
| unavailableTypes[].typerequired | string | |
| unavailableTypes[].reasonrequired | string | |
| supportedTypesrequired | array of string |