# Overview

The uCheck HR Platform offers two ways to integrate: a programmatic **API** and
file-based **CSV uploads**. This page summarises each — follow the links for
full detail.

## API

The uCheck API lets integrators submit background-check applications and
retrieve their results and status programmatically.

### API versions

The project exposes the **v2** endpoints: they live at root paths (e.g.
`/addApplicantRequest/v2`, `/getResults/v2`), version individually (`v1` or
`v2`) within their own URL path, authenticate with an encrypted key in the
request body, and use mixed XML/JSON contracts inherited from the older
platform.

See the [v2 Endpoints](../endpoints/v2-endpoints.md) guide.

### Environments

| Environment | Purpose |
|-------------|---------|
| **UAT** (User Acceptance Testing) | Integration testing against a sandbox. Your source IP addresses must be registered with uCheck before use. |
| **Live** | Production. Uses separate, live-issued API keys. Do **not** send test submissions to Live. |

### Onboarding essentials

See [Integration prerequisites](../endpoints/prerequisites.md) for the complete
account, network, credential, UAT, and Live-readiness checklist.

- A company account must be set up and your connecting IP address(es)
  registered with the uCheck firewall.
- UAT uses one API **key** per Head Office (HO). Live keys are issued per
  organisation unit, so larger companies may receive multiple Live keys.
- Rate limits apply and differ per endpoint (for example, the v2 GetResult
  endpoint permits one request per 10 minutes). Exceeding limits returns an
  HTTP `429` or a JSON error. See each endpoint's guide for specifics.

### Maintenance windows

uCheck carries out scheduled maintenance as described in your terms and
conditions. During a maintenance window, API submissions receive an HTTP `503`
response.

## Uploads

For teams that prefer not to integrate programmatically, the uCheck HR Platform
includes a **CSV Uploader**, available from the Check New Applicant page via the
*Upload CSV* button. You upload a CSV of applicant requests; uCheck validates
the file, then creates the applications and emails an invitation to each
applicant. This suits bulk, occasional, or low-volume submissions without
writing code.

See the [Upload Guides](../upload-guides/index.md).

## How the documentation is organised

- **Endpoint Guides** — practical usage plus server-side implementation notes.
- **Upload Guides** — the file-upload based tools.