International Document and Passport (extendedId) Response Object

This JSON response is returned for an international document and passport check.

👍

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

json

{
  "extendedId": {
    "type": "object",
    "description": "International document and passport card signal (`extendedId`) 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 extendedId signal elements returned as a JSON object.",
        "properties": {
          "errorMessage": {
            "type": "string",
            "description": "Any error message related to document OCR extraction."
          },
          "fullDocumentImageBase64": {
            "deprecated": true,
            "type": "null",
            "description": "Deprecated. Currently not populated. Set /start return_images to true, and then see the images object in get-results."
          },
          "faceImageBase64": {
            "deprecated": true,
            "type": "null",
            "description": "Deprecated. Currently not populated. Set /start return_images to true, and then see the images object in get-results."
          },
          "firstName": {
            "type": "string",
            "description": "First name extracted from the ID encoding."
          },
          "lastName": {
            "type": "string",
            "description": "Last name extracted from the ID encoding."
          },
          "fullName": {
            "type": "string",
            "description": "fullName is derived from the front of the identification or driver license document. Certain documents, such as a Michigan State driver license, may not return values in the firstName and lastName name fields for OCR results. The API instead returns a fullName field, which can be used to process the name. The fullName field is the entire name. This change is required because the OCR scan cannot separate names as they appear on certain IDs (for example, Michigan issued driver licenses)."
          },
          "address": {
            "type": "string",
            "description": "Address extracted from the ID encoding."
          },
          "dateOfBirth": {
            "type": "string",
            "description": "Date of birth. Typically formatted as yyyy-mm-dd."
          },
          "dateOfBirthFormatted": {
            "type": "string",
            "description": "dateOfBirth values formatted as dd/mm/yyyy, for example 01/01/1972."
          },
          "dateOfIssue": {
            "type": "string",
            "description": "Date the document was issued. Typically formatted as yyyy-mm-dd."
          },
          "dateOfIssueFormatted": {
            "type": "string",
            "description": "dateOfIssue values formatted as dd/mm/yyyy, for example 01/01/2024."
          },
          "dateOfExpiry": {
            "type": "string",
            "description": "Date the document expires. Typically formatted as yyyy-mm-dd."
          },
          "dateOfExpiryFormatted": {
            "type": "string",
            "description": "dateOfExpiry values formatted as dd/mm/yyyy, for example 01/01/2024."
          },
          "documentNumber": {
            "type": "string",
            "description": "Unique number that identifies the document."
          },
          "sex": {
            "type": "string",
            "description": "Gender. Values include M or F."
          },
          "placeOfBirth": {
            "type": "string",
            "description": "Place where the person was born."
          },
          "nationality": {
            "type": "string",
            "description": "Person's country of origin."
          },
          "issuingAuthority": {
            "type": "string",
            "description": "Name of the entity that issued the document."
          },
          "issuerName": {
            "type": "string",
            "description": "Name of the document issuer."
          },
          "age": {
            "type": "string",
            "description": "Person's current age."
          },
          "documentName": {
            "type": "string",
            "description": "Identified name of the front of the document."
          },
          "documentNameBack": {
            "type": "string",
            "description": "Identified name of the back of the document."
          },
          "birthName": {
            "type": "string",
            "description": "Name of person at birth."
          },
          "photoBack": {
            "deprecated": true,
            "type": "string",
            "description": "base64 encoded image of back of document."
          },
          "photoFront": {
            "deprecated": true,
            "type": "string",
            "description": "base64 encoded image of front of document."
          },
          "photoFaceCrop": {
            "deprecated": true,
            "type": "string",
            "description": "base64 encoded image of cropped photo from front of document."
          },
          "documentType": {
            "type": "string",
            "description": "Type of document."
          },
          "documentRecognized": {
            "type": "integer",
            "description": "0 = not recognized. 1 = recognized. 2 = not processed.",
            "enums":[
              "0",
              "1",
              "2"
            ]
          },
          "expiredStatus": {
            "type": "string",
            "description": "Document expired status: Yes, No, or Unknown."
          },
          "countryCode": {
            "type": "string",
            "description": "Three-letter code of the document issuing country (from third to fifth characters in the first MRZ string)."
          }
        }
      }
    }
  }
}