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

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

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": "Onboarding link created successfully.",
  "data": {
    "link": "text",
    "token": "text",
    "onboardingId": "text"
  }
}