Skip to main content

Landline Verification

Landline verification can contain details such as whether a landline is valid or invalid.

Minimum Requirements​

InputDescription
landlineFull UK landline without country prefix

Service Request​

To request a Landline Verification, add a LANDLINE_VERIFICATION action to the request body entity PeopleActionsRequest:

{
"actions": [
{ "action": "LANDLINE_VERIFICATION" }
]
}

PeopleActionsRequest​

Array of objects (PersonAction)

Actions to run with the given criteria

object (PersonRequest)

Person format used across the Investigate API

object (Address)

Address format used across the Investigate API

cohabitants
Array of strings (Cohabitants)

Cohabitants at given address

sourceYears
Array of integers <int32> (SourceYears) [ items <int32 > ]

Years when the matching datasets stored by GBG were issued. This could support customers compliance requirements.

tags
Array of strings

Free text tags for tracking purposes.

{
  • "actions": [
    ],
  • "person": {
    },
  • "address": {
    },
  • "cohabitants": [
    ],
  • "sourceYears": [
    ],
  • "tags": [
    ]
}

Service Response​

As part of the PersonActionsResponse entity, the property landlineVerification contains the results of the request.

LandlineVerificationActionResponse​

Array of objects (LandlineVerificationAction)
object (Meta)

Metadata describing the response produced.

{
  • "result": [
    ],
  • "meta": {
    }
}

If no Landline Verification has been requested, the response is empty.

If a Landline Verification has been requested, the following response is available:

ActionParameterDescription
landlineVerificationlandlinethe landline number supplied
statusbased on contact verification result