Integração
Integração
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.
Parameter that defines the onboarding origin. Must be set to TRUST.
Your access token. See more in the 'Authentication' topic of this section.
Bearer your_token_hereType of onboarding. Possible values are PF, PJ or PF_PF.
PFValores possíveis: ID of the Query Template (configured in Trust Platform).
62b620ee3f07fb0009361111The 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.
6388ac6b409eff000804dadfID of the Query Template to be used in onboarding the related persons. Exclusive and required attribute for type PF_PF.
ID of the Query Template to be used for onboarding company partners. Exclusive and required attribute for type PJ.
The email address that the onboarding web link will be sent to.
[email protected]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
5551999999999Set 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.
trueOptional 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.
falseAdditional information can be sent to the onboarding.
Callback URL (webhook).
Success
Unique identifier of request.
6cb8093c-14ef-4fd1-810b-ee9fa5f9aae9Unique identifier of created onboarding link.
6021a21b3811c35ecb8dea20Token of created onboarding link.
0a8fb7b1c3eec7919967eXXXXXXXXXXURL link to access onboarding.
https://link-onbording?token=0a8fb7b1c3eec7919967eXXXXXXXXXXBad request
Unauthorized
Internal Server Error
Atualizado

