OCR Match (ocr_match) Response Object

Applies to: Direct | Capture

This JSON response is returned for a comparison of an OCR scan to the barcode or MRZ data.

👍

This response is returned by /get-results if you include the ocr_match signal in the /start endpoint.

JSON

{
  "ocr_match": {
    "type": "object",
    "description": "OCR mismatch signal (ocr_match) response",
    "properties": {
      "success": {
        "type": "boolean",
        "description": "True if the API call was successful; false otherwise."
      },
      "result": {
        "type": "boolean",
        "description": "True if data was returned in the data object; false otherwise."
      },
      "message": {
        "type": "string",
        "description": "A description of the result output, for example, \"success\" or an error message."
      },
      "data": {
        "type": "object",
        "description": "Contains the ocr_match signal elements returned as a JSON object.",
        "properties": {
          "isNameMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if name matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "nameMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isDocumentNumberMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if document number matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "documentNumberMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isCountryCodeMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if country code matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "countryCodeMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isExpirationDateMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if expiration date matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "expirationDateMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isDobMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if date of birth matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "dobMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isSexMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if sex matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "sexMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isNationalityMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if nationality matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "nationalityMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isIssuerNameMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if issuer name matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "issuerNameMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isAddressMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if address matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "addressMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isIssueDateMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if issue date matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "issueDateMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isHeightMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if height matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "heightMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isWeightMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if weight matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "weightMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isEyeColorMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if eye color matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "eyeColorMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isDlClassMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if driver license class matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "dlClassMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isDlEndorsementMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if driver license endorsement matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "dlEndorsementMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isDlRestrictionsMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if driver license restrictions matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "dlRestrictionsMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          },
          "isRealIdMatch": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "True if real ID matched; false otherwise. A null value means this data was not available for the match comparison."
          },
          "realIdMatchDetails": {
            "type": "object",
            "description": "Contains `details` to explain the match decision along with a `similarityScore` value and a `similarityThreshold` value.",
            "properties": {
              "details": {
                "type": "string",
                "description": "A brief explanation of whether the comparison was a match, a match with a slight discrepancy, a mismatch, or an indeterminate result."
              },
              "similarityThreshold": {
                "type": "number",
                "description": "A confidence cutoff that applies to `similarityScore`. For the issuer name, this value is 100 because the issuer must be an exact match. Otherwise, this value is typically 70. The `similarityScore` must be greater than or equal to this `similarityThreshold` to produce a match. The match result determines a true or false value for the corollary object. For example, if this object is `nameMatchDetails`, then its corollary object is `isNameMatch`."
              },
              "similarityScore": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "A confidence estimate between 0 and 100 that OCR data matched the barcode or the MRZ data. A null value means this data was not available for the match comparison."
              }
            }
          }
        }
      }
    }
  }
}