Skip to main content

Credit Linked Address Check

Credit Linked Addresses can contain up to a six-year address history of a data subject.

Minimum Requirements​

The following table lists the minimum inputs required to make a valid request for a Credit Linked Address:

InputDescription
ForenameFirst Name of the individual
SurnameLast Name of the individual
Full PostcodeFull post code of the individual
Building NumberAnd/Or the Building Number of the individual
Building NameAnd/Or the Building Name of the individual

Service Request​

To request for a Credit Linked Address check, add a CREDIT_LINKED_ADDRESSES action to the request body entity PeopleActionsRequest:

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

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 creditLinkedAddresses contains the results of the request.

CreditLinkedAddressesActionResponse​

Array of objects (CreditLinkedAddressesLink)
object (Meta)

Metadata describing the response produced.

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