GBG Developers

Guides   |   Verify Person

Verify Person

Our verify person service allows you to take the details of your end user, and check them against a predefined list of checks.

What does verify person do?

When setting up your account you will be able to create one or more profiles. These profiles will dictate the combination of database checks that verify person will complete, and the scoring of each of the results of these checks. The result of these checks will dictate the result you receive from verify person.

How does verify people work?

 

The Request

The Verify Person request requires your journey-id to be sent in as a header. Your journey-id is the unique id that references the list of checks that you put together for verify people to perform. You will create this as part of the setup of your account.

The verify person API allows you to post the details of an individual you want to check using our standard person schema shown below (refer to the API section for the precise format). Note that it is recommended to send any captured addresses using the address lines and country fields if they are available, rather than the individual fields. If you have performed a Verify Document request prior to this, if you have a JSON block containing quality, this should be included in the Verify Person 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"
    }
  ]
}

 

The Person Id

If this is the first request you are making in a series of verification requests that relate to a single user, you do not need to supply a person-id, and one will be created for you by IDAAS and returned in the response headers with the key 'person-id'. You should use this id for each subsequent request you make to any of the verification services. This will allow IDAAS to combine these verifications into a single record and perform actions such as combined scoring

If you have already performed other verification checks and already have a person-id, this should be supplied as part of the URL. For more information on where and how to supply a person Id, see our API Reference Documentation.

 

The Response

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

{
  "verificationID": "7ab2ff08-728a-42e6-aa38-df191ffd4817",
  "timestamp": "2019-01-04T14:38:25Z",
  "verification": {
    "result": {
      "function": "VERIFY-PERSON",
      "state": "string",
      "score": 0
    }
  },
  "combined": {
    "decision": "string"
  },
  "action": "string",
  "links": [
    {
      "href": "string",
      "rel": "string"
    }
  ]
}

What next?

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