GET /v1/activities)
type: "system__updated_assignee__case"data[].type in response body: "system__updated_assignee__case"GET /v1/cases/{id})
individuals[].checks[].type in response body: "company_monitoring"companies[].checks[].type in response body: "company_monitoring"POST /v1/companies), Retrieve a company (GET /v1/companies/{id}), Update a company (PATCH /v1/companies/{id}), Set company relevance (POST /v1/companies/{id}/set-relevant), Create an individual (POST /v1/individuals), Retrieve an individual (GET /v1/individuals/{id}), Update an individual (PATCH /v1/individuals/{id}), Set individual relevance (POST /v1/individuals/{id}/set-relevant)
checks[].type in response body: "company_monitoring"GET /v1/checks)
type: "company_monitoring"data[].type in response body: "company_monitoring"GET /v1/activities)
type: "user__acknowledged__company_monitoring_alert"data[].type in response body: "user__acknowledged__company_monitoring_alert"data[].context.check.type in response body: "company_monitoring"GET /v1/checks/company-monitoring/{id})
CaseWebhook
case.individuals[].checks[].type: "company_monitoring"case.companies[].checks[].type: "company_monitoring"IndividualWebhook
individual.checks[].type: "company_monitoring"CompanyWebhook
company.checks[].type: "company_monitoring"CheckDeletedWebhook
check.type: "company_monitoring"CompanyMonitoringCheckDataSettingsDTO, CompanyMonitoringCheckDataVendorDTO, CompanyMonitoringCheckDataDTO, CompanyMonitoringCheckWebhook
POST /v1/checks/id_verification)
settings.vendor in request body: "onfido"data.settings.vendor in response body: "onfido"data.vendor.name in response body: "onfido"GET /v1/checks/id_verification/{id}), Review an ID Verification check (PATCH /v1/checks/id_verification/{id}/review), Refresh an ID Verification check url (POST /v1/checks/id_verification/{id}/refresh_url)
data.settings.vendor in response body: "onfido"data.vendor.name in response body: "onfido"POST /v1/checks/document), Add files (POST /v1/checks/document/{id}/add_files)
settings.document_analysis.parameters in request bodydata.settings.document_analysis.parameters in response bodydata.detailed_results.document_analysis in response bodydata.information.document_analysis in response bodyGET /v1/checks/document/{id}), Force review (POST /v1/checks/document/{id}/force_review), Review a Document check (PATCH /v1/checks/document/{id}/review)
data.settings.document_analysis.parameters in response bodydata.detailed_results.document_analysis in response bodydata.information.document_analysis in response bodyDocumentCheckDataSettingsDocumentAnalysis
DocumentCheckDataDetailedResults, DocumentCheckDataInformation
DocumentCheckData
DocumentCheck
DocumentCheckWebhook
IdVerificationCheckWebhook
"onfido""onfido"POST /v1/checks/id_document)
vendor to settings in request body: "veriff","idnow"vendor to data.settings in response body: "veriff","idnow"data.vendor.name in response body: "idnow"data.detailed_results in response body: truedata.information.document_type in response body: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"maiden_name to data.information in response bodyGET /v1/checks/id_document/{id}), Add files (POST /v1/checks/id_document/{id}/add_files), Review an ID Document check (PATCH /v1/checks/id_document/{id}/review)
vendor to data.settings in response body: "veriff","idnow"data.vendor.name in response body: "idnow"data.detailed_results in response body: truedata.information.document_type in response body: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"maiden_name to data.information in response bodyPOST /v1/checks/id_verification), Retrieve an ID Verification check (GET /v1/checks/id_verification/{id}), Review an ID Verification check (PATCH /v1/checks/id_verification/{id}/review), Refresh an ID Verification check url (POST /v1/checks/id_verification/{id}/refresh_url)
data.detailed_results in response body: truedata.information.document_type in response body: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"POST /v1/checks/document), Add files (POST /v1/checks/document/{id}/add_files), Retrieve a Document check (GET /v1/checks/document/{id}), Force review (POST /v1/checks/document/{id}/force_review), Review a Document check (PATCH /v1/checks/document/{id}/review)
data.detailed_results in response body: trueDocumentCheckWebhook
check.data.detailed_results: trueIdVerificationCheckWebhook
check.data.detailed_results: truecheck.data.information.document_type: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"IdDocumentCheckWebhook
vendor to check.data.settings: "veriff","idnow"check.data.detailed_results: truecheck.data.information.document_type: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"maiden_name to check.data.informationGET /v1/cases/{id})
is_signatory to individuals[] in response bodyGET /v1/individuals)
is_signatory to data[] in response bodyPOST /v1/individuals), Update an individual (PATCH /v1/individuals/{id})
is_signatory in request bodyis_signatory in response bodyGET /v1/individuals/{id}), Set individual relevance (POST /v1/individuals/{id}/set-relevant)
is_signatory in response bodyCaseWebhook
is_signatory to case.individuals[]IndividualWebhook
is_signatory to individualGET /v1/company-data/countries)
vendor: "inpi"data[].vendor in response body: "inpi"GET /v1/companies/{id}/vendor-data)
name: "inpi"data[].name in response body: "inpi"GET /v1/activities)
data[].context.vendor in response body: "inpi"DELETE /v1/cases/{id})
permanentPOST /v1/checks/id_verification), Retrieve an ID Verification check (GET /v1/checks/id_verification/{id}), Review an ID Verification check (PATCH /v1/checks/id_verification/{id}/review), Refresh an ID Verification check url (POST /v1/checks/id_verification/{id}/refresh_url)
video_file_id to data.information in response bodyPOST /v1/checks/document), Add files (POST /v1/checks/document/{id}/add_files), Retrieve a Document check (GET /v1/checks/document/{id}), Force review (POST /v1/checks/document/{id}/force_review), Review a Document check (PATCH /v1/checks/document/{id}/review)
archived_at to data.settings.custom_document_type in response bodyGET /v1/custom_document_types)
include_archivedarchived_at to data[] in response bodyDocumentCheckWebhook
archived_at to check.data.settings.custom_document_typeIdVerificationCheckWebhook
video_file_id to check.data.informationPOST /v1/checks/id_verification)
settings.vendor in request body: "veriff"settings.mode in request body: "default"data.settings.vendor in response body: "veriff"data.settings.mode in response body: "default"data.vendor.name in response body: "veriff"GET /v1/checks/id_verification/{id}), Review an ID Verification check (PATCH /v1/checks/id_verification/{id}/review), Refresh an ID Verification check url (POST /v1/checks/id_verification/{id}/refresh_url)
data.settings.vendor in response body: "veriff"data.settings.mode in response body: "default"data.vendor.name in response body: "veriff"IdVerificationCheckWebhook
"veriff""default""veriff"POST /v1/cases/{id}/risks)
GET /v1/activities)
type: "workflow__updated_risk__case"data[].type in response body: "workflow__updated_risk__case"WebhookContextCase
last_activity_atCaseReportWebhookContext, IndividualWebhookContext, IndividualDeletedWebhookContext, CompanyWebhookContext, CompanyDeletedWebhookContext, NoteWebhookContext, NoteCommentWebhookContext, CheckWebhookContext, CheckDeletedWebhookContext
last_activity_at to caseCaseReportWebhook, IndividualWebhook, IndividualDeletedWebhook, CompanyWebhook, CompanyDeletedWebhook, NoteWebhook, NoteCommentWebhook, AmlCheckWebhook, DocumentCheckWebhook, IdVerificationCheckWebhook, IdDocumentCheckWebhook, CheckDeletedWebhook
last_activity_at to context.case🚨 BREAKING CHANGES
The key attribute for custom document types must now be used to create your Document check directly in settings.document_type_key.
This helps integrator create more resilient and consistent integrations across multiple workspaces, eliminating the need to store custom document types (and their IDs) for each environment.
POST /v1/checks/document)
settings.document_type_key in request bodydocument_type from settings in request bodycustom_document_id from settings in request body