Methods

See how to customize the SDK even more

mount

function(): void

It is responsible for mounting the SDK and should be called after configuration.

Example:

verifyDocument

function({ cpf: '99999999999' }): void

Responsible for starting the verification process programmatically wherever you want in your code.

Show params

cpf

string

required

CPF to be verified Example: 99999999999

phone

string

Phone number Example: 99999999999

referenceId

string

Reference ID, any string that you want to use to identify the verification Example: my-reference-id

Example:

setLang

function(lang: 'pt' | 'en' | 'es'): void

It is responsible for changing the language of the OCR + Facematch validation flow.

Example:

changeFieldId

function(params: object): void

It is responsible for changing the id of the enriched fields.

Show params

fieldName

string

required

Field name

Click here to see the available fields.

fieldId

string

required

New field id

Example: my-custom-id

Example:

changeActionId

function(params: object): void

It is responsible for changing the id of the elements that trigger the actions.

Show params

actionName

string

required

Action name

Click here to see the available fields.

actionId

string

required

New id of the element that triggers the action

Example: my-custom-id

Example:

setWithdraw

function(value: number | string): void

Accept formats like: R$ 1,23, R$ 1.23, 1.23, 1,23, 123.

Example:

setBalance

function(value: number | string): void

Accept formats like: R$ 1,23, R$ 1.23, 1.23, 1,23, 123.

Example:

closeModal

function(): void

It is responsible for closing the OCR + Facematch validation modal.

Example: