🚨 BREAKING CHANGES
These changes where announced in Upcoming changes Scheduled for October 28th, 2025
- 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)
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