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
  1. GLOBAL API
  2. Available resources
  3. Onboardings

Links

Last updated 2 months ago

The onboarding links is capable of generating an onboarding link that can be accessed on the browser. The same process can be done through CAF TRUST platform.

You need to inform the workflowId in order to generate an onboarding link. Please note that any configuration needed such as the onboarding template will be extracted from the associated workflow

Creates an onboarding link

post

Creates an onboarding link based on a workflowId. Permission required: Onboardings Create

Header parameters
AuthorizationstringRequired

Customer access token. See more in the 'Authentication' topic of this section.

Body
workflowIdstringRequired

Workflow identifier

onboardingDataobjectOptional

Variables configured for an onboarding template may be set here

metadataobjectOptional

Informative data

Responses
200
Success
application/json
400
Bad request
application/json
401
Unauthorized
application/json
404
Transaction not found
application/json
500
Internal Server Error
application/json
post
POST /v1/onboardings/links HTTP/1.1
Host: api.public.caf.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "workflowId": "text",
  "linkConfiguration": {
    "expires": true,
    "phone": "text",
    "email": "text",
    "notifyUser": true,
    "smsMessage": "text"
  },
  "onboardingData": {},
  "metadata": {}
}
{
  "requestId": "text",
  "message": "text",
  "data": {
    "link": "text",
    "token": "text",
    "onboardingId": "text"
  }
}