Verify Use Cases

When using the DIVE API there are three configuration settings that control how a submitted set of images will be processed. Those three settings are isBackOrSecondImageProcessingEnabled, isFaceMatchEnabled and isOCREnabled.

When isFaceMatchEnabled is set to true the image of a face submitted in this field faceImageBase64 will be compared to the image of the document owner's face that is cropped from the image submitted in this field frontImageBase64.

When isOCREnabled is set to true the image submitted in this field frontImageBase64 will have the text data read from it.

When isBackOrSecondImageProcessingEnabled is set to true the image submitted in this field backOrSecondImageBase64 will have the barcode data read it.

Single Image: Barcode Parsing

Configuration Setting
isBackOrSecondImageProcessingEnabled	true
isFaceMatchEnabled	false
isOCREnabled	false

{
  "documentType": 1,
  "frontImageBase64": "string",
  "backOrSecondImageBase64": "string",
  "faceImageBase64": "string",
  "trackString": {
    "data": "string",
    "barcodeParams": "string"
  },
  "ssn": "string",
  "overriddenSettings": {
    "isOCREnabled": false,
    "isBackOrSecondImageProcessingEnabled": true,
    "isFaceMatchEnabled": false
  },
  "metadata": {
    "captureMethod": "string",
    "userAgent": "string",
    "frontEndMetadata": "string",
    "otherMetadata": "string"
  }
}

With this configuration only the backOrSecondImageBase64 is required to be included in the request

Single Image: OCR

Configuration Setting
isBackOrSecondImageProcessingEnabled	false
isFaceMatchEnabled	false
isOCREnabled	true

{
  "documentType": 1,
  "frontImageBase64": "string",
  "backOrSecondImageBase64": "string",
  "faceImageBase64": "string",
  "trackString": {
    "data": "string",
    "barcodeParams": "string"
  },
  "ssn": "string",
  "overriddenSettings": {
    "isOCREnabled": true,
    "isBackOrSecondImageProcessingEnabled": false,
    "isFaceMatchEnabled": false
  },
  "metadata": {
    "captureMethod": "string",
    "userAgent": "string",
    "frontEndMetadata": "string",
    "otherMetadata": "string"
  }
}

With this configuration only the frontImageBase64 is required to be included in the request

Two Image: Face Match

Configuration Setting
isBackOrSecondImageProcessingEnabled	false
isFaceMatchEnabled	true
isOCREnabled	false

{
  "documentType": 1,
  "frontImageBase64": "string",
  "backOrSecondImageBase64": "string",
  "faceImageBase64": "string",
  "trackString": {
    "data": "string",
    "barcodeParams": "string"
  },
  "ssn": "string",
  "overriddenSettings": {
    "isOCREnabled": false,
    "isBackOrSecondImageProcessingEnabled": false,
    "isFaceMatchEnabled": true
  },
  "metadata": {
    "captureMethod": "string",
    "userAgent": "string",
    "frontEndMetadata": "string",
    "otherMetadata": "string"
  }
}

With this configuration only the frontImageBase64 and faceImageBase64 images are required to be included in the request

Two Image: OCR and Barcode Parsing

Configuration Setting
isBackOrSecondImageProcessingEnabled	true
isFaceMatchEnabled	false
isOCREnabled	true

{
  "documentType": 1,
  "frontImageBase64": "string",
  "backOrSecondImageBase64": "string",
  "faceImageBase64": "string",
  "trackString": {
    "data": "string",
    "barcodeParams": "string"
  },
  "ssn": "string",
  "overriddenSettings": {
    "isOCREnabled": true,
    "isBackOrSecondImageProcessingEnabled": true,
    "isFaceMatchEnabled": false
  },
  "metadata": {
    "captureMethod": "string",
    "userAgent": "string",
    "frontEndMetadata": "string",
    "otherMetadata": "string"
  }
}

When isFaceMatchEnabled is set to false and isOCREnabled and isBackOrSecondImageProcessingEnabled are set to true the frontImageBase64 and backOrSecondImageBase64 are the only two images that are required to be included in the request

Three Image: OCR and Barcode Parsing with Face Matching

Configuration Setting
isBackOrSecondImageProcessingEnabled	true
isFaceMatchEnabled	true
isOCREnabled	true

{
  "documentType": 1,
  "frontImageBase64": "string",
  "backOrSecondImageBase64": "string",
  "faceImageBase64": "string",
  "trackString": {
    "data": "string",
    "barcodeParams": "string"
  },
  "ssn": "string",
  "overriddenSettings": {
    "isOCREnabled": true,
    "isBackOrSecondImageProcessingEnabled": true,
    "isFaceMatchEnabled": true
  },
  "metadata": {
    "captureMethod": "string",
    "userAgent": "string",
    "frontEndMetadata": "string",
    "otherMetadata": "string"
  }
}

When isFaceMatchEnabled, isOCREnabled and isBackOrSecondImageProcessingEnabled are set to true the frontImageBase64 , backOrSecondImageBase64 and faceImageBase64 are all required to be included in the request