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

post

/links

Header parameters

Authorizationstringrequired

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

Body

workflowIdstringrequired

Workflow identifier

onboardingDataobject

Variables configured for an onboarding template may be set here

metadataobject

Informative data

linkConfigurationobject

Link configuration

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.public.caf.io/v1/onboardings/links' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"workflowId":"text","onboardingData":{},"metadata":{},"linkConfiguration":{}}'

200

400

401

404

500

200

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

Success