Ubble · AsyncAPI Specification

Ubble Webhooks

Version

View Spec View on GitHub CompanyIdentity VerificationKYCAMLBiometricsFace AuthenticationDocument VerificationFraud PreventionComplianceFintechAsyncAPIWebhooksEvents

AsyncAPI Specification

Raw ↑
generated: '2026-07-21'
method: searched
source: https://docs.ubble.ai/docs/webhooks/
spec_type: Webhooks
notes: >-
  No AsyncAPI document is published; this is the documented webhook event catalog
  for the v2 Identities API. Webhook bodies follow the CloudEvents envelope
  (specversion, type, subject, id, time, datacontenttype, data). Deliveries are
  signed by default (Cko-Signature, ECDSA/SHA-512), sent with user agent
  CkoIdvNotifier from the cloudgouv-eu-west-1 (Outscale) region, expect a 200/201
  within 10 seconds, and are retried up to 2 times. Notifications can be
  re-triggered manually via the notify_* operations.
envelope:
  format: CloudEvents
  fields: [specversion, type, subject, id, time, datacontenttype, data]
security:
  signature_header: Cko-Signature
  algorithm: ECDSA with SHA-512
  docs: https://docs.ubble.ai/docs/api-standard/signature
  user_agent: CkoIdvNotifier
  ip_whitelisting: https://docs.outscale.com/en/userguide/OUTSCALE-Public-IPs.html
retry_policy:
  expected_response: 200 or 201 within 10 seconds
  max_retries: 2
  manual_trigger: notify_* operations (e.g. notify_identity_verification)
channels:
  - name: identity-verification
    docs: https://docs.ubble.ai/docs/webhooks/identity-verification
    data_fields: [applicant_id, external_applicant_id, user_journey_id, identity_verification_id, status, response_codes]
    events:
      - identity_verification_created
      - identity_verification_opened
      - identity_verification_started
      - identity_verification_reset
      - identity_verification_capture_completed
      - identity_verification_checks_completed
      - identity_verification_link_expired
      - identity_verification_capture_refused
      - identity_verification_capture_aborted
      - identity_verification_checks_inconclusive
      - identity_verification_retry_requested
      - identity_verification_closed
      - identity_verification_anonymized
      - identity_verification_audit_completed
      - identity_verification_report_created
  - name: id-document-verification
    docs: https://docs.ubble.ai/docs/webhooks/id-document-verification
    data_fields: [applicant_id, external_applicant_id, user_journey_id, id_document_verification_id, status, response_codes]
    events:
      - id_document_verification_created
      - id_document_verification_quality_checks_in_progress
      - id_document_verification_checks_in_progress
      - id_document_verification_checks_completed
      - id_document_verification_quality_checks_aborted
      - id_document_verification_checks_inconclusive
      - id_document_verification_retry_requested
      - id_document_verification_closed
      - id_document_verification_anonymized
      - id_document_verification_audit_completed
      - id_document_verification_report_created
  - name: face-authentication
    docs: https://docs.ubble.ai/docs/webhooks/face-authentication
    data_fields: [applicant_id, external_applicant_id, user_journey_id, face_authentication_id, status, response_codes]
    events:
      - face_authentication_created
      - face_authentication_opened
      - face_authentication_started
      - face_authentication_reset
      - face_authentication_capture_completed
      - face_authentication_checks_completed
      - face_authentication_link_expired
      - face_authentication_capture_refused
      - face_authentication_capture_aborted
      - face_authentication_checks_inconclusive
      - face_authentication_retry_requested
      - face_authentication_closed
      - face_authentication_anonymized
      - face_authentication_audit_completed
  - name: aml-verification
    docs: https://docs.ubble.ai/docs/webhooks/aml-verification
    data_fields: [applicant_id, external_applicant_id, aml_verification_id, status]
    events:
      - aml_verification_created
      - aml_verification_onboarding_started
      - aml_verification_onboarding_completed
      - aml_verification_onboarding_reviewed
      - aml_verification_monitoring_alert
      - aml_verification_monitoring_reviewed
      - aml_verification_status_changed
  - name: website-verification
    docs: https://docs.ubble.ai/docs/webhooks/website-verification
    data_fields: [applicant_id, external_applicant_id, user_journey_id, website_verification_id, website_url, status, response_codes]
    events:
      - website_verification_created
      - website_verification_checks_in_progress
      - website_verification_completed
      - website_verification_inconclusive
      - website_verification_closed
      - website_verification_anonymized