Smart Auth
Last updated
Last updated
Include the .js file directly from the CDN:
Identity
Beta
Identity
Stable
The SDK's constructor method takes the Identity token as a parameter (see how to get yours ). In addition, you can optionally enter the SDK's initialization options.
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
smsSettings
object
No
emailSettings
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
enableLocationRetry
boolean
No
Enables retry on geolocation collect, without high accuracy on second try. The default value is false.
timerPosition
string
No
Position of timer in case of SMS and E-mail validation (can be "DOWN" or "UP" )
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: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
buttonSuccessTextColor
string
No
Color used in text of 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
modalBackgroundColor
string
No
Color used in background of the authentication modal
textColor
string
No
Color used in text of the authentication modal
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: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:Field
Type
Required?
Description
permissionButton
object
No
startButton
object
No
titleText
string
No
Title of the faceLivenessPage
subtitleText
string
No
Subtitle of the faceLivenessPage
descriptionText
string
No
Description of the faceLivenessPage
smsSettings
parameters:Field
Type
Required?
Description
titleText
string
No
Title of the smsCodePage
subtitleText
string
No
Subtitle of the smsCodePage
buttonContentText
string
No
Text used in the smsCodePage
confirm button
emailSettings
parameters:Field
Type
Required?
Description
titleText
string
No
Title of the emailCodePage
subtitleText
string
No
Subtitle of the emailCodePage
buttonContentText
string
No
Text used in the emailCodePage
confirm button
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.
A valid for passive proof of life in mobile SDKs.
To see all the parameters available in the theme
.
To see all the parameters available in the label
.
To see all the parameters available in the label
.
To see all the parameters available in the pendingPageSettings
.
Define face authentication styles faceLivenessSettings
.
Define sms authentication styles smsSettings
.
Define email authentication styles emailSettings
.
Changes the permission button styles
.
Changes start button styles
.
You must enter the user's CPF and 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 .