Webhook events and CRM sync

use detected webhooks to keep your crm or internal systems in sync without polling every profile webhooks are triggers , not full data exports verify the signature header, read the event and summary data , then call the api ( get /profiles/{uuid} , get /representatives , etc ) for the full picture configure webhooks in case management → integration information for signature verification (hmac sha256 over the raw request body), see webhook verification using secrets https //docs detected app/detected apis/webhook verification using secrets for webhook types and setup, see webhook overview https //docs detected app/detected apis/webhook overview common questions question answer what are all possible event values? six values (v2) profile created , profile updated , verification created , verification updated on the status webhook ; document processed , document completed on the document processed webhook does the profile webhook lifecycle https //docs detected app/detected apis/profile webhook lifecycle diagram mean webhooks only fire on status change? no profile updated also fires for some metadata changes (e g customer reference , assignee) without review status changing the diagram shows the main lifecycle moments, not every trigger in progress portal work and adding a person via api often do not fire status webhooks until submit or a later step see when profile updated fires below can we subscribe to specific statuses only? no you cannot filter by status in the dashboard enable the status webhook once; your handler filters on data review status use early events ( profile created / profile updated with processed ) for parallel sales or operations work while due diligence continues what fires when a business or individual is added or changed? business profile created on case create; profile updated on status and metadata changes individual verification created / verification updated on verify portal (same status webhook url) adding a person ( post /representatives ) does not webhook by itself is the webhook payload enough for crm? no use the webhook as a trigger, then get endpoints for full data webhook types webhook events purpose status webhook profile , verification case lifecycle and individual kyc document processed webhook document processed , document completed document ocr / translate / fraud pipeline use v2 payloads { "event", "timestamp", "data" { … } } event catalog status webhook event what causes it relates to typical data review status profile created new profile created ( post /profiles , case management, portal) business or individual profile incomplete profile updated status change, auto lifecycle, or metadata change profile (usually business kyb case) e g processed, needs review, approved verification created individual starts verify portal individual — verification updated individual completes verification (pass or fail) individual — verification uses the same status webhook url as profile some tenants may emit other verification event names treat any verification event on the status webhook the same way verify signature, then get /representatives/{uuid}/verifications for pass/fail detail document processed webhook event what causes it document processed document uploaded; processing steps updating document completed document processing finished payload schemas profile webhook https //docs detected app/detected apis/profile webhook , verify webhook https //docs detected app/detected apis/verify webhook , document processing webhook https //docs detected app/detected apis/document processing webhook when profile updated fires trigger fires profile updated? profile created profile created (not updated) case moves to processed after create yes customer submits onboarding yes analyst approves / declines yes patch customer reference yes (status may be unchanged) patch assignee id yes patch team id / risk id yes post /representatives (add person only) no portal draft before submit no individual kyc in verify portal no — use verification document upload in portal no — use document if document processed webhook enabled typical business case sequence order event review status meaning 1 profile created incomplete case created 2 profile updated processed backend processing complete; onboarding portal open — early signal for parallel work 3 profile updated needs review customer submitted onboarding business vs individuals flowchart td sw\["status webhook (one url)"] sw > p\["profile created / profile updated"] sw > v\["verification created / verification updated"] p > pe\["business or individual entity profile"] v > vp\["individuals — verify portal (kyc)"] moment webhook business case created profile created ready for onboarding (processed) profile updated submitted / decided profile updated person added only (post /representatives) none person completes kyc verification updated scenario walkthroughs business received, kyb not yet complete step webhook your crm case opened profile created (incomplete) create crm stub profile processed profile updated (processed) start parallel work if needed customer in portal (draft) no profile wait for submit customer submits profile updated (needs review) pull full kyb data via get individual entity profile step webhook your crm case opened profile created (incomplete) create crm stub profile processed profile updated (processed) early lifecycle signal verify portal completed verification updated; profile updated may also fire if status changes get verifications for pass/fail representative on a company case step webhook your crm person added none optional poll representatives verify portal completed verification updated; parent profile updated may fire if configuration changes company status get verifications; filter parent profile events on review status kyc failed, then passed step webhook your crm first attempt fails verification updated store failed outcome retry succeeds verification updated again update to passed; handle duplicates idempotently crm filtering detected sends all status webhook events filter in your integration your goal react to case received profile created or profile updated with processed kyb submitted profile updated with needs review compliance decision profile updated with approved or declined individual kyc outcome verification updated + get verifications status progression and whether verify completion changes parent profile status depend on your tenant configuration for composed gets after webhooks, see extract information from a profile after compliance decision https //docs detected app/detected apis/extract information from a profile after compliance decision example payloads profile created { "event" "profile created", "data" { "id" "09848a71 4219 4b68 85e1 c59c2eacf762", "customer reference" "your crm id", "review status" "incomplete" } } profile updated (metadata — review status may be unchanged) { "event" "profile updated", "data" { "id" "09848a71 4219 4b68 85e1 c59c2eacf762", "customer reference" "your crm id", "review status" "incomplete" } } profile statuses (webhook context) flowchart lr incomplete > processed > needsreview\["needs review"] needsreview > additionalinfo\["additional info required"] needsreview > approved needsreview > declined additionalinfo > needsreview approved > archived declined > archived status meaning incomplete case being created processed backend processing complete; portal open, not yet submitted needs review customer submitted onboarding additional info required more information requested; profile updated on change and re submit approved / declined / archived compliance or workflow outcome full definitions profile statuses https //docs detected app/detected apis/profile statuses related guides profile webhook lifecycle https //docs detected app/detected apis/profile webhook lifecycle webhook overview https //docs detected app/detected apis/webhook overview webhook verification using secrets https //docs detected app/detected apis/webhook verification using secrets verify webhook lifecycle https //docs detected app/detected apis/verify webhook lifecycle extract information from a profile after compliance decision https //docs detected app/detected apis/extract information from a profile after compliance decision