Links

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

linkConfigurationobjectOptional

Link configuration

onboardingDataobjectOptional

Variables configured for an onboarding template may be set here

metadataobjectOptional

Informative data

Responses

application/json

objectOptional

application/json

application/json

application/json

application/json

post

HTTPcURLJavaScriptPython

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"
  }
}