Onboarding

Onboarding is a web flow offered by CAF to obtain data and documents of people or companies, providing agility and simplicity in onboarding new users. The product was designed to fit different types of registration. Therefore, the flow/steps and layout can be fully customised according to the customer's preference. In addition, we allow the creation of unlimited onboarding templates so that they can be used for different purposes.

The end user needing to be verified will start the onboarding steps directly on CAF hosted webpage which is presented to them through a client redirect URL or alternatively via email or SMS (with the CAF registration link). When all the defined registration steps have been completed by the user, a transaction is automatically initiated with the data obtained, and call back response with the result data shall be sent to your pre-configured webhook.

Each onboarding link can be created by the API or the CAF TRUST Platform with association to an onboarding template and pre-configured service query model.

Create Web Onboarding link

post

Submission of the necessary person or company data and the template model against which the verification services shall be executed, as well as the set of rules to be validated.

Query parameters

originstringRequired

Parameter that defines the onboarding origin. Must be set to TRUST.

Header parameters

AuthorizationstringRequired

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

Example: Bearer your_token_here

Body

typestring · enumRequired

Type of onboarding. Possible values are PF, PJ or PF_PF.

Example: PFPossible values:

transactionTemplateIdstringRequired

ID of the Query Template (configured in Trust Platform).

Example: 62b620ee3f07fb0009361111

templateIdstringOptional

The ID of the onboarding template that will be used, If the value is not provided then the onboarding template already associated with the given Query Template in Trust Platform will be used otherwise CAF default onboarding template shall be the fallback.

Example: 6388ac6b409eff000804dadf

transactionPFTemplateIdstringOptional

ID of the Query Template to be used in onboarding the related persons. Exclusive and required attribute for type PF_PF.

transactionQsaTemplateIdstringOptional

ID of the Query Template to be used for onboarding company partners. Exclusive and required attribute for type PJ.

emailstring · emailOptional

The email address that the onboarding web link will be sent to.

Example: [email protected]

smsPhoneNumberstringOptional

The cell phone number to which the link from the Onboarding Web will be sent, we must use the format: [country code][number including area code] *The SMS service will be charged according to the number of sends in the billing month

Example: 5551999999999

noExpirebooleanOptional

Set whether the weblink URL generated for the onboarding can be used only once or multiple times. When the value is set to true, the link will accept multiple registrations. By default, this is set to false.

Example: true

noNotificationbooleanOptional

Optional field, which avoids triggering an email or sms. Recommended if you use our web onb. inside an iFrame or WebView. By default, this is set to false.

Example: false

variablesobjectOptional

Additional information can be sent to the onboarding template for prefilling. There is a limit of 20 attributes and "token" variable is reserved for internal use.

metadataobjectOptional

Additional information can be sent to the onboarding.

_callbackUrlstringOptional

Callback URL (webhook).

Responses

200

Success

application/json

400

Bad request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/onboardings HTTP/1.1
Host: api.combateafraude.com
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 415

{
  "type": "PF",
  "transactionTemplateId": "62b620ee3f07fb0009361111",
  "templateId": "6388ac6b409eff000804dadf",
  "transactionPFTemplateId": null,
  "transactionQsaTemplateId": null,
  "email": "[email protected]",
  "smsPhoneNumber": "5551999999999",
  "noExpire": true,
  "noNotification": false,
  "variables": {},
  "metadata": {},
  "_callbackUrl": "text",
  "attributes": {
    "name": "Jhon Doe",
    "birthDate": "dd/MM/yyyy",
    "cpf": "00011122233",
    "cnpj": "00111222333344"
  }
}

{
  "requestId": "6cb8093c-14ef-4fd1-810b-ee9fa5f9aae9",
  "id": "6021a21b3811c35ecb8dea20",
  "token": "0a8fb7b1c3eec7919967eXXXXXXXXXX",
  "url": "https://link-onbording?token=0a8fb7b1c3eec7919967eXXXXXXXXXX"
}