> 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/products/id-verification/api.md).

# API

## Overview

Vcheck’s API Platform integrates our services and workflows in a fast and secure manner, with two options available:

1. **General Integration**: A flexible API that accepts various data formats, allowing you to send candidate investigation, ID verification, and monitoring requests directly from your system.
2. **Integration with Greenhouse Webhook**: A specialized API for automating candidate ID verification directly from your Greenhouse account.

> To request API credentials, contact us at <support@vcheckglobal.com> with the subject line "API Integration Request".&#x20;

## Authentication & Security

Vcheck Platform’s REST APIs use API Keys for authentication. The API Key is a unique security code that must be included in the headers of each request. It ensures secure access and controls different permissions.


---

# 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/products/id-verification/api.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.