GBG Developers

Guides   |   Verification History (Archived)

Verification History (Archived)

The IDAAS platform provides you with a full audit history of all your verifications. By retaining your person-id for a specific request you can go back into the history of your requests, check exactly what was submitted and the results of any verifications.

What does verify history do?

The verify history user interface gives you access the the audit trail of requests you have made. You can reference any verification collection by it's person Id, and a single verification using it's verification id.

 

 

How does verify people work?

 

The Request

The verify history API allows you to use a combination of header values to query your verification history, the available headers are:

Header Name Query Purpose
combined-result Will search the audit data for verifications that match this combined result
from-date-time Searches the database for any verifications that happened from this time
to-date-time Searches the database for any verifications that happened up to this time. It is advisable to use this in conjunction with from-date-time
from-date Searches the database for any verifications that happened from midnight of this date
to-date Searches the database for any verifications that happened to midnight of this date. It is advisable to use this in conjunction with the from-date
person-id Searches for any verification used against this person-id. This must be used with other query parameters. If you want all the verifications for this person then please use the /people/{person-id} end point
verification-id Will search the audit data for verifications that match this verification-id. Each ID should be unique and so should return a single row
customer-reference Will search the audit data for verifications that match this customer reference
first-name Will search the audit data for verifications that include this first name
last-name Will search the audit data for verifications that match this last name
dateOfBirth Will search the audit data for verifications that have a person with this DOB
postalcode Will search the audit data for verifications that have an address in with this postal code

To limit the size of the response you can supply paging headers. This will limit the number of items returned to your specified 'pageSize' header, and return the page you specify in a header with the name 'page'.

The Response

The response will contain a header called 'page-count'. This will tell you the total number of pages available in your audit trail with the current page size.

A successful response will return a verification response in the following schema:

[
  {
    "person-id": "7ab2ff08-728a-42e6-aa38-df191ffd4817",
    "verifications": [
      {
        "request": {
          "title": "Mr",
          "firstName": "David",
          "middlenames": [
            "James"
          ],
          "lastnames": [
            "Jones"
          ],
          "gender": "MALE",
          "birthdate": "2000-01-01",
          "addresses": [
            {
              "type": "CURRENT",
              "address": {
                "lines": [
                  "string"
                ],
                "address": "string",
                "premise": "128",
                "building": "string",
                "subBuilding": "string",
                "thoroughfare": "Queen Victoria Street",
                "dependentThoroughfare": "string",
                "locality": "London",
                "dependentLocality": "string",
                "doubleDependentLocality": "string",
                "postalCode": "EC4V 4BJ",
                "postBox": "string",
                "country": "GBR",
                "superAdministrativeArea": "string",
                "administrativeArea": "string",
                "subAdministrativeArea": "string",
                "organization": "GB Group",
                "quality": {
                  "avc": "string",
                  "aqi": "string"
                },
                "location": {
                  "latitude": "string",
                  "longitude": "string",
                  "geoAccuracy": "string"
                }
              },
              "resident": {
                "from": "2000-01-01",
                "to": "2000-01-01"
              },
              "enrichments": {
                "cleansed": {
                  "lines": [
                    "string"
                  ],
                  "address": "string",
                  "premise": "128",
                  "building": "string",
                  "subBuilding": "string",
                  "thoroughfare": "Queen Victoria Street",
                  "dependentThoroughfare": "string",
                  "locality": "London",
                  "dependentLocality": "string",
                  "doubleDependentLocality": "string",
                  "postalCode": "EC4V 4BJ",
                  "postBox": "string",
                  "country": "GBR",
                  "superAdministrativeArea": "string",
                  "administrativeArea": "string",
                  "subAdministrativeArea": "string",
                  "organization": "GB Group",
                  "quality": {
                    "avc": "string",
                    "aqi": "string"
                  },
                  "location": {
                    "latitude": "string",
                    "longitude": "string",
                    "geoAccuracy": "string"
                  }
                }
              }
            }
          ],
          "phones": [
            {
              "type": "HOME",
              "number": "+44 207 4281250"
            }
          ],
          "documents": [
            {
              "documentVerificationId": "string",
              "image": "string"
            },
            {
              "passportNumber": "string",
              "shortPassportNumber": "string",
              "countryOfOrigin": "string",
              "issueDate": "2000-01-01",
              "expiryDate": "2000-01-01",
              "dateOfBirth": "2000-01-01",
              "placeOfBirth": "string",
              "lastNames": [
                "Jones"
              ],
              "firstName": "David",
              "middleNames": [
                "James"
              ],
              "gender": "MALE"
            },
            {
              "title": "Mr",
              "firstName": "David",
              "middleNames": [
                "James"
              ],
              "lastNames": [
                "Jones"
              ],
              "gender": "MALE",
              "dateOfBirth": "2000-01-01",
              "mailSort": "string",
              "microfiche": "string",
              "issueDate": "2000-01-01",
              "expiryDate": "2000-01-01",
              "issueNumber": "string"
            },
            {
              "title": "Mr",
              "firstName": "David",
              "middleNames": [
                "James"
              ],
              "lastNames": [
                "Jones"
              ],
              "gender": "MALE",
              "dateOfBirth": "2000-01-01",
              "address": {
                "premise": "128",
                "building": "string",
                "subBuilding": "string",
                "thoroughfare": "Fannie Bay",
                "dependentThoroughfare": "string",
                "locality": "Darwin",
                "dependentLocality": "string",
                "postalCode": 2148,
                "administrativeArea": "string",
                "superAdministrativeArea": "string",
                "country": "Straya"
              },
              "cardLine1": "string",
              "cardLine2": "string",
              "cardLine3": "string",
              "countryOfNationality": "string",
              "countryOfIssue": "string",
              "expiryDate": "2000-01-01"
            },
            {
              "title": "Mr",
              "firstName": "David",
              "middleNames": [
                "James"
              ],
              "lastNames": [
                "Jones"
              ],
              "gender": "MALE",
              "dateOfBirth": "2000-01-01",
              "address": {
                "premise": "128",
                "building": "string",
                "subBuilding": "string",
                "thoroughfare": "Fannie Bay",
                "dependentThoroughfare": "string",
                "locality": "Darwin",
                "dependentLocality": "string",
                "postalCode": 2148,
                "administrativeArea": "string",
                "superAdministrativeArea": "string",
                "country": "Straya"
              },
              "cardNumber": "string",
              "referenceNumber": "string",
              "lastNameAtCitizenship": "string",
              "middleNameOnCard": "string",
              "cardColour": "string",
              "expiryDate": "2000-01-01"
            }
          ]
        },
        "response": {
          "verificationID": "7ab2ff08-728a-42e6-aa38-df191ffd4817",
          "timestamp": "2019-01-04T14:38:25Z",
          "customerReference": "7ab2ff08-728a-42e6-aa38-df191ffd4817",
          "journey": {
            "journey-id": "7ab2ff08-728a-42e6-aa38-df191ffd4817",
            "journey-version": 0
          },
          "verification": {
            "derivedData": {
              "isRecognised": true,
              "person": {
                "title": "Mr",
                "firstName": "David",
                "middlenames": [
                  "James"
                ],
                "lastnames": [
                  "Jones"
                ],
                "gender": "MALE",
                "birthdate": "2000-01-01",
                "address": {
                  "extracted": "string",
                  "enrichment": {
                    "cleansed": {
                      "lines": [
                        "string"
                      ],
                      "address": "string",
                      "premise": "128",
                      "building": "string",
                      "subBuilding": "string",
                      "thoroughfare": "Queen Victoria Street",
                      "dependentThoroughfare": "string",
                      "locality": "London",
                      "dependentLocality": "string",
                      "doubleDependentLocality": "string",
                      "postalCode": "EC4V 4BJ",
                      "postBox": "string",
                      "country": "GBR",
                      "superAdministrativeArea": "string",
                      "administrativeArea": "string",
                      "subAdministrativeArea": "string",
                      "organization": "GB Group",
                      "quality": {
                        "avc": "string",
                        "aqi": "string"
                      },
                      "location": {
                        "latitude": "string",
                        "longitude": "string",
                        "geoAccuracy": "string"
                      }
                    }
                  }
                }
              },
              "fields": [
                {
                  "id": "string",
                  "name": "string",
                  "type": "STRING",
                  "description": "string",
                  "value": "string"
                }
              ],
              "images": [
                {
                  "type": "DIGITAL_TAMPERING_HEAT_MAP",
                  "imageUrl": "string",
                  "imageID": "string",
                  "base64Image": "string"
                }
              ],
              "classification": {
                "type": "string",
                "category": "string",
                "name": "string",
                "issue": "string",
                "issuingAuthority": "string"
              }
            },
            "analysis": [
              {
                "name": "string",
                "description": "string",
                "id": 0,
                "country": {
                  "code": "string",
                  "name": "string"
                },
                "comments": [
                  {
                    "text": "string",
                    "code": 0,
                    "override": "string"
                  }
                ],
                "matches": [
                  {
                    "text": "string",
                    "code": 0,
                    "override": "string"
                  }
                ],
                "warnings": [
                  {
                    "text": "string",
                    "code": 0,
                    "override": "string"
                  }
                ],
                "mismatches": [
                  {
                    "text": "string",
                    "code": 0,
                    "override": "string"
                  }
                ],
                "flags": {
                  "address": "NA",
                  "firstName": "NA",
                  "lastName": "NA",
                  "birthDate": "NA",
                  "alert": "NA",
                  "pass": "NA"
                },
                "sanctionsMatches": [
                  {
                    "sanctionID": "string",
                    "url": "string",
                    "score": 0,
                    "caseID": "string",
                    "searchID": "string",
                    "fcraEnabled": true,
                    "tiers": [
                      "string"
                    ],
                    "rank": 0
                  }
                ]
              }
            ],
            "result": {
              "function": "VERIFY-PERSON",
              "state": "string",
              "score": 0
            }
          },
          "triangulation": {
            "request": [
              {
                "person": {
                  "title": "Mr",
                  "firstName": "David",
                  "middlenames": [
                    "James"
                  ],
                  "lastnames": [
                    "Jones"
                  ],
                  "gender": "MALE",
                  "birthdate": "2000-01-01"
                },
                "addresses": [
                  {
                    "index": 0,
                    "addressID": "string",
                    "address": {
                      "lines": [
                        "string"
                      ],
                      "address": "string",
                      "premise": "128",
                      "building": "string",
                      "subBuilding": "string",
                      "thoroughfare": "Queen Victoria Street",
                      "dependentThoroughfare": "string",
                      "locality": "London",
                      "dependentLocality": "string",
                      "doubleDependentLocality": "string",
                      "postalCode": "EC4V 4BJ",
                      "postBox": "string",
                      "country": "GBR",
                      "superAdministrativeArea": "string",
                      "administrativeArea": "string",
                      "subAdministrativeArea": "string",
                      "organization": "GB Group",
                      "quality": {
                        "avc": "string",
                        "aqi": "string"
                      },
                      "location": {
                        "latitude": "string",
                        "longitude": "string",
                        "geoAccuracy": "string"
                      }
                    }
                  }
                ]
              }
            ],
            "response": {
              "resultCode": 20,
              "resultDescription": "20 - same address and same person (independent of address)",
              "resultDetail": {
                "addressMatches": [
                  {
                    "index": 0,
                    "matchedIndices": [
                      0
                    ]
                  }
                ]
              }
            }
          },
          "combined": {
            "verifications": [
              {
                "result": {
                  "function": "VERIFY-PERSON",
                  "state": "string",
                  "score": 0
                }
              }
            ],
            "decision": "string",
            "notes": "string"
          },
          "action": "string"
        }
      }
    ]
  }
]

What next?

To implement the verify history API, find details API information in our API Reference.