Paths

• Create a Document check (POST /v1/checks/document)
  • ✨ [Added] property fraud_analysis to settings in request body

Components schemas

• DocumentCheckSettingsCreate
  • ✨ [Added] property fraud_analysis

Paths

• List all activities (GET /v1/activities)
  • ✨ [Added] possible values in query parameter type: "system__updated_assignee__case"
  • ✨ [Added] possible values of data[].type in response body: "system__updated_assignee__case"

Paths

• Retrieve a case (GET /v1/cases/{id})
  • ✨ [Added] possible values of individuals[].checks[].type in response body: "company_monitoring"
  • ✨ [Added] possible values of companies[].checks[].type in response body: "company_monitoring"
• Create a company (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)
  • ✨ [Added] possible values of checks[].type in response body: "company_monitoring"
• List all checks (GET /v1/checks)
  • ✨ [Added] possible values in query parameter type: "company_monitoring"
  • ✨ [Added] possible values of data[].type in response body: "company_monitoring"
• List all activities (GET /v1/activities)
  • ✨ [Added] possible values in query parameter type: "user__acknowledged__company_monitoring_alert"
  • ✨ [Added] possible values of data[].type in response body: "user__acknowledged__company_monitoring_alert"
  • ✨ [Added] possible values of data[].context.check.type in response body: "company_monitoring"
• Retrieve a Company Monitoring check (GET /v1/checks/company-monitoring/{id})
  • ✨ [Added] operation GET /v1/checks/company-monitoring/{id}

Components schemas

• CaseWebhook
  • ✨ [Added] possible values of case.individuals[].checks[].type: "company_monitoring"
  • ✨ [Added] possible values of case.companies[].checks[].type: "company_monitoring"
• IndividualWebhook
  • ✨ [Added] possible values of individual.checks[].type: "company_monitoring"
• CompanyWebhook
  • ✨ [Added] possible values of company.checks[].type: "company_monitoring"
• CheckDeletedWebhook
  • ✨ [Added] possible values of check.type: "company_monitoring"
• CompanyMonitoringCheckDataSettingsDTO, CompanyMonitoringCheckDataVendorDTO, CompanyMonitoringCheckDataDTO, CompanyMonitoringCheckWebhook
  • ✨ [Added]

Paths

• Create an ID Verification check (POST /v1/checks/id_verification)
  • ✨ [Added] possible values of settings.vendor in request body: "onfido"
  • ✨ [Added] possible values of data.settings.vendor in response body: "onfido"
  • ✨ [Added] possible values of data.vendor.name in response body: "onfido"
• 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)
  • ✨ [Added] possible values of data.settings.vendor in response body: "onfido"
  • ✨ [Added] possible values of data.vendor.name in response body: "onfido"
• Create a Document check (POST /v1/checks/document), Add files (POST /v1/checks/document/{id}/add_files)
  • ✨ [Added] oneOf schema to settings.document_analysis.parameters in request body
  • ✨ [Added] oneOf schema to data.settings.document_analysis.parameters in response body
  • ✨ [Added] oneOf schema to data.detailed_results.document_analysis in response body
  • ✨ [Added] oneOf schema to data.information.document_analysis in response body
• 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)
  • ✨ [Added] oneOf schema to data.settings.document_analysis.parameters in response body
  • ✨ [Added] oneOf schema to data.detailed_results.document_analysis in response body
  • ✨ [Added] oneOf schema to data.information.document_analysis in response body

Components schemas

• DocumentCheckDataSettingsDocumentAnalysis
  • ✨ [Added] oneOf schema to parameters
• DocumentCheckDataDetailedResults, DocumentCheckDataInformation
  • ✨ [Added] oneOf schema to document_analysis
• DocumentCheckData
  • ✨ [Added] oneOf schema to detailed_results.document_analysis
  • ✨ [Added] oneOf schema to information.document_analysis
• DocumentCheck
  • ✨ [Added] oneOf schema to data.detailed_results.document_analysis
  • ✨ [Added] oneOf schema to data.information.document_analysis
• DocumentCheckWebhook
  • ✨ [Added] oneOf schema to check.data.settings.document_analysis.parameters
  • ✨ [Added] oneOf schema to check.data.detailed_results.document_analysis
  • ✨ [Added] oneOf schema to check.data.information.document_analysis
• IdVerificationCheckWebhook
  • ✨ [Added] possible values of check.data.settings.vendor: "onfido"
  • ✨ [Added] possible values of check.data.vendor.name: "onfido"

Paths

• Create an ID Document check (POST /v1/checks/id_document)
  • ✨ [Added] property vendor to settings in request body: "veriff","idnow"
  • ✨ [Added] required property vendor to data.settings in response body: "veriff","idnow"
  • ✨ [Added] possible values of data.vendor.name in response body: "idnow"
  • ⚠️ [Added] deprecated status to data.detailed_results in response body: true
  • ✨ [Added] possible values of data.information.document_type in response body: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"
  • ✨ [Added] required property maiden_name to data.information in response body
• Retrieve an ID Document check (GET /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)
  • ✨ [Added] required property vendor to data.settings in response body: "veriff","idnow"
  • ✨ [Added] possible values of data.vendor.name in response body: "idnow"
  • ⚠️ [Added] deprecated status to data.detailed_results in response body: true
  • ✨ [Added] possible values of data.information.document_type in response body: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"
  • ✨ [Added] required property maiden_name to data.information in response body
• Create an ID Verification check (POST /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)
  • ⚠️ [Added] deprecated status to data.detailed_results in response body: true
  • ✨ [Added] possible values of data.information.document_type in response body: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"
• Create a Document check (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)
  • ⚠️ [Added] deprecated status to data.detailed_results in response body: true

Components schemas

• DocumentCheckWebhook
  • ⚠️ [Added] deprecated status to check.data.detailed_results: true
• IdVerificationCheckWebhook
  • ⚠️ [Added] deprecated status to check.data.detailed_results: true
  • ✨ [Added] possible values of check.data.information.document_type: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"
• IdDocumentCheckWebhook
  • ✨ [Added] required property vendor to check.data.settings: "veriff","idnow"
  • ⚠️ [Added] deprecated status to check.data.detailed_results: true
  • ✨ [Added] possible values of check.data.information.document_type: "passport", "identity_card", "driving_license", "residence_permit", "visa", "other"
  • ✨ [Added] required property maiden_name to check.data.information

Paths

• Retrieve a case (GET /v1/cases/{id})
  • ✨ [Added] required property is_signatory to individuals[] in response body
• List all individuals (GET /v1/individuals)
  • ✨ [Added] required property is_signatory to data[] in response body
• Create an individual (POST /v1/individuals), Update an individual (PATCH /v1/individuals/{id})
  • ✨ [Added] property is_signatory in request body
  • ✨ [Added] required property is_signatory in response body
• Retrieve an individual (GET /v1/individuals/{id}), Set individual relevance (POST /v1/individuals/{id}/set-relevant)
  • ✨ [Added] required property is_signatory in response body

Components schemas

• CaseWebhook
  • ✨ [Added] required property is_signatory to case.individuals[]
• IndividualWebhook
  • ✨ [Added] required property is_signatory to individual

Paths

• List countries (GET /v1/company-data/countries)
  • ✨ [Added] possible values in query parameter vendor: "inpi"
  • ✨ [Added] possible values of data[].vendor in response body: "inpi"
• Retrieve a company vendor data (GET /v1/companies/{id}/vendor-data)
  • ✨ [Added] possible values in query parameter name: "inpi"
  • ✨ [Added] possible values of data[].name in response body: "inpi"
• List all activities (GET /v1/activities)
  • ✨ [Added] possible values of data[].context.vendor in response body: "inpi"

Paths

• Delete a case (DELETE /v1/cases/{id})
  • ✨ [Added] query parameter permanent
• Create an ID Verification check (POST /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)
  • ✨ [Added] required property video_file_id to data.information in response body
• Create a Document check (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)
  • ✨ [Added] required property archived_at to data.settings.custom_document_type in response body
• List all custom document types (GET /v1/custom_document_types)
  • ✨ [Added] query parameter include_archived
  • ✨ [Added] required property archived_at to data[] in response body

Components schemas

• DocumentCheckWebhook
  • ✨ [Added] required property archived_at to check.data.settings.custom_document_type
• IdVerificationCheckWebhook
  • ✨ [Added] required property video_file_id to check.data.information

Paths

• Create an ID Verification check (POST /v1/checks/id_verification)
  • ✨ [Added] possible values of settings.vendor in request body: "veriff"
  • ✨ [Added] possible values of settings.mode in request body: "default"
  • ✨ [Added] possible values of data.settings.vendor in response body: "veriff"
  • ✨ [Added] possible values of data.settings.mode in response body: "default"
  • ✨ [Added] possible values of data.vendor.name in response body: "veriff"
• 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)
  • ✨ [Added] possible values of data.settings.vendor in response body: "veriff"
  • ✨ [Added] possible values of data.settings.mode in response body: "default"
  • ✨ [Added] possible values of data.vendor.name in response body: "veriff"

Components schemas

• IdVerificationCheckWebhook
  • ✨ [Added] possible values of check.data.settings.vendor: "veriff"
  • ✨ [Added] possible values of check.data.settings.mode: "default"
  • ✨ [Added] possible values of check.data.vendor.name: "veriff"

Paths

• Create an automatic risk (POST /v1/cases/{id}/risks)
  • ✨ [Added] Automatic risk cannot be created when workspace has online risk engines.
• List all activities (GET /v1/activities)
  • ✨ [Added] possible values in query parameter type: "workflow__updated_risk__case"
  • ✨ [Added] possible values of data[].type in response body: "workflow__updated_risk__case"

Components schemas

• WebhookContextCase
  • ✨ [Added] required property last_activity_at
• CaseReportWebhookContext, IndividualWebhookContext, IndividualDeletedWebhookContext, CompanyWebhookContext, CompanyDeletedWebhookContext, NoteWebhookContext, NoteCommentWebhookContext, CheckWebhookContext, CheckDeletedWebhookContext
  • ✨ [Added] required property last_activity_at to case
• CaseReportWebhook, IndividualWebhook, IndividualDeletedWebhook, CompanyWebhook, CompanyDeletedWebhook, NoteWebhook, NoteCommentWebhook, AmlCheckWebhook, DocumentCheckWebhook, IdVerificationCheckWebhook, IdDocumentCheckWebhook, CheckDeletedWebhook
  • ✨ [Added] required property last_activity_at to context.case