Scan
The Scan object represents the current state of a scan.
status
type string
The current state of the scan.
| Possible values | Meaning |
|---|---|
scanStarted | Set when the video stream is started. |
scanCancelled | Set if the user cancels the flow by closing the modal |
scanFailed | Set if the scan fails, (e.g. there is no webcam on the user's device) |
scanComplete | Set when the scan flow is completed by the user. |
scanId
type uuid string
The scan ID
Example value:
"36c16169-4e0a-4999-8124-1bfdf2e3bc4a"
options
type object
Optional configuration fields that were sent to Dyneti to customize the scanning experience.
Example value:
{
"logoUrl": "https://dyneti.com/wp-content/uploads/2019/11/fb-preview.jpg",
"userId": "some-user-id"
}
scanResult
type object
Details about the card that was scanned.
Example value:
{
"firstSix": "123456",
"lastFour": "4321"
}