uCheck Developer Documentation

Developer documentation for the uCheck api project. This site brings together:

• Endpoint guides describing usage and server-side implementation.

• Upload guides for the file-upload based tools.

Where to start

• New to the API? Read Overview and Authentication.

• Maintaining an older (v1/v2) integration? See the v2 Endpoints.

Contents

Getting Started

• Overview
  • API
  • Uploads
  • How the documentation is organised
• Authentication
  • v2 Endpoints — encrypted key in the request body
  • Key handling guidance

Endpoint Guides

• Endpoint Guides
  • Integration prerequisites
  • v2 Endpoints

Upload Guides

• Upload Guides
  • Add Applicant Request Upload v2.1 (Specification)

Reference Material

• Glossary