Skip to main content

Credit Linked Addresses Plus Check

Credit Linked Addresses can contain all 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 Addresses Plus:

InputDescription
ForenameFirst Name of the data subject
SurnameLast Name of the data subject
Full PostcodeFull postcode of the data subjects address
Building NumberAnd/Or the Building Name of the data subjects address
Building NameAnd/Or the Building Number of the data subjects address
Date of BirthFull date of birth of the data subject
GenderGender of the data subject in M/F format

Service Request​

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

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

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 PeopleActionsResponse entity, the property creditLinkedAddressesPlus contains the results of the request.

CreditLinkedAddressesPlusActionResponse​

Array of objects (CreditLinkedAddressesPlusLink)
object (Meta)

Metadata describing the response produced.

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