> For the complete documentation index, see [llms.txt](https://docs.vcheckglobal.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vcheckglobal.com/api-reference/background-check/background-check-reports.md).
# Background Check Reports
Retrieve full structured report data and download pre-signed PDF links.
## List Reports
> Retrieve a paginated list of report documents and supporting documents across all subjects\
> under your account. Results include a pre-signed download URL valid for 5 minutes,\
> expiry timestamp, and metadata.\
> \
> \*\*Pagination:\*\* Fixed 50 records per page. Pass \`?page=N\` to navigate. Stop when \`next\` is \`null\`.
```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Background Check Reports","description":"Retrieve full structured report data and download pre-signed PDF links."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/backgroundcheck/reports":{"get":{"tags":["Background Check Reports"],"operationId":"listBgcReports","summary":"List Reports","description":"Retrieve a paginated list of report documents and supporting documents across all subjects\nunder your account. Results include a pre-signed download URL valid for 5 minutes,\nexpiry timestamp, and metadata.\n\n**Pagination:** Fixed 50 records per page. Pass `?page=N` to navigate. Stop when `next` is `null`.\n","parameters":[{"name":"reference_id","in":"query","schema":{"type":"string"},"description":"Filter results to a specific subject by reference_id."},{"name":"file_type","in":"query","schema":{"type":"string","enum":["REPORTS","SUPPORT_DOCS"]},"description":"Filter by document type: REPORTS (background check reports only), SUPPORT_DOCS (supporting documents only). Omit to return both types."},{"name":"page","in":"query","required":false,"description":"Page number to retrieve (1-indexed, default: 1). Each page returns up to 50 records.","schema":{"type":"integer"}}],"responses":{"200":{"description":"Paginated list of report documents.","content":{"application/json":{}}},"400":{"description":"Bad request — invalid query parameter (e.g. unknown file_type value).","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"403":{"description":"Forbidden — the token's granted scopes do not include `api-platform/backgroundcheck-read` or `api-platform/backgroundcheck-read-write`.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"500":{"description":"Internal server error — an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}}}}}}}
```
## Download Report PDF
> Generate a fresh pre-signed S3 download URL for a report PDF. Each call creates a new link\
> valid for \*\*5 minutes\*\* (300 seconds).\
> \
> Store the \`report\_id\`, not the URL — call this endpoint again whenever you need a new download link.
```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Background Check Reports","description":"Retrieve full structured report data and download pre-signed PDF links."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/backgroundcheck/report/{report_id}/download":{"get":{"tags":["Background Check Reports"],"operationId":"downloadBgcReport","summary":"Download Report PDF","description":"Generate a fresh pre-signed S3 download URL for a report PDF. Each call creates a new link\nvalid for **5 minutes** (300 seconds).\n\nStore the `report_id`, not the URL — call this endpoint again whenever you need a new download link.\n","parameters":[{"name":"report_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Pre-signed PDF download link (valid 5 minutes).","content":{"application/json":{}}},"403":{"description":"Forbidden — the token's granted scopes do not include `api-platform/backgroundcheck-read` or `api-platform/backgroundcheck-read-write`.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Report not found or not owned by this account.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"500":{"description":"Internal server error — an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}}}}}}}
```
## Get Proof of Work
> Retrieve a structured summary of all research performed for a given subject — how many\
> searches were conducted, across which sources, sections, and jurisdictions.\
> This endpoint exposes the full investigation audit trail.
```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Background Check Reports","description":"Retrieve full structured report data and download pre-signed PDF links."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/backgroundcheck/reference/{reference_id}/proof-of-work":{"get":{"tags":["Background Check Reports"],"operationId":"getBgcProofOfWork","summary":"Get Proof of Work","description":"Retrieve a structured summary of all research performed for a given subject — how many\nsearches were conducted, across which sources, sections, and jurisdictions.\nThis endpoint exposes the full investigation audit trail.\n","parameters":[{"name":"reference_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Proof of work summary.","content":{"application/json":{}}},"403":{"description":"Forbidden — the token's granted scopes do not include `api-platform/backgroundcheck-read` or `api-platform/backgroundcheck-read-write`.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Subject not found.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"500":{"description":"Internal server error — an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}}}}}}}
```
## Get Report by Reference ID
> Retrieve the full structured JSON report for a subject by their client reference ID.\
> Returns the same response shape as \`GET /backgroundcheck/subject/{id}/report\`.\
> \
> \*\*Note on findings\[].fields format:\*\* Each finding's \`fields\` is a list of objects:\
> \`\[{"label": "\", "value": "\"}, ...]\`. Labels are human-readable strings\
> authored by VCheck analysts. Do not rely on specific label names for programmatic\
> parsing — use the \`record\_type\` field to identify the record shape.
```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Background Check Reports","description":"Retrieve full structured report data and download pre-signed PDF links."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/backgroundcheck/reference/{reference_id}/report":{"get":{"tags":["Background Check Reports"],"operationId":"getBgcReportByReferenceId","summary":"Get Report by Reference ID","description":"Retrieve the full structured JSON report for a subject by their client reference ID.\nReturns the same response shape as `GET /backgroundcheck/subject/{id}/report`.\n\n**Note on findings[].fields format:** Each finding's `fields` is a list of objects:\n`[{\"label\": \"\", \"value\": \"\"}, ...]`. Labels are human-readable strings\nauthored by VCheck analysts. Do not rely on specific label names for programmatic\nparsing — use the `record_type` field to identify the record shape.\n","parameters":[{"name":"reference_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Full structured report.","content":{"application/json":{}}},"403":{"description":"Forbidden — the token's granted scopes do not include `api-platform/backgroundcheck-read` or `api-platform/backgroundcheck-read-write`.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Subject or report not found.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"500":{"description":"Internal server error — an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}}}}}}}
```
## Get Report by Subject ID
> Retrieve the full structured JSON report for a subject by their VCheck internal subject ID.\
> Returns the same response shape as \`GET /backgroundcheck/reference/{reference\_id}/report\`.\
> Obtain \`subject\_id\` from \`GET /backgroundcheck/subjects\`.\
> \
> \*\*Note on findings\[].fields format:\*\* Each finding's \`fields\` is a list of objects:\
> \`\[{"label": "\", "value": "\"}, ...]\`. Labels are human-readable strings\
> authored by VCheck analysts. Do not rely on specific label names for programmatic\
> parsing — use the \`record\_type\` field to identify the record shape.
```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Background Check Reports","description":"Retrieve full structured report data and download pre-signed PDF links."}],"servers":[{"url":"https://api-platform.vcheckglobal.net/v2","description":"Vcheck platform (sandbox host issued first; production host after sign-off)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Obtain a token via POST https://api-platform.vcheckglobal.net/v2/oauth2/token.\nInclude in all subsequent requests as `Authorization: Bearer `.\nTokens expire after 3,600 seconds - cache and reuse; request a new one only when close to expiry.\n"}}},"paths":{"/backgroundcheck/subject/{id}/report":{"get":{"tags":["Background Check Reports"],"operationId":"getBgcReportBySubjectId","summary":"Get Report by Subject ID","description":"Retrieve the full structured JSON report for a subject by their VCheck internal subject ID.\nReturns the same response shape as `GET /backgroundcheck/reference/{reference_id}/report`.\nObtain `subject_id` from `GET /backgroundcheck/subjects`.\n\n**Note on findings[].fields format:** Each finding's `fields` is a list of objects:\n`[{\"label\": \"\", \"value\": \"\"}, ...]`. Labels are human-readable strings\nauthored by VCheck analysts. Do not rely on specific label names for programmatic\nparsing — use the `record_type` field to identify the record shape.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Full structured report.","content":{"application/json":{}}},"403":{"description":"Forbidden — the token's granted scopes do not include `api-platform/backgroundcheck-read` or `api-platform/backgroundcheck-read-write`.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"404":{"description":"Subject or report not found.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}},"500":{"description":"Internal server error — an unexpected error occurred. Please try again later or contact support if the issue persists.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string"}}}}}}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.vcheckglobal.com/api-reference/background-check/background-check-reports.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.