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

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

POSThttps://api.public.caf.io/v1/onboardings/links

Header parameters

Body

application/json

workflowId*string

Workflow identifier

linkConfigurationobject

Link configuration

onboardingDataobject

Variables configured for an onboarding template may be set here

metadataobject

Informative data

Response

200400401404500

Success

Body

application/json

requestIdstring

messagestring

dataobject

Response data.

Request

JavaScriptCurlPython

const response = await fetch('https://api.public.caf.io/v1/onboardings/links', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "workflowId": "text"
    }),
});
const data = await response.json();

Response

200400401404500

{
  "requestId": "text",
  "message": "Onboarding link created successfully.",
  "data": {
    "link": "text",
    "token": "text",
    "onboardingId": "text"
  }
}