> 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-subjects.md).
# Background Check Subjects
Retrieve background check subjects and their details.
## List Subjects
> Retrieve a paginated list of all subjects submitted for background check under your account.\
> \
> \*\*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 Subjects","description":"Retrieve background check subjects and their details."}],"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/subjects":{"get":{"tags":["Background Check Subjects"],"operationId":"listBgcSubjects","summary":"List Subjects","description":"Retrieve a paginated list of all subjects submitted for background check under your account.\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 by client-supplied reference ID (exact match)."},{"name":"name","in":"query","schema":{"type":"string"},"description":"Filter by subject name (partial, case-insensitive)."},{"name":"email","in":"query","schema":{"type":"string"},"description":"Filter by email address (partial, case-insensitive)."},{"name":"portal_status","in":"query","schema":{"type":"string"},"description":"Filter by portal status (e.g. Pending, In Progress, Completed)."},{"name":"product_code","in":"query","schema":{"type":"string"},"description":"Filter by product code (e.g. BGC_STANDARD)."},{"name":"created_on__gte","in":"query","schema":{"type":"string"},"description":"Subjects created on or after this date, inclusive. MM/DD/YYYY."},{"name":"created_on__lte","in":"query","schema":{"type":"string"},"description":"Subjects created on or before this date, inclusive. MM/DD/YYYY."},{"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 subjects.","content":{"application/json":{}}},"400":{"description":"Bad request — invalid date format or date range in query parameters.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"fields":{"type":"object"}}}}}}}},"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"}}}}}}}}}}}
```
## Get Subject Detail
> Retrieve full details for a single background check subject by their client reference ID.\
> \
> \*\*Note:\*\* The \`dob\` and \`ssn\` fields are returned as opaque encrypted strings. They are not human-readable.
```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Background Check Subjects","description":"Retrieve background check subjects and their details."}],"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}":{"get":{"tags":["Background Check Subjects"],"operationId":"getBgcSubjectByReferenceId","summary":"Get Subject Detail","description":"Retrieve full details for a single background check subject by their client reference ID.\n\n**Note:** The `dob` and `ssn` fields are returned as opaque encrypted strings. They are not human-readable.\n","parameters":[{"name":"reference_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Full subject details.","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 Subject Detail by ID
> Retrieve full details for a single background check subject by their VCheck internal subject ID.\
> Obtain \`subject\_id\` from \`GET /backgroundcheck/subjects\`.\
> \
> \*\*Note:\*\* The \`dob\` and \`ssn\` fields are returned as opaque encrypted strings. They are not human-readable.
```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"tags":[{"name":"Background Check Subjects","description":"Retrieve background check subjects and their details."}],"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}":{"get":{"tags":["Background Check Subjects"],"operationId":"getBgcSubjectById","summary":"Get Subject Detail by ID","description":"Retrieve full details for a single background check subject by their VCheck internal subject ID.\nObtain `subject_id` from `GET /backgroundcheck/subjects`.\n\n**Note:** The `dob` and `ssn` fields are returned as opaque encrypted strings. They are not human-readable.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Full subject details.","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"}}}}}}}}}}}
```
---
# 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-subjects.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.