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.