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"

Paths

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

Components schemas

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

Paths

• List all activities (GET /v1/activities)
  • ✨ [Added] possible values in query parameter type: "contact__created__case"
  • ✨ [Added] possible values in query parameter type: "contact__updated_info__case"
  • ✨ [Added] possible values in query parameter type: "workflow__updated_template__case"
  • ✨ [Added] possible values in query parameter type: "contact__updated_metadata__case"
  • ✨ [Added] possible values in query parameter type: "workflow__added_tags__case"
  • ✨ [Added] possible values in query parameter type: "contact__updated__case_relation"
  • ✨ [Added] possible values in query parameter type: "contact__created__individual"
  • ✨ [Added] possible values in query parameter type: "contact__updated__individual"
  • ✨ [Added] possible values in query parameter type: "contact__created__company"
  • ✨ [Added] possible values in query parameter type: "contact__updated__company"
  • ✨ [Added] possible values in query parameter type: "contact__started__check"
  • ✨ [Added] possible values in query parameter type: "workflow__started__check"
  • ✨ [Added] possible values in query parameter type: "contact__set_review_needed__check"
  • ✨ [Added] possible values in query parameter type: "contact__completed_forms__client_portal"
  • ✨ [Added] possible values in query parameter type: "contact__completed_checks__client_portal"
  • ✨ [Added] property client_portal to data[].context in response body

Components schemas

• Activity
  • ✨ [Added] possible values of author_type: "contact"
  • ✨ [Added] possible values of author_type: "workflow"

Paths

• Create a Document check (POST /v1/checks/document)
  • ⚠️ [Added] deprecated status to document_type and custom_document_type_id in settings in request body
  • ✨ [Added] property document_type_key to settings in request body
  • ✨ [Added] required property key to data.settings.custom_document_type in response body
• 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 key to data.settings.custom_document_type in response body
• List all custom document types (GET /v1/custom_document_types)
  • ✨ [Added] query parameter key
  • ✨ [Added] required property key to data[] in response body

Components schemas

• DocumentCheckWebhook
  • ✨ [Added] required property key to check.data.settings.custom_document_type

Deprecation warnings

Document check

We have introduce a new attribute key on custom document type and you can now use it to create your Document check directly in settings.document_type_key. This will help integrator to have more resilient and consistent integration across multiple workspaces and avoid storing custom document types (to have the id) on their side for each environments.

Thus, we have deprecated the document check creation using custom document type id (settings.custom_document_type_id is deprecated) and also the settings.document_type for default document type.

The recommended way is now to always use settings.document_type_key.

These attributes will be completely removed at the end of 2024.

Ubble vendor

Ubble is now Checkout and they will shutdown their API at end of 2024. We already have integrated Checkout to replace Ubble and we strongly recommend you switch to Checkout as soon as possible.

On the workspace settings > Checks > Identity Verification, make sure you have a Checkout product selected (and not Ubble).

On your API integration, on your Create an ID Verification call make sure you don’t have settings.vendor that is defined to ubble.

Ubble as an Identity verification vendor will be removed as a valid option at the end of 2024.

NOTE: All legacy data of Identity verification done with Ubble will be kept.

Paths

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

Paths

• Retrieve a case (GET /v1/cases/{id})
  • ✨ [Added] required property entity_legal_form to companies[] in response body
  • ✨ [Added] required property entity_legal_form_label to companies[] in response body
• Fetch company data (GET /v1/company-data/fetch/{search_ref})
  • ✨ [Added] required property entity_legal_form to beneficial_owners[] in response body
  • ✨ [Added] required property entity_legal_form_label to beneficial_owners[] in response body
  • ✨ [Added] required property entity_legal_form to shareholders[] in response body
  • ✨ [Added] required property entity_legal_form_label to shareholders[] in response body
  • ✨ [Added] required property entity_legal_form to legal_representatives[] in response body
  • ✨ [Added] required property entity_legal_form_label to legal_representatives[] in response body
  • ✨ [Added] required property entity_legal_form to merged_companies[] in response body
  • ✨ [Added] required property entity_legal_form in response body
  • ✨ [Added] required property entity_legal_form_label in response body
• List all companies (GET /v1/companies)
  • ✨ [Added] required property entity_legal_form to data[] in response body
  • ✨ [Added] required property entity_legal_form_label to data[] in response body
• Create a company (POST /v1/companies), Update a company (PATCH /v1/companies/{id})
  • ✨ [Added] property entity_legal_form in request body
  • ✨ [Added] required property entity_legal_form in response body
  • ✨ [Added] required property entity_legal_form_label in response body
• Retrieve a company (GET /v1/companies/{id})
  • ✨ [Added] required property entity_legal_form in response body
  • ✨ [Added] required property entity_legal_form_label in response body
• List entity legal forms (GET /v1/company-data/entity-legal-forms)
  • ✨ [Added] operation GET /v1/company-data/entity-legal-forms

Components schemas

• CaseWebhook
  • ✨ [Added] required property entity_legal_form to case.companies[]
  • ✨ [Added] required property entity_legal_form_label to case.companies[]
• CompanyWebhook
  • ✨ [Added] required property entity_legal_form to company
  • ✨ [Added] required property entity_legal_form_label to company
• EntityLegalForm
  • ✨ [Added]

Paths

• Create a webhook (POST /v1/webhooks)
  • ✨ [Added] Add new webhook event Case.ContactHasActionsUpdated
  • ✨ [Added] Add new webhook event Case.ReviewerHasActionsUpdated
  • ✨ [Added] Add new webhook event Individual.MarkedAsRelevant
  • ✨ [Added] Add new webhook event Individual.MarkedAsNotRelevant
  • ✨ [Added] possible values of events[] in request body: "Case.ContactHasActionsUpdated"
  • ✨ [Added] possible values of events[] in request body: "Case.ReviewerHasActionsUpdated"
  • ✨ [Added] possible values of events[] in request body: "Individual.MarkedAsRelevant"
  • ✨ [Added] possible values of events[] in request body: "Individual.MarkedAsNotRelevant"
• Update a webhook (PATCH /v1/webhooks/{id})
  • ✨ [Added] possible values of events[] in request body: "Case.ContactHasActionsUpdated"
  • ✨ [Added] possible values of events[] in request body: "Case.ReviewerHasActionsUpdated"
  • ✨ [Added] possible values of events[] in request body: "Individual.MarkedAsRelevant"
  • ✨ [Added] possible values of events[] in request body: "Individual.MarkedAsNotRelevant"

Components schemas

• CaseWebhook
  • ✨ [Added] possible values of event: "Case.ContactHasActionsUpdated"
  • ✨ [Added] possible values of event: "Case.ReviewerHasActionsUpdated"
• IndividualWebhook
• • ✨ [Added] possible values of event: "Individual.MarkedAsRelevant"
  • ✨ [Added] possible values of event: "Individual.MarkedAsNotRelevant"

Paths

• Share client portal link (POST /v1/cases/{id}/share-client-portal-link)
  • ✨ [Added] operation POST /v1/cases/{id}/share-client-portal-link

Components schemas

• CaseShareClientPortalLinkResponseBusinessContact
  • ✨ [Added]

Paths

• Create a webhook (POST /v1/webhooks)
  • ✨ [Added] Add new webhook event Case.TagsUpdated

Components schemas

• CaseWebhook
  • ✨ [Added] possible values of event: "Case.TagsUpdated"

Paths

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