Metadata request field

This section describes how to use Metadata field in the request model. You can find this field in all our services request models, like Canadian DMV, DMV, IdentiFraud, etc.

The Metadata is object with key-value pairs. It looks like:

 "metadata": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }

You can tag each request to our Screening Services by your own additional information in "name": "value" format, e.g.

 "metadata": {
    "myIdentifier": "1111-qwerty-aaa",
    "scanInfo": "myScanInfo",
    "anotherAdditionalInfo": "This is my amazing request!"
  }

and send it to the service, e.g. to the Canadian DMV:

{
  "dateOfBirths": "1989-12-24",
  "issuedBy": "PE",
  "services": [
    "58B76696-75E2-466F-97A2-1B216ED40108"
  ],
  "driverLicenseNumber": "421450",
  "driverLicenseClass": "1",
  "metadata": {
    "myIdentifier": "1111-qwerty-aaa",
    "scanInfo": "myScanInfo",
    "anotherAdditionalInfo": "This is my amazing request!"
  }
}

Then, the same Metadata is returned in the response from the service, e.g. from Canadian DMV:

[
  {
    "serviceId": "58b76696-75e2-466f-97a2-1b216ed40108",
    "serviceName": "Canadian DMV Verification",
    "serviceDescription": "Canadian Driver License Data Verification",
    "error": null,
    "success": true,
    "locationId": null,
    "readOnlyAccessLocationIds": null,
    "metadata": {
        "myIdentifier": "1111-qwerty-aaa",
        "scanInfo": "myScanInfo",
        "anotherAdditionalInfo": "This is my amazing request!"
    },
    "profiles": [
      {
        "internalId": null,
        "firstName": "",
        "middleName": "",
        "lastName": "",
        "fullName": "",
        "dateOfBirths": "12/24/1989",
        "sex": null,
        "address": null,
        "countryName": null,
        "countryCode": null,
        "street1": null,
        "street2": null,
        "city": null,
        "state": null,
        "zipCode": null,
        "county": null,
        "convictiontype": null,
        "aliases": null,
        "offenses": null,
        "photoUrl": null,
        "source": null,
        "otherInformation": null,
        "idNumber": "421450",
        "issuedBy": "PE",
        "verificationResult": null,
        "driverLicenseVerificationResult": null,
        "canadianDriverLicenseVerificationResult": {
          "licenseVerificationResult": {
            "status": "Valid",
            "code": 1,
            "message": "Driver's license is valid"
          },
          "licenseClassVerificationStatus": "Class Match",
          "currentLicenseClasses": "1,3,5"
        }
      }
    ]
  }
]

For other services the logic is the same. Try to use this field and feel free to ask any questions at support@idscan.net.