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"

request

type object

The verification request that was sent to Dyneti.

Example value:

{
  "cardholderName": "John Smith",
  "firstSix": "123456",
  "lastFour": "4321",
  "detectWrongCard": true
}

---

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"
}

---

isFraud

type boolean

Whether this scan was considered fraudulent. If the value is true, declineReasons will be populated and will contain the reasons the card was considered fraudulent.

Example value:

false

---

declineReasons

type object

A dictionary of possible reasons the scan was considered fraud, and whether they were triggered.

Reasons for decline include the following:

• formatMismatch: a boolean that indicates that the card assets do not match the card type as detected by the BIN ( e.g., the card number or logo are not where we expect them to be).
• numberMismatch: a boolean that indicates that the BIN and last four digits of the scanned card do not match with what we expect. Note this reason is only available if you provide us with the expected BIN and last four.
• generatedImage: a boolean that indicates that the image is likely generated (e.g., the image is being scanned through a screen, or does not have corners or wear and tear).
• rateLimited: a boolean that indicates that an attacker has been attempting multiple scans in rapid succession using the same device.
• nameMismatch: a boolean that indicates that the name requested was not matched to the name on the card. This field will not be present if the name field of the verify payload is not set.

Example value:

{
  "formatMismatch": false,
  "numberMismatch": false,
  "generatedImage": false,
  "rateLimited": false
}

---

scanResult

type object

Details about the card that was scanned.

Example value:

{
  "firstSix": "123456",
  "lastFour": "4321"
}

---

payloadId

type uuid string

This value can be used to verify the authenticity of the scan payload using the Integrity Check API

Use of this field and the Integrity Check API are optional and are included in the Scan object for consistency with our Mobile SDKs.

Example value:

"90a6a4ba-5ade-483d-96e0-c3a4edb553d7"