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

Paths

• Create a case (POST /v1/cases), Update a case (PATCH /v1/cases/{id})
  • ✨ [Added] property assignee_id in request body

Paths

• Retrieve a case (GET /v1/cases/{id})
  • ✨ [Added] required property is_relevant to companies[] in response body
• List all companies (GET /v1/companies)
  • ✨ [Added] required property is_relevant to data[] in response body
• Create a company (POST /v1/companies), Retrieve a company (GET /v1/companies/{id}), Update a company (PATCH /v1/companies/{id})
  • ✨ [Added] required property is_relevant in response body
• List all activities (GET /v1/activities)
  • ✨ [Added] possible values in query parameter type: "contact__marked_as_not_relevant__individual"
  • ✨ [Added] possible values in query parameter type: "api__marked_as_relevant__company"
  • ✨ [Added] possible values in query parameter type: "user__marked_as_relevant__company"
  • ✨ [Added] possible values in query parameter type: "api__marked_as_not_relevant__company"
  • ✨ [Added] possible values in query parameter type: "contact__marked_as_not_relevant__company"
  • ✨ [Added] possible values in query parameter type: "user__marked_as_not_relevant__company"
  • ✨ [Added] possible values of data[].type in response body: "contact__marked_as_not_relevant__individual"
  • ✨ [Added] possible values of data[].type in response body: "api__marked_as_relevant__company"
  • ✨ [Added] possible values of data[].type in response body: "user__marked_as_relevant__company"
  • ✨ [Added] possible values of data[].type in response body: "api__marked_as_not_relevant__company"
  • ✨ [Added] possible values of data[].type in response body: "contact__marked_as_not_relevant__company"
  • ✨ [Added] possible values of data[].type in response body: "user__marked_as_not_relevant__company"
• Create a webhook (POST /v1/webhooks)
  • ✨ [Added] Add new webhook event Company.InfoUpdated
  • ✨ [Added] Add new webhook event Company.MarkedAsNotRelevant
  • ✨ [Added] Add new webhook event Company.MarkedAsRelevant
  • ✨ [Added] possible values of events[] in request body: "Company.InfoUpdated"
  • ✨ [Added] possible values of events[] in request body: "Company.MarkedAsNotRelevant"
  • ✨ [Added] possible values of events[] in request body: "Company.MarkedAsRelevant"
• Update a webhook (PATCH /v1/webhooks/{id})
  • ✨ [Added] possible values of events[] in request body: "Company.InfoUpdated"
  • ✨ [Added] possible values of events[] in request body: "Company.MarkedAsNotRelevant"
  • ✨ [Added] possible values of events[] in request body: "Company.MarkedAsRelevant"
• Set company relevance (POST /v1/companies/{id}/set-relevant)
  • ✨ [Added] operation POST /v1/companies/{id}/set-relevant
• Return a list of all client portals (GET /v1/client-portals)
  • ✨ [Added] operation GET /v1/client-portals

Components schemas

• CaseWebhook
  • ✨ [Added] required property is_relevant to case.companies[]
• CompanyWebhook
  • ✨ [Added] required property is_relevant to company
  • ✨ [Added] property sub_event: "Company.InfoUpdated","Company.MarkedAsNotRelevant","Company.MarkedAsRelevant"

Paths

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

Components schemas

• IdVerificationCheckWebhook
  • ✨ [Added] required property ip_address to check.data.information

🚨 BREAKING CHANGES

Paths

• List all webhooks (GET /v1/webhooks)
  • 🚨 [Replaced] possible values in query parameter type: "zapier" → "system"
  • ✨ [Replaced] possible values of data[].type in response body: "zapier" → "system"
• Create a webhook (POST /v1/webhooks)
  • 🚨 [Replaced] possible values of type in request body: "zapier" → "system"
  • ✨ [Added] possible values of events[] in request body: "Individual.InfoUpdated"
  • ✨ [Replaced] possible values of type in response body: "zapier" → "system"
• Retrieve a webhook (GET /v1/webhooks/{id})
  • ✨ [Replaced] possible values of type in response body: "zapier" → "system"
• Update a webhook (PATCH /v1/webhooks/{id})
  • 🚨 [Replaced] possible values of type in request body: "zapier" → "system"
  • ✨ [Added] possible values of events[] in request body: "Individual.InfoUpdated"
  • ✨ [Replaced] possible values of type in response body: "zapier" → "system"

Components schemas

• CaseWebhook
  • ✨ [Added] property sub_event
• IndividualWebhook
  • ✨ [Added] property sub_event
• Webhook
  • 🚨 [Replaced] possible values of type: "zapier" → "system"

🚨 BREAKING CHANGES

Paths

• Retrieve a case (GET /v1/cases/{id})
  • 🚨 [Added] possible nullable value to companies[].country in response body: true
  • 🚨 [Added] possible nullable value to companies[].registration_number in response body: true
• List all companies (GET /v1/companies)
  • 🚨 [Added] possible nullable value to data[].country in response body: true
  • 🚨 [Added] possible nullable value to data[].registration_number in response body: true
• Create a company (POST /v1/companies)
  • ✨ [Added] possible nullable value to registration_number in request body: true
  • ✨ [Added] possible nullable value to country in request body: true
  • ✨ [Removed] required status from registration_number in request body
  • ✨ [Removed] required status from country in request body
  • 🚨 [Added] possible nullable value to country in response body: true
  • 🚨 [Added] possible nullable value to registration_number in response body: true
• Retrieve a company (GET /v1/companies/{id})
  • 🚨 [Added] possible nullable value to country in response body: true
  • 🚨 [Added] possible nullable value to registration_number in response body: true
• Update a company (PATCH /v1/companies/{id})
  • ✨ [Added] possible nullable value to registration_number in request body: true
  • ✨ [Added] possible nullable value to country in request body: true
  • 🚨 [Added] possible nullable value to country in response body: true
  • 🚨 [Added] possible nullable value to registration_number in response body: true

Components schemas

• CaseWebhook
  • 🚨 [Added] possible nullable value to case.companies[].country: true
  • 🚨 [Added] possible nullable value to case.companies[].registration_number: true
• CompanyWebhook, CompanyDeletedWebhook
  • 🚨 [Added] possible nullable value to company.country: true
  • 🚨 [Added] possible nullable value to company.registration_number: true
• AmlCheckWebhook, DocumentCheckWebhook, IdVerificationCheckWebhook, IdDocumentCheckWebhook, CheckDeletedWebhook
  • 🚨 [Added] possible nullable value to context.company.country: true

Paths

• Retrieve a case (GET /v1/cases/{id})
  • 📝 [Added] annotation (description) to individuals[].checks[]. in response body: ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.
  • 📝 [Added] annotation (description) to companies[].checks[]. in response body: ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.
• Create a company (POST /v1/companies), Retrieve a company (GET /v1/companies/{id}), Update a company (PATCH /v1/companies/{id}), 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] annotation (description) to checks[]. in response body: ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.
• List all checks (GET /v1/checks)
  • 📝 [Added] annotation (description) to data[]. in response body: ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.
• Create an ID Document check (POST /v1/checks/id_document), 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), 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), 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), 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] annotation (description) to status in response body: ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.

Components schemas

• CaseWebhook
  • 📝 [Added] annotation (description) to case.individuals[].checks[].: ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.
  • 📝 [Added] annotation (description) to case.companies[].checks[].: ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.
• IndividualWebhook
  • 📝 [Added] annotation (description) to individual.checks[].: ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.
• CompanyWebhook
  • 📝 [Added] annotation (description) to company.checks[].: ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.
• AmlCheckWebhook, DocumentCheckWebhook, IdVerificationCheckWebhook, IdDocumentCheckWebhook
  • 📝 [Added] annotation (description) to check.: ℹ️ Check status expired is deprecated and will be removed Q1'25. It will be replaced with an expired flag.

Paths

• List all cases (GET /v1/cases)
  • ✨ [Added] possible values in query parameter status: "draft"
  • ✨ [Added] possible values of data[].status in response body: "draft"
• Create a case (POST /v1/cases), Retrieve a case (GET /v1/cases/{id}), Update a case (PATCH /v1/cases/{id})
  • ✨ [Added] possible values of status in response body: "draft"
• List all activities (GET /v1/activities)
  • ✨ [Added] possible values of data[].context.case.status in response body: "draft"

Components schemas

• CaseWebhook
  • ✨ [Added] possible values of case.status: "draft"
• CaseReportWebhook, IndividualWebhook, IndividualDeletedWebhook, CompanyWebhook, CompanyDeletedWebhook, NoteWebhook, NoteCommentWebhook, AmlCheckWebhook, DocumentCheckWebhook, IdVerificationCheckWebhook, IdDocumentCheckWebhook, CheckDeletedWebhook
  • ✨ [Added] possible values of context.case.status: "draft"