Getting started
Remote
Include the .js file directly from the CDN:
Current versions
Identity
Stable
Utilization
Creating an SDK instance
The SDK's constructor method takes the Identity token as a parameter (see how to get yours here). In addition, you can optionally enter the SDK's initialization options.
Example using import via CDN:
Options
parameters:
Options
parameters:Field
Type
Required?
Description
mobileToken
string
No*
throwOnRecall
boolean
No
Indicates whether, when called a second time without the first call having completed, the SDK should throw an error. If not entered or entered false, the SDK returns the existing Promise without triggering an error. If true, the SDK rejects the Promise on the second call.
theme
object
No
smsLabel
object
No
emailLabel
object
No
pendingPageSettings
object
No
faceLivenessSettings
object
No
authIcon
string
No
Icon used at the top of the authentication screens
enableTimer
boolean
No
Enables or disables the timer in case of SMS and E-mail validation
language
string
No
Defines the used language on SDK's texts default: pt-BR
metadata
string
No
This field only accepts strings formatted in JSON. Therefore, when submitting data to this field, the string must be in valid JSON format.
*You must inform mobileToken when you are using facial authentication in your policy
Theme
parameters:
Theme
parameters:Field
Type
Required?
Description
closeButton
string
No
Color used in the close button
checkmark
string
No
Color used in the checkMark button
loader
string
No
Color used in the loader button
buttonSuccessColor
string
No
Color used in the success button
inputSuccessColor
string
No
Color used in code input
buttonFinishColor
string
No
Color used in code input
timerBackgroundColor
string
No
Color used in the background of the timer if it is active
timerColor
string
No
Color used in the timer text if it is active
pendingIconSvg
string
No
Icon used in the pending context warning screen
Label
parameters:
Label
parameters:Field
Type
Required?
Description
enable
string
No
Enables or disables the label
link
string
No
Redirection link
text
string
No
Text used in the label
pendingPageSettings
parameters:
pendingPageSettings
parameters:Field
Type
Required?
Description
pendingIconSvg
string
No
Changes the icon showed when the PendingPage
is open
titleText
string
No
Title of the PendingPage
descriptionText
string
No
Description of the PendingPage
buttonContentText
string
No
Text used in the PendingPage
confirm button
faceLivenessSettings
parameters:
faceLivenessSettings
parameters:Field
Type
Required?
Description
permissionButton
object
No
startButton
object
No
styles
parameters:
styles
parameters:Field
Type
Required?
Description
label
string
No
Changes text on button
color
string
No
Changes color of text on button
backgroundColor
string
No
Changes color of background
borderRadius
string
No
Changes border radius
border
string
No
Changes border
Exemple:
Calling the SDK:
To verify a user, use the verifyPolicy
method, available in the SDK instance.
You must enter the user's CPF and the policy ID to be used.
Starting from version 0.0.29, our response includes the attemptId of the attempt. This is due to the integration with the API we provide for information retrieval, which can be accessed here.
The attemptId can be returned in two ways: if isAuthorized is true, the attemptId will be included within the attestation token; if isAuthorized is false, the attemptId will be returned along with the isAuthorized field.
Please note that the attestation and attemptId fields may or may not be present in the response, depending on the executed flow.
Last updated