> 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/models.md).

# Models

## The TokenResponse object

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"components":{"schemas":{"TokenResponse":{"type":"object","properties":{"access_token":{"type":"string","description":"Bearer token for API calls."},"token_type":{"type":"string","enum":["Bearer"]},"expires_in":{"type":"integer","description":"Token lifetime in seconds (3600 = one hour)."}},"required":["access_token","token_type","expires_in"]}}}}
```

## The OAuthError object

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"components":{"schemas":{"OAuthError":{"type":"object","properties":{"error":{"type":"string","description":"Machine-readable error code."},"error_description":{"type":"string","description":"Human-readable explanation."}},"required":["error"]}}}}
```

## The Pagination object

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"components":{"schemas":{"Pagination":{"type":"object","properties":{"count":{"type":"integer"},"page":{"type":"integer"},"page_size":{"type":"integer"},"total_pages":{"type":"integer"}}}}}}
```

## The ApiError object

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"components":{"schemas":{"ApiError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string","format":"uuid"}}}}}}}}
```

## The MonitoringWebhookRegisterRequest object

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"components":{"schemas":{"MonitoringWebhookRegisterRequest":{"type":"object","required":["callback_url","auth_method","auth_credentials","event_types"],"properties":{"callback_url":{"type":"string","format":"uri","description":"HTTPS endpoint that will receive event payloads."},"auth_method":{"type":"string","enum":["hmac_sha256","bearer_token","header_api_key"],"description":"Authentication method Vcheck uses when calling your endpoint."},"auth_credentials":{"type":"object","description":"Credentials for the chosen auth method, for example `{\"secret\": \"...\"}`."},"event_types":{"type":"array","items":{"type":"string"},"description":"Event types to subscribe to, for example `[\"SEND_MONITORING_ALERT\"]`."}},"additionalProperties":false}}}}
```

## The MonitoringWebhookUpdateRequest object

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"components":{"schemas":{"MonitoringWebhookUpdateRequest":{"type":"object","description":"Send only the fields you want to change. Omitted fields remain unchanged.","properties":{"callback_url":{"type":"string","format":"uri","description":"HTTPS endpoint that will receive event payloads."},"auth_method":{"type":"string","enum":["hmac_sha256","bearer_token","header_api_key"],"description":"Authentication method Vcheck uses when calling your endpoint."},"auth_credentials":{"type":"object","description":"Credentials for the chosen auth method, for example `{\"secret\": \"...\"}`."},"event_types":{"type":"array","items":{"type":"string"},"description":"Event types to subscribe to, for example `[\"SEND_MONITORING_ALERT\"]`."}},"additionalProperties":false}}}}
```

## The BgcReportLink object

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"components":{"schemas":{"BgcReportLink":{"type":"object","description":"A report document with a pre-signed download link.","required":["id","file_type","download_url","format","expires_at","created_on"],"properties":{"id":{"type":"string","format":"uuid","description":"Report identifier. Pass it to `GET /backgroundcheck/report/{report_id}/download` for a fresh link."},"file_type":{"type":"string","description":"Document type."},"download_url":{"type":"string","format":"uri","description":"Pre-signed PDF download URL, valid for 5 minutes."},"format":{"type":"string","description":"File format."},"expires_at":{"type":"string","format":"date-time","description":"When `download_url` expires (ISO 8601)."},"created_on":{"type":"string","format":"date-time","description":"When the report was created (ISO 8601)."}}}}}}
```

## The BgcWebhookSubject object

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"components":{"schemas":{"BgcWebhookSubject":{"type":"object","description":"The subject the order was placed for.","properties":{"email":{"type":["string","null"],"format":"email","description":"Subject email. May be null for an Entity order."},"first_name":{"type":["string","null"],"description":"Subject first name. null for an Entity order."},"last_name":{"type":"string","description":"Subject last name, or the company name for an Entity order."}}}}}}
```

## The BgcOrderPlacedEvent object

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"components":{"schemas":{"BgcOrderPlacedEvent":{"type":"object","description":"Payload sent when an order is accepted and queued.","required":["event_id","event_type","occurred_at","data"],"properties":{"event_id":{"type":"string","description":"Unique event identifier. Use it to ignore duplicate deliveries."},"event_type":{"type":"string","enum":["ORDER_PLACED"],"description":"Event type."},"occurred_at":{"type":"string","format":"date-time","description":"When the event occurred (ISO 8601, UTC)."},"data":{"type":"object","description":"Event data.","required":["reference_id","reports","subject","portal_status","product_code"],"properties":{"reference_id":{"type":"string","description":"Your reference ID for the order."},"product_code":{"type":"string","description":"Product code of the order."},"reports":{"type":"array","description":"Report documents available so far. Empty until the investigation produces a report.","items":{"$ref":"#/components/schemas/BgcReportLink"}},"subject":{"$ref":"#/components/schemas/BgcWebhookSubject"},"portal_status":{"type":"string","enum":["Pending","In Progress","Completed"],"description":"Current order status in the Vcheck portal."}}}}},"BgcReportLink":{"type":"object","description":"A report document with a pre-signed download link.","required":["id","file_type","download_url","format","expires_at","created_on"],"properties":{"id":{"type":"string","format":"uuid","description":"Report identifier. Pass it to `GET /backgroundcheck/report/{report_id}/download` for a fresh link."},"file_type":{"type":"string","description":"Document type."},"download_url":{"type":"string","format":"uri","description":"Pre-signed PDF download URL, valid for 5 minutes."},"format":{"type":"string","description":"File format."},"expires_at":{"type":"string","format":"date-time","description":"When `download_url` expires (ISO 8601)."},"created_on":{"type":"string","format":"date-time","description":"When the report was created (ISO 8601)."}}},"BgcWebhookSubject":{"type":"object","description":"The subject the order was placed for.","properties":{"email":{"type":["string","null"],"format":"email","description":"Subject email. May be null for an Entity order."},"first_name":{"type":["string","null"],"description":"Subject first name. null for an Entity order."},"last_name":{"type":"string","description":"Subject last name, or the company name for an Entity order."}}}}}}
```

## The BgcStatusPendingEvent object

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"components":{"schemas":{"BgcStatusPendingEvent":{"type":"object","description":"Payload sent when the investigation starts.","required":["event_id","event_type","occurred_at","data"],"properties":{"event_id":{"type":"string","description":"Unique event identifier. Use it to ignore duplicate deliveries."},"event_type":{"type":"string","enum":["STATUS_PENDING"],"description":"Event type."},"occurred_at":{"type":"string","format":"date-time","description":"When the event occurred (ISO 8601, UTC)."},"data":{"type":"object","description":"Event data.","required":["reference_id","reports","subject","portal_status"],"properties":{"reference_id":{"type":"string","description":"Your reference ID for the order."},"reports":{"type":"array","description":"Report documents available so far. Empty until the investigation produces a report.","items":{"$ref":"#/components/schemas/BgcReportLink"}},"subject":{"$ref":"#/components/schemas/BgcWebhookSubject"},"portal_status":{"type":"string","enum":["Pending","In Progress","Completed"],"description":"Current order status in the Vcheck portal."}}}}},"BgcReportLink":{"type":"object","description":"A report document with a pre-signed download link.","required":["id","file_type","download_url","format","expires_at","created_on"],"properties":{"id":{"type":"string","format":"uuid","description":"Report identifier. Pass it to `GET /backgroundcheck/report/{report_id}/download` for a fresh link."},"file_type":{"type":"string","description":"Document type."},"download_url":{"type":"string","format":"uri","description":"Pre-signed PDF download URL, valid for 5 minutes."},"format":{"type":"string","description":"File format."},"expires_at":{"type":"string","format":"date-time","description":"When `download_url` expires (ISO 8601)."},"created_on":{"type":"string","format":"date-time","description":"When the report was created (ISO 8601)."}}},"BgcWebhookSubject":{"type":"object","description":"The subject the order was placed for.","properties":{"email":{"type":["string","null"],"format":"email","description":"Subject email. May be null for an Entity order."},"first_name":{"type":["string","null"],"description":"Subject first name. null for an Entity order."},"last_name":{"type":"string","description":"Subject last name, or the company name for an Entity order."}}}}}}
```

## The BgcStatusCompletedEvent object

```json
{"openapi":"3.1.0","info":{"title":"Vcheck Global API","version":"5.4.0"},"components":{"schemas":{"BgcStatusCompletedEvent":{"type":"object","description":"Payload sent when the report is complete.","required":["event_id","event_type","occurred_at","data"],"properties":{"event_id":{"type":"string","description":"Unique event identifier. Use it to ignore duplicate deliveries."},"event_type":{"type":"string","enum":["STATUS_COMPLETED"],"description":"Event type."},"occurred_at":{"type":"string","format":"date-time","description":"When the event occurred (ISO 8601, UTC)."},"data":{"type":"object","description":"Event data.","required":["reference_id","reports","subject","portal_status","product_code"],"properties":{"reference_id":{"type":"string","description":"Your reference ID for the order."},"product_code":{"type":"string","description":"Product code of the order."},"reports":{"type":"array","description":"Report documents available so far. Empty until the investigation produces a report.","items":{"$ref":"#/components/schemas/BgcReportLink"}},"subject":{"$ref":"#/components/schemas/BgcWebhookSubject"},"portal_status":{"type":"string","enum":["Pending","In Progress","Completed"],"description":"Current order status in the Vcheck portal."}}}}},"BgcReportLink":{"type":"object","description":"A report document with a pre-signed download link.","required":["id","file_type","download_url","format","expires_at","created_on"],"properties":{"id":{"type":"string","format":"uuid","description":"Report identifier. Pass it to `GET /backgroundcheck/report/{report_id}/download` for a fresh link."},"file_type":{"type":"string","description":"Document type."},"download_url":{"type":"string","format":"uri","description":"Pre-signed PDF download URL, valid for 5 minutes."},"format":{"type":"string","description":"File format."},"expires_at":{"type":"string","format":"date-time","description":"When `download_url` expires (ISO 8601)."},"created_on":{"type":"string","format":"date-time","description":"When the report was created (ISO 8601)."}}},"BgcWebhookSubject":{"type":"object","description":"The subject the order was placed for.","properties":{"email":{"type":["string","null"],"format":"email","description":"Subject email. May be null for an Entity order."},"first_name":{"type":["string","null"],"description":"Subject first name. null for an Entity order."},"last_name":{"type":"string","description":"Subject last name, or the company name for an Entity order."}}}}}}
```


---

# 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/models.md?ask=<question>&goal=<user_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.