 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 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

Process a document via API

REST APIs

Detected API Docs

API Overview

Internally Led

Customer Led

Internal / customer collaboration

Detected Initiating

Using a bespoke weblink

Portals / Web Apps

CRMs

External System Initiating

Reference Process Flows

Terminology

Trigger a KYB journey with redirect

Trigger a KYC journey with redirect

Without search

With search & user decisioning

With search & automated decisioning

Create a profile via API

UX Flow - With Search

UX Flow - No Search

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

API Integration Guides

Alerts

Checklists

Documents

Forms

Representatives

Portal Configurations

Profiles

Analysis

Search

Users

Download OpenAPI file

Webhook Overview

Verify Webhook Lifecycle

Verify Webhook

Profile Statuses

Profile Webhook Lifecycle

Profile Webhook

Document Processing Lifecycle

Document Processing Webhook

Webhooks

Salesforce App Docs

Untitled