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

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.

post

/onboardings

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.

Body

transactionTemplateIdstringrequired

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

Example: 62b620ee3f07fb0009361111

templateIdstring

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

transactionPFTemplateIdstring

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

transactionQsaTemplateIdstring

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

emailstring · email

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

Example: [email protected]

smsPhoneNumberstring

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

noExpireboolean

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

noNotificationboolean

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

variablesobject

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.

metadataobject

Additional information can be sent to the onboarding.

_callbackUrlstring

Callback URL (webhook).

typestring · enumrequired

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

Example: PF

Options: PF, PJ, PF_PF

attributesobject

Additional information that can be submitted with the onboarding link.

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.combateafraude.com/v1/onboardings?origin=text' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{"transactionTemplateId":"62b620ee3f07fb0009361111","templateId":"6388ac6b409eff000804dadf","transactionPFTemplateId":null,"transactionQsaTemplateId":null,"email":"[email protected]","smsPhoneNumber":"5551999999999","noExpire":true,"noNotification":false,"variables":{},"metadata":{},"type":"PF","attributes":{"name":"Jhon Doe","birthDate":"dd/MM/yyyy","cpf":"00011122233","cnpj":"00111222333344"}}'

200

400

401

500

200

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

Success