DocumentDetector
Importing SDK
To use DocumentDetector, you can either remotely import the .js
file or download it locally.
Remotely
Include the .js
file directly from the CDN:
You can retrieve the class from the SDK using the following code:
Locally
Download the .js
file and import it as an ES6 module:
Construction
In the builder, the SDK receives a single parameter with the settings:
Supported parameters
Parameter | Required? |
Authentication token for consuming the SDK. | Yes. |
Default message language, valid values: en_US, en_BR, es_MX. | No. The default is |
Analytics Configuration Objects. | No. |
Parameter responsible for enabling or disabling analytics. | No. |
Unique id that we are going to save the information from this SDK execution. | No. |
We accept an information object. | No. |
Flag indicating whether execution on desktops should be blocked. | No. The default is |
Flag indicating whether advanced capture should be disabled*. | No. The default is |
Customization of the capture icon accepts values such as image URL or base64 SVGs. | No |
Customization of the icon size for the captureButtonIcon field. | No |
Customization of the default image capture button color. | No |
Customization of the camera switch icon accepts values such as image URL or base64 SVGs. | No |
Customization of the icon size for the switchButtonIcon field. | No |
Customization of the color of the default camera switching icon. | No |
Changes the font for all elements contained in the SDK. | No. The pattern is inherited from the page |
Customization of the image processing message. | No. The default is |
Customization of the invalid document message. | No. The default is |
Customization of the incorrect side message by selecting a front or back side and capturing both sides. | No. The default is |
Customization of the incorrect side message. | No. The default is |
Customization of the API return message for poor image quality. | No. The default is |
Customization of the capture failure message. | No. The default is |
* Advanced capture consists of using more complex and not-so-stable APIs in browsers that support them (e.g. ImageCapture)
Example
CaptureStage
CaptureStage allows the client to configure the stages. To do this, we offer the CaptureStage
object, where you can set the following parameters:
Parameter |
Desired capture mode. It can be used |
The number of attempts of the current stage. If it is the only stage, the value |
Duration time of the current stage. If more than one stage is set, the total time for each stage can be set, and when the total time is reached, the stage will move on to the next one. Set it to |
Example CaptureStage
Initialization
initialize(): Promise<void>
initialize(): Promise<void>
The SDK has a separate method of initialization, to allow greater control over when it occurs.
During this initialization, the SDK will initialize its internal variables and download the resources it needs to run.
[!] You must call this method before using other SDK methods.
[!] The initialization of the SDK can take a few seconds. We recommend that you call this function as early as possible in your flow so that opening the SDK is smooth for the user.
Example
Utilization
Opening and capturing documents
capture(container: HTMLElement, stages, {type: SupportedDocumentType, side: DocumentSide, totalAttempts?: Number}): Promise<Result>
capture(container: HTMLElement, stages, {type: SupportedDocumentType, side: DocumentSide, totalAttempts?: Number}): Promise<Result>
The method used to load the SDK onto the screen and perform document capture.
It will initialize the video stream (requesting permissions if needed) and load it into the container.
Parameters
Parameter | Type | Valid Values |
Type of document to be captured. |
|
|
Type of document to be captured. |
|
|
¹ The type any
does not have the validations for quality and document type, thus accepting any side or document - recommended for unsupported documents such as the OAB card.
² The type other
corresponds to other documents (not including those already specified), such as vaccination cards, etc.
³ If not specified, a default value of 30 seconds is used
⁴ The side both
correspond to the document showing both sides in the same photo (e.g. open CNH)
⁵ The side
parameter depends on the type of document entered in type
. See the table below.
Example
Accepted sides for each document type
Document type | Accepted sides |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Return
The return consists of an object with the following fields:
Field | Type | Description |
|
| Temporary link to the image, generated by our API |
|
| Temporary key for the image |
|
| Blob of the captured image |
|
| Type of captured document |
|
| Side of the captured document |
Example
Close SDK
close(): Promise<void>
close(): Promise<void>
The method used to remove the SDK on the screen, removing the visual elements of the SDK from the DOM.
Will remove the visual elements of the SDK from the DOM.
De-initialize the SDK
dispose(): Promise<void>
dispose(): Promise<void>
The method used to remove the SDK on the screen.
Will de-initialize the video stream and clear the SDK's internal variables
Complete Example
Soon.
Last updated