 The Onboarding APIs use OAuth2, you will need your API credentials which are provided with access to the Detected platform.  You can have multiple API clients created for your account, each API client us required to have a scope defined, scopes available are read or write.

Authentication

 Detected uses conventional HTTP response codes to indicate the success or failure of an API request, codes used follow the standard https //restfulapi. net/http-status-codes/ for a REST API.

Error Handling

 Our API enforces rate limiting to ensure fair usage and optimal performance.  The rate limit is variable based on the API.

Rate Limiting

 Any API that fetches bulk data will have pagination applied, the size of each page is indicated in the API response as well as all information required to paginate through the data 

Pagination

Detected API Docs

API Examples

Process a document via API

REST APIs

API Overview

Terminology

Detected Initiating

External System Initiating

KYB Onboarding

Trigger KYC flow

Trigger KYC flow in a customer journey

Trigger IDV based on risk

Standalone KYC Onboarding

Standalone Document Processing

Reference Flows & Examples

Alerts

Audit Logs

Brands

Checklists

Documents

Forms

Onboarding

Representatives

Portal Configurations

Profiles

Analysis

Search

Users

Download OpenAPI file

Trigger a KYB journey with redirect

Create a profile via API

Create an onboarding flow via API

Extract information from a profile after compliance decision

Assign a new form to an existing onboarding configuration

Update a profiles onboarding config

Webhook Overview

Webhook Setup

Webhook Common Questions

Profile Webhook

Document Processing Webhook

Webhook Specifications

Webhooks