Please note that this is a legacy product in retirement.
Field Name | Type | Description |
---|---|---|
securityHeader | SecurityHeader | The username and authentication token used to access the system. |
profileRequest | ProfileRequestCapture | Details of the request |
Profile | GUID |
---|---|
AddressBase Lite | BCB96C1A-BC4C-4110-8A9E-A097B55380BB |
Key | Description |
---|---|
UPRN | Unique property reference number |
RM_UDPRN | Royal Mail unique delivery point reference number |
Key Mnemonic | Description | Returned By Default |
---|---|---|
COUNTRYCODE | Country code | Yes |
UDPRN | PAF unique delivery point reference number | Yes |
RM_UDPRN | Royal Mail unique delivery point reference number | Yes |
POSTCODE_LOCATOR | Postcode Locator | Yes |
LPI_STATUS | LPI Logical Status | Yes |
SAO_START_NUMBER | SAO Start Number | Yes |
SAO_START_SUFFIX | SAO Start Suffix | Yes |
SAO_END_NUMBER | SAO End Number | Yes |
SAO_END_SUFFIX | SAO End Suffix | Yes |
SAO_TEXT | SAO Text | Yes |
PAO_START_NUMBER | PAO Start Number | Yes |
PAO_START_SUFFIX | PAO Start Suffix | Yes |
PAO_END_NUMBER | PAO End Number | Yes |
PAO_END_SUFFIX | PAO End Suffix | Yes |
PAO_TEXT | PAO Text | Yes |
AREA_NAME | Area Name | Yes |
ST_DESCRIPTION | Street Description | Yes |
ST_LOCALITY | Street Locality | Yes |
ST_TOWN | Street Town | Yes |
ST_ADMIN_AREA | Street Administrative Area | Yes |
ORG_ORGANISATION | Organisation Name | Yes |
ORG_LEGAL_NAME | Legal Name | Yes |
DPA_ORG_NAME | DPA Organisation | Yes |
DPA_DEP_NAME | DPA Department | Yes |
DPA_SUB_NAME | DPA Sub-Building | Yes |
DPA_BLD_NAME | DPA Building Name | Yes |
DPA_BLD_NO | DPA Building Number | Yes |
DPA_DEPTFARE_NAME | DPA Dependent Thoroughfare | Yes |
DPA_TFARE_NAME | DPA Thoroughfare | Yes |
DPA_DEPLOC | DPA Double Dependent Locality | Yes |
DPA_LOCALITY | DPA Dependent Locality | Yes |
DPA_POSTTOWN | DPA Post Town | Yes |
DPA_POSTCODE | DPA Postcode | Yes |
DPA_CYM_DEPTFARE | DPA Welsh Dependent Thoroughfare | Yes |
DPA_CYM_TFARE | DPA Welsh Thoroughfare | Yes |
DPA_CYM_DEPLOC | DPA Welsh Double Dependent Locality | Yes |
DPA_CYM_LOCALITY | DPA Welsh Dependent Locality | Yes |
DPA_CYM_POSTTOWN | DPA Welsh Post Town | Yes |
DPA_POBOX | DPA PO Box Number | Yes |
DPA_DPS | DPA Delivery Point Suffix | Yes |
Key | Possible Values | Description |
---|---|---|
LOC_INT | ”Yes” or “No” | Request Location Intelligence information to be returned |
PREMISE_GEOCODE | ”Yes” or “No” | Request Premise Level Geocode information to be returned |
Field | Related Data Item Key | Location In Response |
---|---|---|
UDPRN | UDPRN | IdmDataAddress → uprn |
RM_UDPRN | RM_UDPRN | IdmDataAddress → rmUDPRN |
POSTCODE_LOCATOR | POSTCODE_LOCATOR | IdmDataAddress → IdmDataBLPU → postcodeLocator |
LPI_STATUS | LPI_STATUS | IdmDataAddress → IdmDataLPI → lpiLogicalStatus |
SAO_START_NUMBER | SAO_START_NUMBER | IdmDataAddress → IdmDataLPI → saoStartNumber |
SAO_START_SUFFIX | SAO_START_SUFFIX | IdmDataAddress → IdmDataLPI → saoStartSuffix |
SAO_END_NUMBER | SAO_END_NUMBER | IdmDataAddress → IdmDataLPI → saoEndNumber |
SAO_END_SUFFIX | SAO_END_SUFFIX | IdmDataAddress → IdmDataLPI → saoEndSuffix |
SAO_TEXT | SAO_TEXT | IdmDataAddress → IdmDataLPI → saoText |
PAO_START_NUMBER | PAO_START_NUMBER | IdmDataAddress → IdmDataLPI → paoStartNumber |
PAO_START_SUFFIX | PAO_START_SUFFIX | IdmDataAddress → IdmDataLPI → paoStartSuffix |
PAO_END_NUMBER | PAO_END_NUMBER | IdmDataAddress → IdmDataLPI → paoEndNumber |
PAO_END_SUFFIX | PAO_END_SUFFIX | IdmDataAddress → IdmDataLPI → paoEndSuffix |
PAO_TEXT | PAO_TEXT | IdmDataAddress → IdmDataLPI → paoText |
AREA_NAME | AREA_NAME | IdmDataAddress → IdmDataLPI → areaName |
ST_DESCRIPTION | ST_DESCRIPTION | IdmDataAddress → IdmDataStreetDescriptor → streetDescription |
ST_LOCALITY | ST_LOCALITY | IdmDataAddress → IdmDataStreetDescriptor → locality |
ST_TOWN | ST_TOWN | IdmDataAddress → IdmDataStreetDescriptor → townName |
ST_ADMIN_AREA | ST_ADMIN_AREA | IdmDataAddress → IdmDataStreetDescriptor → administrativeArea |
ORG_ORGANISATION | ORG_ORGANISATION | IdmDataAddress → IdmDataCompanyInformation → organisationName |
ORG_LEGAL_NAME | ORG_LEGAL_NAME | IdmDataAddress → IdmDataCompanyInformation → legalOrganisationLegalName |
DPA_ORG_NAME | DPA_ORG_NAME | IdmDataAddress → additionalItems → DPA_ORG_NAME |
DPA_DEP_NAME | DPA_DEP_NAME | IdmDataAddress → additionalItems → DPA_DEP_NAME |
DPA_SUB_NAME | DPA_SUB_NAME | IdmDataAddress → additionalItems → DPA_SUB_NAME |
DPA_BLD_NAME | DPA_BLD_NAME | IdmDataAddress → additionalItems → DPA_BLD_NAME |
DPA_BLD_NO | DPA_BLD_NO | IdmDataAddress → additionalItems → DPA_BLD_NO |
DPA_DEPTFARE_NAME | DPA_DEPTFARE_NAME | IdmDataAddress → additionalItems → DPA_DEPTFARE_NAME |
DPA_TFARE_NAME | DPA_TFARE_NAME | IdmDataAddress → additionalItems → DPA_TFARE_NAME |
DPA_DEPLOC | DPA_DEPLOC | IdmDataAddress → additionalItems → DPA_DEPLOC |
DPA_LOCALITY | DPA_LOCALITY | IdmDataAddress → additionalItems → DPA_LOCALITY |
DPA_POSTTOWN | DPA_POSTTOWN | IdmDataAddress → additionalItems → DPA_POSTTOWN |
DPA_POSTCODE | DPA_POSTCODE | IdmDataAddress → additionalItems → DPA_POSTCODE |
DPA_CYM_DEPTFARE | DPA_CYM_DEPTFARE | IdmDataAddress → welshSubStreet |
DPA_CYM_TFARE | DPA_CYM_TFARE | IdmDataAddress → welshStreet |
DPA_CYM_DEPLOC | DPA_CYM_DEPLOC | IdmDataAddress → welshSubLocality |
DPA_CYM_LOCALITY | DPA_CYM_LOCALITY | IdmDataAddress → welshLocality |
DPA_CYM_POSTTOWN | DPA_CYM_POSTTOWN | IdmDataAddress → welshTown |
DPA_POBOX | DPA_POBOX | IdmDataAddress → additionalItems → DPA_POBOX |
DPA_DPS | DPA_DPS | IdmDataAddress → additionalItems → DPA_DPS |