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

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

Paths

• Create a Document check (POST /v1/checks/document)
  • 🚨 [Added] required status to settings.document_type_key in request body
  • 🚨 [Removed] document_type from settings in request body
  • 🚨 [Removed] custom_document_id from settings in request body

Paths

• List tables (GET /v1/tables)
  • ✨ [Added] operation GET /v1/tables
• Retrieve a table (GET /v1/tables/{id})
  • ✨ [Added] operation GET /v1/tables/{id}

Components schemas

• Table
  • ✨ [Added]

Paths

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

Paths

• Return a list of all client portals (GET /v1/client-portals)
  • ✨ [Added] possible values of data[].default_language in response body: "pt"
  • ✨ [Added] possible values of data[].default_language in response body: "pl"

Components schemas

• ClientPortal
  • ✨ [Added] possible values of default_language: "pt"
  • ✨ [Added] possible values of default_language: "pl"

Paths

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

Paths

• Retrieve a case (GET /v1/cases/{id})
  • ✨ [Added] maxLength validator to companies[].name in response body: 160
  • ✨ [Added] maxLength validator to companies[].commercial_name in response body: 160
  • ✨ [Added] maxLength validator to companies[].registration_number in response body: 180
• List all companies (GET /v1/companies)
  • ✨ [Added] maxLength validator to data[].name in response body: 160
  • ✨ [Added] maxLength validator to data[].commercial_name in response body: 160
  • ✨ [Added] maxLength validator to data[].registration_number in response body: 180
• Create a company (POST /v1/companies), Update a company (PATCH /v1/companies/{id}), Retrieve a company (GET /v1/companies/{id}), Set company relevance (POST /v1/companies/{id}/set-relevant)
  • ✨ [Added] maxLength validator to name in response body: 160
  • ✨ [Added] maxLength validator to commercial_name in response body: 160
  • ✨ [Added] maxLength validator to registration_number in response body: 180

Components schemas

• CaseWebhook
  • ✨ [Added] maxLength validator to case.companies[].name: 160
  • ✨ [Added] maxLength validator to case.companies[].commercial_name: 160
  • ✨ [Added] maxLength validator to case.companies[]registration_number: 180
• CompanyWebhook
  • ✨ [Added] maxLength validator to name: 160
  • ✨ [Added] maxLength validator to commercial_name: 160
  • ✨ [Added] maxLength validator to registration_number: 180
• CompanyDeletedWebhook
  • ✨ [Added] maxLength validator to name: 160
• AmlCheckWebhook, DocumentCheckWebhook, IdVerificationCheckWebhook, IdDocumentCheckWebhook, CheckDeletedWebhook
  • ✨ [Added] maxLength validator to context.company.name: 160

Paths

• List all users (GET /v1/users)
  • ✨ [Added] query parameter include_suspended
  • ✨ [Added] required property suspended_at to data[] in response body
• Retrieve an user (GET /v1/users/{id})
  • ✨ [Added] required property suspended_at in response body

Paths

• Create a case (POST /v1/cases), Update a case (PATCH /v1/cases/{id})
  • ✨ [Added] possible values of status in request body: "draft"

Paths

• 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 registration_city to data.information.document_analysis in response body

Components schemas

• DocumentCheckWebhook
  • ✨ [Added] required property registration_city to check.data.information.document_analysis