API Integration

To test your project setup and authentication, click on the Quick Start with API Recipe below:

🔑

Quick Start with API

Open Recipe

Following is an example of how a Verify call for an individual looks for MobileID:

Request

{
  "AcceptTruliooTermsAndConditions": true,
  "CleansedAddress": false,
  "ConfigurationName": "Identity Verification",
  "ConsentForDataSources": [
  ],
  "CountryCode": "US",
  "DataFields": {
    "PersonInfo": {
      "FirstGivenName": "John",
      "FirstSurName": "Smith",
      "DayOfBirth": 5,
      "MonthOfBirth": 3,
      "YearOfBirth": 1983
    },
    "Communication": {
      "MobileNumber": "202 555 1234"
    }
  }
}

Response

{
   "TransactionID": "5a123d12-908b-419d-ab1b-b8da9d32ae3e",
   "UploadedDt": "2018-09-20T18:53:45",
   "CountryCode": "CA",
   "ProductName": "Identity Verification",
   "Record":    {
      "TransactionRecordID": "94c79d17-967e-4d4c-8c5u-c4b6a39bb30",
      "RecordStatus": "match",
      "DatasourceResults": [      {
         "DatasourceName": "Mobile ID",
         "DatasourceFields":          [
                        {
               "FieldName": "FirstInitial",
               "Status": "match"
            },
                        {
               "FieldName": "DayOfBirth",
               "Status": "match"
            },
                        {
               "FieldName": "Telephone2",
               "Status": "missing"
            },
                        {
               "FieldName": "BuildingNumber",
               "Status": "missing"
            },
                        {
               "FieldName": "MonthOfBirth",
               "Status": "match"
            },
                        {
               "FieldName": "City",
               "Status": "missing"
            },
                        {
               "FieldName": "YearOfBirth",
               "Status": "match"
            },
                        {
               "FieldName": "UnitNumber",
               "Status": "missing"
            },
                        {
               "FieldName": "Telephone",
               "Status": "missing"
            },
                        {
               "FieldName": "FirstSurName",
               "Status": "match"
            },
                        {
               "FieldName": "StreetName",
               "Status": "missing"
            },
                        {
               "FieldName": "MiddleName",
               "Status": "missing"
            },
                        {
               "FieldName": "FirstGivenName",
               "Status": "match"
            },
                        {
               "FieldName": "StreetType",
               "Status": "missing"
            },
                        {
               "FieldName": "StateProvinceCode",
               "Status": "missing"
            },
                        {
               "FieldName": "PostalCode",
               "Status": "missing"
            },
                        {
               "FieldName": "MobileNumber",
               "Status": "match"
            }
         ],
         "AppendedFields":          [
                        {
               "FieldName": "PhoneContractStatus",
               "Data": "ACTIVE"
            },
                        {
               "FieldName": "PhoneAccountUser",
               "Data": "SECONDARY"
            },
                        {
               "FieldName": "Operator",
               "Data": "TELUS"
            },
                        {
               "FieldName": "PhoneContractType",
               "Data": "POSTPAID"
            },
                        {
               "FieldName": "PhoneAccountType",
               "Data": "PERSONAL"
            },
                        {
               "FieldName": "LastUpdateYear",
               "Data": "2013"
            },
                        {
               "FieldName": "LastUpdateMonth",
               "Data": "08"
            },
                        {
               "FieldName": "LastUpdateDay",
               "Data": "31"
            }
         ],
         "Errors": [],
         "FieldGroups": []
      }],
      "Errors": [],
      "Rule":       {
         "RuleName": "Category 3 KYC",
         "Note": "Match(FamilyAndGivenInitial, DOB) or Match(FamilyAndGivenInitial, FullAddress) or Match(FamilyAndGivenInitial, ID)"
      }
   },
   "Errors": []
}