The QitechDeviceScan object
Request
To use the Device Scan plugin, you must call the startDeviceScan method, which has the following parameters:
| Parameter | Type | Purpose | Required |
|---|---|---|---|
| mobileToken | String | Customer key that identifies that the collected data comes from your application. If you have not yet received your mobile-token, contact support. | Yes. |
| environment | CaaSEnvironment | Enum used to configure the runtime environment as sandbox or production. | Yes. |
| sessionId | String | Key that identifies the session from which the collected data originates. | Yes. |
| eventType | String | An enum that defines the type of event being reported — Care is requested so that very similar events are reported with the same enum, so that intelligence can be built on top of this data. | Yes. |
| eventId | String | An identifier of the event being reported. | Yes. |
| documentNumber | String | The user’s document number, if available. (CPF/CNPJ without dots, dashes, and slash) | No. |
Return value
The method returns a String to indicate success or failure during information collection:
Success
DeviceScan data sent successfully
Error
Device Scan fail. Check mobileToken, environment and permissions