Indexed Record

An indexed record is part of the historic records database. Indexed record is a hashed representation of key identity owner and id document fields as well as faces associated with them. The fields to extract are specified in the instance used. These fields are either accepted as input in the index request or are extracted from the submitted ID document.

Match Criteria

A set of rules made up of face and text fields which define whether an indexed record classifies as a match or not.

Instance

A Repeat User Instance is made up of fields which define an Identity Owner and an ID Document. This instance serves as the base for repeat user matching or fraud matching.

When indexing a document, the fields defined within the instance are extracted from each ID document. If a field specified in the instance is absent from the document submitted (due to ocr error or field not present on document) then the missing field is set to null.

Furthermore, a subset of these fields is used to form the match criteria when repeat user matching is performed.

Sample Instance

The below example shows a sample repeat user instance catering to driver licences and passports.

{
  "instanceId": "1234-4569-2598-7569824",
  "instanceType": "TENANT",
  "name": "Test Instance",
  "description": "Test Repeat User Instance for Driver Licences and Passports",
  "identityOwner": {
    "match": true,
    "face": {
      "match": true,
      "similarityThreshold": 0.9
    },
    "fields": [
      {
        "key": "givenName",
        "match": true
      },
      {
        "key": "middleName",
        "match": true
      },
      {
        "key": "familyName",
        "match": true
      },
      {
        "key": "dateOfBirth",
        "match": true
      },
      {
        "key": "addressLine1",
        "match": true
      },
      {
        "key": "addressLine2",
        "match": true
      }
    ]
  },
  "idDocument": {
    "face": {
      "match": true,
      "similarityThreshold": 0.9
    },
    "match": true,
    "fields": [
      {
        "key": "givenName",
        "match": true
      },
      {
        "key": "middleName",
        "match": true
      },
      {
        "key": "familyName",
        "match": true
      },
      {
        "key": "dateOfBirth",
        "match": true
      },
      {
        "key": "addressLine1",
        "match": true
      },
      {
        "key": "addressLine2",
        "match": true
      },
      {
        "key": "dateOfExpiry",
        "match": true
      },
      {
        "key": "licenceNumber",
        "match": true
      },
      {
        "key": "passportNumber",
        "match": true
      },
      {
        "key": "issuingAuthority",
        "match": true
      }
    ]
  }
}

From the instance,

Identity Owner is defined as a combination of givenName, middleName, familyName, dateOfBirth and address of the person. These also double up as PII fields.
ID Document is defined as a combination of the above PII fields and the Document fields dateOfExpiry, LicenceNumber, passportNumber and issuingAuthority.
Match criteria as a default is defined as,
Any indexed record which matches all PII and Document fields, along with a face match similarity score above 90%.
The fields givenName, middleName, familyName, dateOfBirth, address, dateOfExpiry, LicenceNumber, passportNumber and issuingAuthority are extracted from every document submitted for indexing.

Sample Instance with Narrowed Match Criteria

{
  "instanceId": "1234-4569-2598-7569824",
  "instanceType": "TENANT",
  "name": "Test Instance",
  "description": "Test Repeat User Instance for Driver Licences and Passports",
  "identityOwner": {
    "match": true,
    "face": {
      "match": false,
      "similarityThreshold": 0.9
    },
    "fields": [
      {
        "key": "givenName",
        "match": true
      },
      {
        "key": "middleName",
        "match": true
      },
      {
        "key": "familyName",
        "match": true
      },
      {
        "key": "dateOfBirth",
        "match": true
      },
      {
        "key": "addressLine1",
        "match": true
      },
      {
        "key": "addressLine2",
        "match": true
      }
    ]
  },
  "idDocument": {
    "match": true,
    "face": {
      "match": false,
      "similarityThreshold": 0.9
    },
    "fields": [
      {
        "key": "givenName",
        "match": true
      },
      {
        "key": "middleName",
        "match": true
      },
      {
        "key": "familyName",
        "match": true
      },
      {
        "key": "dateOfBirth",
        "match": true
      },
      {
        "key": "addressLine1",
        "match": true
      },
      {
        "key": "addressLine2",
        "match": true
      },
      {
        "key": "dateOfExpiry",
        "match": true
      },
      {
        "key": "licenceNumber",
        "match": true
      },
      {
        "key": "passportNumber",
        "match": true
      },
      {
        "key": "issuingAuthority",
        "match": true
      }
    ]
  }
}

{
  "instanceId": "1234-4569-2598-7569824",
  "instanceType": "TENANT",
  "name": "Test Instance",
  "description": "Test Repeat User Instance for Driver Licences and Passports",
  "identityOwner": {
    "match": true,
    "face": {
      "match": true,
      "similarityThreshold": 0.9
    },
    "fields": [
      {
        "key": "givenName",
        "match": true
      },
      {
        "key": "middleName",
        "match": true
      },
      {
        "key": "familyName",
        "match": true
      },
      {
        "key": "dateOfBirth",
        "match": true
      },
      {
        "key": "addressLine1",
        "match": false
      },
      {
        "key": "addressLine2",
        "match": false
      }
    ]
  },
  "idDocument": {
    "match": true,
    "face": {
      "match": true,
      "similarityThreshold": 0.9
    },
    "fields": [
      {
        "key": "givenName",
        "match": true
      },
      {
        "key": "middleName",
        "match": true
      },
      {
        "key": "familyName",
        "match": true
      },
      {
        "key": "dateOfBirth",
        "match": true
      },
      {
        "key": "addressLine1",
        "match": false
      },
      {
        "key": "addressLine2",
        "match": false
      },
      {
        "key": "dateOfExpiry",
        "match": true
      },
      {
        "key": "licenceNumber",
        "match": true
      },
      {
        "key": "passportNumber",
        "match": true
      },
      {
        "key": "issuingAuthority",
        "match": true
      }
    ]
  }
}

{
  "instanceId": "1234-4569-2598-7569824",
  "instanceType": "TENANT",
  "name": "Test Instance",
  "description": "Test Repeat User Instance for Driver Licences and Passports",
  "identityOwner": {
    "match": false,
    "face": {
      "match": false,
      "similarityThreshold": 0.9
    },
    "fields": [
      {
        "key": "givenName",
        "match": true
      },
      {
        "key": "middleName",
        "match": true
      },
      {
        "key": "familyName",
        "match": true
      },
      {
        "key": "dateOfBirth",
        "match": true
      },
      {
        "key": "addressLine1",
        "match": false
      },
      {
        "key": "addressLine2",
        "match": false
      }
    ]
  },
  "idDocument": {
    "match": true,
    "face": {
      "match": true,
      "similarityThreshold": 0.9
    },
    "fields": [
      {
        "key": "givenName",
        "match": true
      },
      {
        "key": "middleName",
        "match": true
      },
      {
        "key": "familyName",
        "match": true
      },
      {
        "key": "dateOfBirth",
        "match": true
      },
      {
        "key": "addressLine1",
        "match": false
      },
      {
        "key": "addressLine2",
        "match": false
      },
      {
        "key": "dateOfExpiry",
        "match": true
      },
      {
        "key": "licenceNumber",
        "match": true
      },
      {
        "key": "passportNumber",
        "match": true
      },
      {
        "key": "issuingAuthority",
        "match": true
      }
    ]
  }
}

The above examples demonstrate how the default match criteria can be modified for different use cases.

Note: Even though specified field is not included in the match criteria (match=false), it will still be extracted from the submitted document.

It is recommended to keep the default match criteria as broad as possible since match criteria can be overridden per request.

Refer to the Provision Instance API to provision an instance for this service.