Skip to main content

Thirdfort Client API Documentation

Welcome to the Thirdfort Client API documentation. This API enables integrators to perform comprehensive client due diligence and compliance checks, providing programmatic access to identity verification, screening, and document collection services.

API versions​

Important: The Thirdfort Client API is under active development. The v1 API provides stable, production-ready endpoints. If you want to experiment with preview functionality, you can use the v1alpha2 version of the API, but bear in mind that breaking changes are likely as we refine the v1alpha2 API based on feedback.

We welcome feedback from integrators to help shape how our API endpoints work before they are promoted to v1.

Getting Started​

  1. Quickstart - Complete an end-to-end Thirdfort check workflow in under 15 minutes
  2. Authentication - Learn how to obtain OAuth 2.0 access tokens
  3. API Reference - Explore all available endpoints
  4. API Design Principles - Understand our API patterns and conventions
  5. Code Generation - Generate type-safe client libraries

Environments​

EnvironmentAPI Base URLToken Endpoint
Nonproduction (Sandbox)https://api.thirdfort.dev/client/apihttps://creative-jungle-73-staging.authkit.app/oauth2/token
Productionhttps://api.thirdfort.com/client/apihttps://discerning-holiday-58.authkit.app/oauth2/token

Core Concepts​

Checks​

A Check is the primary resource representing a due diligence request. Checks are created from templates and can include:

  • Identity Verification - Verify an individual's identity using government-issued documents
  • Source of Funds - Verify the origin and legitimacy of funds
  • AML Screening - Comprehensive background screening including Sanctions, PEPs, and Adverse Media

Organizations and Teams​

Resources are organized hierarchically:

  • Organizations represent your business entities
  • Teams group users and checks within an organization
  • Brands define the visual identity shown to consumers

Resource Names​

Resources are identified using hierarchical resource names:

organizations/{org_id}/teams/{team_id}/checks/{check_id}

Use - as a wildcard to query across all resources:

organizations/-/teams/-/checks

Quick Start​

Ready to get started? Check out our Quickstart Guide for a step-by-step walkthrough of creating your first check.

Notifications​

The API provides notifications when important events occur (e.g., checks completing, reports being generated). You can retrieve notifications by polling the API.

See the Polling for Notifications guide for complete implementation details, including:

  • Polling patterns and best practices
  • Notification types and payload structures
  • Filtering and pagination
  • Webhook setup (for real-time push delivery)

Note: Webhook push notifications are currently available by contacting api-support@thirdfort.com. Self-service webhook configuration will be available in the future.

Support​