API Led
Overview
Your application creates the profile, enriches with additional data and processes the onboarding.
This flow is used when your application is managing the data collection from the customer.
General Flow
- Existing system has all information about the profile to be verified
- Create the case in Detected over API
- Enrich the profile with any additional information
- Submit the profile to trigger screenings, analysis and automations
- Webhook notifies of completion
- Retrieve the profile data
Enrichment Data
Once created you can enrich the profile with any of the following data over API:
Data type | Overview |
|---|---|
Representatives | Any people that are associated with the profile such as UBOs, Directors, Authorised Signatories etc |
Documents | Any relevant documentation such as bank statements, utility bills, corporate documents etc |
Form data | Information to complete any required forms that have been assigned to the profile |
Integration view
---
config:
theme: redux-dark
look: classic
---
sequenceDiagram
autonumber
participant App as Your application
participant API as Detected API
App->>API: POST /profiles
Note right of API: Data gathering, <br/>screening, analysis, risk score
API--)App: Webhook: profile.updated
App->>API: POST /representatives (ubos, directors,etc + declaratory)
App->>API: POST /documents
App->>API: POST /forms
App->>API: POST /onboardings/{uuid}/submissions
Note right of API: Screenings, risk score & actions
API--)App: Webhook: profile.updated
App->>API: GET /profiles/{uuid}/analysis
API-->>App: analysisPlatform Setup Checklist
Setup the data models of the required representatives
Setup screening profiles for the entity and representatives
Setup eKYC (ID3) profiles (if required)
Setup and document types (if required)
Setup any forms (if required)
Configure the risk profiles and configure them with actions
Setup any actions to auto approve profiles based on risk
Configure the Profile Webhook
Common Questions
Question | Answer |
|---|---|
How do I trigger eKYC on any representatives as part of the flow | You can trigger an eKYC check on any representatives that have been added by using the following API: Run a verification for a representative |
How do i get the IDs of the document types | Once added into the platform you can retrieve the required IDs of the documents from Retrieve document library types |
How do i create a profile using a lookup to business data | Please see the detailed guide which outlines all the options for creating profiles: Create a profile via API |
I get a 400 response with error.onboarding_incompleted when calling the submissions API | The person used in { "representative_id": "…" } must exist on the profile with type declaratory |