🚨 BREAKING CHANGES

These changes where announced in Upcoming changes Scheduled for October 28th, 2025

Changed operations

• Retrieve a case (GET /v1/cases/{id}), List all checks (GET /v1/checks), 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), Retrieve case's documents (GET /v1/cases/{id}/documents), List all activities (GET /v1/activities)
  • 🚨 [Replaced] Format of subtype for document check changed to always follow "document_type:{settings.document_type_key}"
• Create a case (POST /v1/cases), Update a case (PATCH /v1/cases/{id})
  • 🚨 [Removed] possible values of status in request body: "approved"
  • 🚨 [Removed] possible values of status in request body: "rejected"
• Create an Electronic Signature check (POST /v1/checks/electronic_signature), Retrieve an Electronic Signature check (GET /v1/checks/electronic_signature/{id}), Review an Electronic Signature check (PATCH /v1/checks/electronic_signature/{id}/review)
  • ✨ [Replaced] possible nullable value of subtype in response body: true → false
• 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)
  • ✨ [Replaced] possible nullable value of subtype in response body: true → false
  • 🚨 [Removed] property custom_document_type from data.settings in response body
  • 🚨 [Replaced] type definition of data.settings.document_type: "string" → "object" in response body
  • ✨ [Added] required property id to data.settings.document_type in response body
  • ✨ [Added] required property label to data.settings.document_type in response body
  • ✨ [Added] required property key to data.settings.document_type in response body
  • ✨ [Added] required property target_entities to data.settings.document_type in response body
  • ✨ [Added] required property is_internal to data.settings.document_type in response body
  • ✨ [Added] required property created_at to data.settings.document_type in response body
  • ✨ [Added] required property updated_at to data.settings.document_type in response body
  • ✨ [Added] required property archived_at to data.settings.document_type in response body
  • ✨ [Removed] possible nullable value from data.settings.document_type in response body: true
• List all custom document types (GET /v1/custom_document_types)
  • 🚨 [Removed] operation

Changed components schemas

• ElectronicSignatureCheck
  • ✨ [Replaced] possible nullable value of subtype: true → false
• DocumentDataSettings
  • 🚨 [Removed] property custom_document_type
  • 🚨 [Removed] type definition from document_type: "string"
  • ✨ [Removed] possible nullable value from document_type: true
  • ✨ [Added] required property id to document_type
  • ✨ [Added] required property label to document_type
  • ✨ [Added] required property key to document_type
  • ✨ [Added] required property target_entities to document_type
  • ✨ [Added] required property is_internal to document_type
  • ✨ [Added] required property created_at to document_type
  • ✨ [Added] required property updated_at to document_type
  • ✨ [Added] required property archived_at to document_type
• DocumentCheck
  • ✨ [Replaced] possible nullable value of subtype: true → false
• DocumentCheckWebhook
  • ✨ [Replaced] possible nullable value of check.subtype: true → false
  • ✨ [Removed] property custom_document_type from check.data.settings
  • ✨ [Removed] possible nullable value from check.data.settings.document_type: true
  • 🚨 [Replaced] type definition of check.data.settings.document_type: "string" → "object"
  • ✨ [Added] required property id to check.data.settings.document_type
  • ✨ [Added] required property label to check.data.settings.document_type
  • ✨ [Added] required property key to check.data.settings.document_type
  • ✨ [Added] required property target_entities to check.data.settings.document_type
  • ✨ [Added] required property is_internal to check.data.settings.document_type
  • ✨ [Added] required property created_at to check.data.settings.document_type
  • ✨ [Added] required property updated_at to check.data.settings.document_type
  • ✨ [Added] required property archived_at to check.data.settings.document_type
• ElectronicSignatureCheckWebhook
  • ✨ [Replaced] possible nullable value of check.subtype: true → false

Changed operations

• Create an AML check (POST /v1/checks/aml), Retrieve an AML check (GET /v1/checks/aml/{id}), Review AML hits (PATCH /v1/checks/aml/{id}/hits/review), Review an AML check (PATCH /v1/checks/aml/{id}/review), Update an AML check monitoring (PATCH /v1/checks/aml/{id}/monitoring)
  • ✨ [Added] required property is_media_check_enabled to data.settings in response body
  • ✨ [Added] property results_count to data.vendor in response body
• Create a case (POST /v1/cases), Update a case (PATCH /v1/cases/{id})
  • ✨ [Replaced] minimum validator of custom_properties.* in request body: -2147483647 → -9007199254740991
  • ✨ [Replaced] maximum validator of custom_properties.* in request body: 2147483647 → 9007199254740991
• Create a case (POST /v1/cases), Update a case (PATCH /v1/cases/{id}), Retrieve a case (GET /v1/cases/{id})
  • ✨ [Replaced] minimum validator of custom_properties.* in response body: -2147483647 → -9007199254740991
  • ✨ [Replaced] maximum validator of custom_properties.* in response body: 2147483647 → 9007199254740991
  • ✨ [Replaced] minimum validator of individuals[].custom_properties.* in response body: -2147483647 → -9007199254740991
  • ✨ [Replaced] maximum validator of individuals[].custom_properties.* in response body: 2147483647 → 9007199254740991
  • ✨ [Replaced] minimum validator of companies[].custom_properties.* in response body: -2147483647 → -9007199254740991
  • ✨ [Replaced] maximum validator of companies[].custom_properties.* in response body: 2147483647 → 9007199254740991
• Create a company (POST /v1/companies), Update a company (PATCH /v1/companies/{id}), Create an individual (POST /v1/individuals), Update an individual (PATCH /v1/individuals/{id})
  • ✨ [Replaced] minimum validator of custom_properties.* in request body: -2147483647 → -9007199254740991
  • ✨ [Replaced] maximum validator of custom_properties.* in request body: 2147483647 → 9007199254740991
• Create a company (POST /v1/companies), Update a company (PATCH /v1/companies/{id}), Create an individual (POST /v1/individuals), Update an individual (PATCH /v1/individuals/{id}), Retrieve a company (GET /v1/companies/{id}), Set company relevance (POST /v1/companies/{id}/set-relevant), Retrieve an individual (GET /v1/individuals/{id}), Set individual relevance (POST /v1/individuals/{id}/set-relevant)
  • ✨ [Replaced] minimum validator of custom_properties.* in response body: -2147483647 → -9007199254740991
  • ✨ [Replaced] maximum validator of custom_properties.* in response body: 2147483647 → 9007199254740991

Changed components schemas

• AmlCheckWebhook
  • ✨ [Added] required property is_media_check_enabled to check.data.settings
  • ✨ [Added] property results_count to check.data.vendor
• CaseWebhook
  • ✨ [Replaced] minimum validator of case.custom_properties.*: -2147483647 → -9007199254740991
  • ✨ [Replaced] maximum validator of case.custom_properties*: 2147483647 → 9007199254740991
  • ✨ [Replaced] minimum validator of case.individuals[].custom_properties*: -2147483647 → -9007199254740991
  • ✨ [Replaced] maximum validator of case.individuals[].custom_properties*: 2147483647 → 9007199254740991
  • ✨ [Replaced] minimum validator of case.companies[].custom_properties*: -2147483647 → -9007199254740991
  • ✨ [Replaced] maximum validator of case.companies[].custom_properties*: 2147483647 → 9007199254740991
• IndividualWebhook
  • ✨ [Replaced] minimum validator of individual.custom_properties*: -2147483647 → -9007199254740991
  • ✨ [Replaced] maximum validator of individual.custom_properties*: 2147483647 → 9007199254740991
• CompanyWebhook
  • ✨ [Replaced] minimum validator of company.custom_properties*: -2147483647 → -9007199254740991
  • ✨ [Replaced] maximum validator of company.custom_properties*: 2147483647 → 9007199254740991

Changed operations

• Create an AML check (POST /v1/checks/aml), Retrieve an AML check (GET /v1/checks/aml/{id}), Review AML hits (PATCH /v1/checks/aml/{id}/hits/review), Review an AML check (PATCH /v1/checks/aml/{id}/review), Update an AML check monitoring (PATCH /v1/checks/aml/{id}/monitoring)
  • ✨ [Added] oneOf schema to data.settings in response body
  • ✨ [Added] possible values in data.settings.vendor: "comply_advantage_mesh
  • ✨ [Added] oneOf schema to data.vendor in response body
  • ✨ [Added] possible values in data.vendor.name: "comply_advantage_mesh
  • ✨ [Added] oneOf schema to data.hits[].vendor in response body
  • ✨ [Added] possible values in data.hits[]..name: "comply_advantage_mesh

Changed components schemas

• AmlHit
  • ✨ [Added] oneOf schema to vendor
• AmlCheckData
  • ✨ [Added] oneOf schema to settings
  • ✨ [Added] oneOf schema to vendor
  • ✨ [Added] oneOf schema to hits[].vendor
• AmlCheck
  • ✨ [Added] oneOf schema to data.settings
  • ✨ [Added] oneOf schema to data.vendor
  • ✨ [Added] oneOf schema to data.hits[].vendor
• AmlCheckWebhook
  • ✨ [Added] oneOf schema to check.data.settings
  • ✨ [Added] oneOf schema to check.data.vendor
  • ✨ [Added] oneOf schema to check.data.hits[].vendor

Changed operations

• List all activities (GET /v1/activities)
  • ✨ [Added] property ai_agent to data[].context in response body

Changed components schemas

• ActivityContext
  • ✨ [Added] property ai_agent
• Activity
  • ✨ [Added] property ai_agent to context

Changed operations

• Retrieve a case (GET /v1/cases/{id})
  • ✨ [Added] required property controls in response body

Changed components schemas

• CaseWebhook
  • ✨ [Added] required property controls to case
• Control
  • ✨ [Added]

Changed operations

• List all cases (GET /v1/cases)
  • ✨ [Added] required property last_contact_action_at to data[] in response body
• Create a case (POST /v1/cases), Retrieve a case (GET /v1/cases/{id}), Update a case (PATCH /v1/cases/{id})
  • ✨ [Added] required property last_contact_action_at in response body

Changed components schemas

• CaseWebhook
  • ✨ [Added] required property last_contact_action_at to case

Changed operations

• Retrieve a case (GET /v1/cases/{id})
  • ✨ [Added] required property wait_step_key to client_portal in response body
• Create a webhook (POST /v1/webhooks)
  • ✨ [Added] Add new webhook event Case.ClientPortalWaitStepTriggered
  • ✨ [Added] possible values of events[] in request body: "Case.ClientPortalWaitStepTriggered"
• Update a webhook (PATCH /v1/webhooks/{id})
  • ✨ [Added] possible values of events[] in request body: "Case.ClientPortalWaitStepTriggered"
• Complete client portal wait step (POST /v1/cases/{id}/complete-client-portal-wait-step)
  • ✨ [Added] operation POST /v1/cases/{id}/complete-client-portal-wait-step

Changed components schemas

• CaseWebhook
  • ✨ [Added] possible values of event: "Case.ClientPortalWaitStepTriggered"
  • ✨ [Added] required property wait_step_key to case.client_portal

Changed operations

• Retrieve case's documents (GET /v1/cases/{id}/documents)
  • ✨ [Added] possible values in query parameter type: "case_report"
  • ✨ [Added] possible values in query parameter type: "check__electronic_signature"
  • ✨ [Added] possible values of data[].type in response body: "case_report"
  • ✨ [Added] possible values of data[].type in response body: "check__electronic_signature"
  • ✨ [Added] possible values of data[].check.type in response body: "electronic_signature"

Changed operations

• List custom properties per entity type (GET /v1/custom-properties/{target_entity})
  • ✨ [Added] operation GET /v1/custom-properties/{target_entity}
• Get a custom property detail for a given entity type (GET /v1/custom-properties/{target_entity}/{key})
  • ✨ [Added] operation GET /v1/custom-properties/{target_entity}/{key}

Changed components schemas

• CustomPropertyNumericSettings, CustomPropertyChoicesSettings, CustomPropertyChoices, CustomPropertyOption, CustomPropertyCountriesSettings, CustomPropertyTextSettings, AbstractCustomProperty
  • ✨ [Added]

Changed operations

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