Paths

• List all companies (GET /v1/individuals)
  • ✨ [Added] operation GET /v1/individuals

Components schemas

• IndividualList
  • ✨ [Added]

Paths

• List all companies (GET /v1/companies)
  • ✨ [Added] operation GET /v1/companies

Components schemas

• CompanyList
  • ✨ [Added]

🚨 BREAKING CHANGES: Remove webhook events "Case.TagsAdded" and "Case.TagsRemoved"

Paths

• List countries (GET /v1/company-data/countries)
  • ✨ [Added] possible values in query parameter vendor: "kyckr"
  • ✨ [Added] possible values of data[].vendor in response body: "kyckr"
• Retrieve a company vendor data (GET /v1/companies/{id}/vendor-data)
  • ✨ [Added] possible values in query parameter name: "kyckr"
  • ✨ [Added] possible values of data[].name in response body: "kyckr"
• Retrieve a case (GET /v1/cases/{id})
  • ✨ [Added] required property is_delegator to individuals[] in response body
• Create an individual (POST /v1/individuals), Update an individual (PATCH /v1/individuals/{id})
  • ✨ [Added] required property is_delegator in request body
  • ✨ [Added] property is_delegator to individuals in response body
• Retrieve an individual (GET /v1/individuals/{id}), Set individual relevance (POST /v1/individuals/{id}/set-relevant)
  • ✨ [Added] required property is_delegator to individuals in response body
• Create a webhook (POST /v1/webhooks), Update a webhook (PATCH /v1/webhooks/{id})
  • 🚨 [Removed] possible values of events[] in request body: "Case.TagsAdded"
  • 🚨 [Removed] possible values of events[] in request body: "Case.TagsRemoved"

Components schemas

• CaseWebhook
  • 🚨 [Removed] possible values of event: "Case.TagsAdded"
  • 🚨 [Removed] possible values of event: "Case.TagsRemoved"
  • ✨ [Added] required property is_delegator to case.individuals[]

Paths

• Retrieve a case (GET /v1/cases/{id})
  • ✨ [Added] query parameter exclude_internal_checks
  • ✨ [Added] required property is_internal to companies[].checks[] in response body
• Create a company (POST /v1/companies), Update a company (PATCH /v1/companies/{id})
  • ✨ [Added] required property is_internal to checks[] in response body
• Retrieve a company (GET /v1/companies/{id})
  • ✨ [Added] query parameter exclude_internal_checks
  • ✨ [Added] required property is_internal to checks[] in response body
• Create an individual (POST /v1/individuals), Update an individual (PATCH /v1/individuals/{id})
  • ✨ [Added] required property is_internal to checks[] in response body
• Retrieve an individual (GET /v1/individuals/{id})
  • ✨ [Added] query parameter exclude_internal_checks
  • ✨ [Added] required property is_internal to checks[] in response body
• Set individual relevance (POST /v1/individuals/{id}/set-relevant)
  • ✨ [Added] required property is_internal to checks[] in response body
• List all checks (GET /v1/checks)
  • ✨ [Added] query parameter exclude_internal
  • ✨ [Added] required property is_internal to data[] in response body
• 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 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_internal in response body
• 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 signature_file_id to data.information in response body
  • ✨ [Added] required property is_internal in response body
• 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 is_internal to data.settings.custom_document_type in response body
  • ✨ [Added] required property is_internal in response body
• List all custom document types (GET /v1/custom_document_types)
  • ✨ [Added] required property is_internal to data[] in response body

Components schemas

• CaseWebhook
  • ✨ [Added] required property is_internal to case.individuals[].checks[]
  • ✨ [Added] required property is_internal to case.companies[].checks[]

Paths

• List all cases (GET /v1/cases)
  • ✨ [Added] possible values of data[].flags[] in response body: "first_collect_completed"
  • ✨ [Added] required property contact_has_actions to data[] in response body
  • ✨ [Added] required property reviewer_has_actions 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] possible values of flags[] in response body: "first_collect_completed"
  • ✨ [Added] required property contact_has_actions in response body
  • ✨ [Added] required property reviewer_has_actions in response body
• 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)
  • ✨ [Replaced] default value of data.settings.mode in response body: "expert" → "auto"

Components schemas

• CaseWebhook, CaseReportWebhook, IndividualWebhook, IndividualDeletedWebhook, CompanyWebhook, CompanyDeletedWebhook, NoteWebhook, NoteCommentWebhook, AmlCheckWebhook, DocumentCheckWebhook, IdVerificationCheckWebhook, IdDocumentCheckWebhook, CheckDeletedWebhook
  • ✨ [Added] possible values of case.flags[]: "first_collect_completed"
  • ✨ [Added] required property contact_has_actions to case
  • ✨ [Added] required property reviewer_has_actions to case
• WebhookContextCase
  • ✨ [Added] possible values of flags[]: "first_collect_completed"
  • ✨ [Added] required property contact_has_actions
  • ✨ [Added] required property reviewer_has_actions
• CaseReportWebhookContext, IndividualWebhookContext, IndividualDeletedWebhookContext, CompanyWebhookContext, CompanyDeletedWebhookContext, NoteWebhookContext, NoteCommentWebhookContext, CheckWebhookContext, CheckDeletedWebhookContext
  • ✨ [Added] possible values of case.flags[]: "first_collect_completed"
  • ✨ [Added] required property case.contact_has_actions
  • ✨ [Added] required property case.reviewer_has_actions

Paths

• Create an ID Verification check (POST /v1/checks/id_verification)
  • ✨ [Added] possible values of settings.mode in request body: "auto"
  • ✨ [Added] property vendor to settings in request body: "ubble","checkout"
  • ✨ [Added] possible values of data.settings.mode in response body: "auto"
  • ✨ [Replaced] default value of data.settings.mode in response body: "liveness" → "expert"
  • ✨ [Added] property vendor to data.settings in response body: "ubble","checkout"
  • ✨ [Added] required status to data.settings.vendor in response body
  • ✨ [Removed] default value from data.vendor.name in response body: "ubble"
  • ✨ [Added] possible values of data.vendor.name in response body: "ubble"
• Retrieve an ID Verification check (GET /v1/checks/id_verification/{id}), Review an ID Verification check (PATCH /v1/checks/id_verification/{id}/review)
  • ✨ [Added] possible values of data.settings.mode in response body: "auto"
  • ✨ [Replaced] default value of data.settings.mode in response body: "liveness" → "expert"
  • ✨ [Added] property vendor to data.settings in response body: "ubble","checkout"
  • ✨ [Added] required status to data.settings.vendor in response body
  • ✨ [Removed] default value from data.vendor.name in response body: "ubble"
  • ✨ [Added] possible values of data.vendor.name in response body: "ubble"
• List all activities (GET /v1/activities)
  • ✨ [Added] possible values of data[].context.vendor in response body: "checkout"
• Refresh an ID Verification check url (POST /v1/checks/id_verification/{id}/refresh_url)
  • ✨ [Added] operation POST /v1/checks/id_verification/{id}/refresh_url

Paths

• Create a webhook (POST /v1/webhooks), Update a webhook (PATCH /v1/webhooks/{id})
  • ⚠️ [Deprecated]:Event Case.TagsAdded, replaced by event Case.TagsUpdated
  • ⚠️ [Deprecated]:Event Case.TagsRemoved, replaced by event Case.TagsUpdated
  • ✨ [Added] possible values of events[] in request body: "Case.TagsUpdated"
• Retrieve case's notes (GET /v1/cases/{id}/notes)
  • ✨ [Added] property note_id to data[].comments[] in response body
  • ✨ [Added] property author_type to data[].comments[] in response body: "user","api"
  • ✨ [Added] required status to data[].comments[].note_id in response body
  • ✨ [Added] required status to data[].comments[].author_type in response body
  • ✨ [Added] property case_id to data[] in response body
  • ✨ [Added] property author_type to data[] in response body: "user","api"
  • ✨ [Added] required status to data[].case_id in response body
  • ✨ [Added] required status to data[].author_type in response body
• Create a note (POST /v1/notes)
  • ✨ [Added] operation POST /v1/notes
• Create a note comment (POST /v1/notes/{id}/comments)
  • ✨ [Added] operation POST /v1/notes/{id}/comments

Paths

• List all activities (GET /v1/activities)
  • ✨ [Added] possible values in query parameter type: "api__deleted__check"
  • ✨ [Added] possible values of data[].type in response body: "api__deleted__check"
• Delete a check (DELETE /v1/checks/{id})
  • ✨ [Added] operation DELETE /v1/checks/{id}

Paths

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

New risk level "critical"

You can now enable a fifth risk level "critical" in your workspace settings.

• List all cases (GET /v1/cases)
  • ✨ [Added] possible values of data[].risk.level in response body: "critical"
• Create a case (POST /v1/cases), Update a case (PATCH /v1/cases/{id}), Retrieve a case (GET /v1/cases/{id})
  • ✨ [Added] possible values of risk.level in response body: "critical"
• Create an automatic risk (POST /v1/cases/{id}/risks)
  • ✨ [Added] possible values of level in request body: "critical"
  • ✨ [Added] possible values of risk.level in response body: "critical"
• List all activities (GET /v1/activities)
  • ✨ [Added] possible values of data[].context.risk.level in response body: "critical"

Set reviewed_at when creating a Case review

• Create a case review (POST /v1/cases/{id}/reviews)
  • ✨ [Added] property reviewed_at in request body

Custom property improvements

Increase the maxLength for text custom property to 250. It was previously 100 but not documented.

• Create a case (POST /v1/cases), Update a case (PATCH /v1/cases/{id})
  • ✨ [Added] maxLength validator to custom_properties{.*} in request body: 250
  • ✨ [Added] maxLength validator to custom_properties{.*} in response body: 250
• Retrieve a case (GET /v1/cases/{id})
  • ✨ [Added] maxLength validator to custom_properties{.*} in response body: 250
  • ✨ [Added] maxLength validator to individuals[].custom_properties{.*} in response body: 250
  • ✨ [Added] maxLength validator to companies[].custom_properties{.*} in response body: 250
• 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})
  • ✨ [Added] maxLength validator to custom_properties{.*} in request body: 250
  • ✨ [Added] maxLength validator to custom_properties{.*} in response body: 250
• Retrieve a company (GET /v1/companies/{id}), Retrieve an individual (GET /v1/individuals/{id}), Set individual relevance (POST /v1/individuals/{id}/set-relevant)
  • ✨ [Added] maxLength validator to custom_properties{.*} in response body: 250

Address in company data operations

• Search companies (GET /v1/company-data/search)
  • ✨ [Added] required status to street_address, street_address_2, postal_code, city, state, region, country in data[].address in response body
• Fetch company data (GET /v1/company-data/fetch/{search_ref})
  • ✨ [Added] required status to street_address, street_address_2, postal_code, city, state, region, country in address in response body
  • ✨ [Added] required status to street_address, street_address_2, postal_code, city, state, region, country in merged_individuals[].address in response
  • ✨ [Added] required status to street_address, street_address_2, postal_code, city, state, region, country in merged_companies[].address in response body