LogoLogo
Useful links
  • Home
  • Product guides
  • API
  • SDKs
  • Overview
  • CORE API
    • Authentication
    • Available resources
      • Transaction
      • Onboarding
      • Profile
      • Synchronous services
        • OCR Sync
        • Basic Data Sync (Individual)
    • Transaction details
      • Services
        • Document OCR
        • Documentscopy
        • Face Liveness
        • Facematch
        • Facial Biometrics
        • Private Faceset
        • Shared Faceset
        • Document Liveness
      • Background check
        • Data structure
        • KYC
          • Driver
          • Financial
          • Labor
          • Register data
          • Relationships
          • Risk
        • KYB
          • Financial
          • Labor
          • Register data
          • Risk
        • Vehicle
          • Register data
      • Validation rules
      • Manual reprovals
    • Webhooks
      • Transaction
      • Profile
      • Face authentication
  • MOBILE API
    • Authentication
    • Available resources
      • Face liveness (deprecated)
      • Face registration (deprecated)
      • Face authentication (deprecated)
    • Response signature
  • GLOBAL API
    • Authentication
    • Available resources
      • Services
        • Company search
        • Company record
        • Basic Data Sync (Individual)
        • Sanctions
      • Orchestrations
        • Transactions
          • Services
            • KYB
              • Credit Report
              • Business Identity
            • KYC
              • Adverse Media
              • PEPs
              • Sanctions
              • Warnings
              • Global identity verification
              • Global identity double verification
            • DOC ID
              • Global Document Verification
      • Onboardings
        • Links
    • Webhooks
  • SMART AUTH API
    • Authentication
    • Available resources
      • Authentications
      • Create identity
  • Joint resolution 6 API
    • Authentication
    • Available resources
      • Suspected fraud creation
      • Suspected fraud query
      • Suspected fraud update
      • Suspected fraud deletion
    • Using mTLS
    • Changelog
LogoLogo

2025 © Caf. - All rights reserved

On this page
  • Base URL
  • Onboarding Links
  1. GLOBAL API
  2. Available resources

Onboardings

Last updated 2 months ago

Onboarding is a web flow offered by CAF to obtain data and documents from people or companies, providing agility and simplicity in onboarding new users.

The product was designed to fit different types of registration. Therefore, the flow/steps and layout can be fully customised according to the customer's preference. In addition, we allow the creation of unlimited onboarding templates so that they can be used for different purposes.

The end user needing to be verified will start the onboarding steps directly on CAF hosted webpage which is presented to them through a client redirect URL or alternatively via email or SMS (with the CAF registration link). When all the defined registration steps have been completed by the user, a transaction is automatically initiated with the data obtained, and a call back response with the result data shall be sent to your pre-configured webhook.

Each onboarding link can be created by the API or the CAF TRUST Platform with association to an onboarding template and pre-configured workflow.

Base URL

Global API Onboardings Base URL:
https://api.public.caf.io/v1/onboardings

Onboarding Links

Generates an onboarding link based on a workflowId, the link returned can be used to onboard a person or company

API reference:

Links