During a Batch API search, the nature of processing and any changes made to the address are recorded in a match code. The match code is returned as a result of a call to the function QABatchWV_Clean. The first four characters of the match code provide the following information:
| Match Code element | Description |
|---|---|
| Match Success | A single upper case letter. This specifies how well Batch API matched the address. |
| Match Confidence Level | A single digit. This tells you how accurate Batch API thinks the match is. |
| Postal Code Action | A single digit. This indicates any action that Batch API has performed on the postcode. |
| Address Action | A single digit. This describes what action has been performed on the address. |
| Information Bits | A 24 digit number that is divided into an 8 digit general match information number and a 16 digit dataset-specific match information number. |
Successful suppressed records
The letter at the beginning of the match code indicates how successfully Batch API was able to match your input address to an address in an Experian Data Quality dataset.
The values of the match success letter are split into two ranges which indicate specific types of information:
The input address was not processed. The reason for this is specified by the letter returned.
| Match success letter | Description |
|---|---|
| A Unprocessed |
Results could not be returned for the input address. This reflects an internal processing issue. For example, if DPV processing has been locked because you encountered a seed address, then all US addresses will return an A match. |
| B Blank |
This means that Batch API could either find no data in the input address or the amount of information found is too insignificant to return an address. |
| C Country not available |
This match letter is returned when your input address contains a country name and the appropriate dataset is not installed. For example, if you do not have the Australia dataset, this address would return a C match:
If you want to restrict Batch API's ability to match against countries, use the CountryRevert configuration setting. |
| D Unidentified country |
A match letter of D is assigned to an address record when Batch API is unable to ascertain the record's country of origin and no default country has been configured (see the CountryBase configuration setting). |
The input address was processed, and the match quality is indicated by the letter returned.
If Batch API returns a Q or R match, along with a match confidence level of 9, you can be confident that it has found the right match.
| Match success letter | Description |
|---|---|
| K No address or postcode could be derived |
This match letter is used when Batch API cannot find any data which matches your input address. This might occur if the input address does not contain a country name and does not match anything in the default dataset. For example, if you processed "42 Durlston Square" against the GBR dataset, Batch API would return a K match. This is because Batch API cannot find any matching street names and has no other information (such as a locality or postcode) to search on. |
| L Postcode found, but no address could be derived |
This match letter is returned if Batch API derives a valid postal code from your input address, but no address information. |
| M Multiple addresses found, but no postcode |
Batch API returns this match letter if the input address matches more than one address in the dataset. For example, the following address finds four matches in the GBR dataset:
Because the address exists in the localities of Sawston, Cottenham, Chesterton and Landbeach, Batch API cannot determine which is the desired match. As all four potential matches have different postal codes and no single postal code can be returned, Batch API marks the address as an M match. |
| N Multiple addresses found with postcode |
This type of match is returned when Batch API finds more than one matching address within a postal code. This is most likely to occur where a country's postal codes cover large areas, such as in Australia. For example, this Australian address has two possible matches, because it exists in the localities of Kingsholme and Ormeau:
|
| O Partial address found, but no postcode |
In this case Batch API has found a partial address which matches your input. However, it cannot return a full postal code with it because the partial address is covered by more than one postal code. This might occur if your input address has a missing or invalid property number. Batch API cannot determine the correct property number and returns as much of the address as it can. For example, in the street of this UK address, number 70 does not exist:
As no postal code is included in the input address, Batch API does not know which of the street's two possible postal codes to return, and produces this output:
|
| P Partial address found with postcode |
Batch API has found a partial address which matches your input. In addition, either the input postal code was valid, or Batch API has managed to find a single postal code for the partial address. For example, if this Australian address is searched on:
Batch API is able to add a postal code and state code, but the missing property number prevents it from returning a full address. |
| Q Full address found, but no postcode |
This occurs when Batch API finds a full address which Full address found, matches your input data, but cannot find a full postal code to but no postcode go with it. This is most likely to happen if a dataset does not include postal codes for every address. |
| R Full address and postcode found |
In this case, Batch API has made a full match, either by simply verifying a correct input address, or by locating a full address from partial input data. These examples all return R matches:
However, an R match only signifies that a full address and postal code have been returned; it does not necessarily mean that the address is the one you want. You can gauge the likelihood of a correct match from the match confidence level. |
| S Address matched to one or more Suppression datasets |
This match code is only applicable when Batch API has matched an address against GBR or AUS Suppression data. When this match code is returned, all returned address information and information bits will be cleared other than the suppression information bit. If one or more DataPlus elements are configured in the output layout, this match code is no longer returned, and instead all address and suppression infobits are returned, including the suppression information bit. |
The match success letter only indicates what type of matching address has been found in the data, it does not indicate whether this address is a good match for your input data. This information is indicated by the Match Confidence Level.
The first digit in the match code indicates how confident Batch API is about the match it has returned.
There are three levels of confidence: low, intermediate and high. As the completeness of the returned address is determined by the match success letter, Batch API could return an R match with low confidence, indicating that although it has found a complete and correct address, it is not sure that it is the same address as the input.
Confidence is determined by the matching rules. Low confidence indicates that the essential matching rules were not satisfied. Intermediate confidence shows that the less important rules were not satisfied, or another check failed (for example, the input address is not in the expected order).
Batch API sets the confidence level to 0 if it finds a match which differs considerably from the input address. For example, take this UK address:
Rich & Carr, LE1 9GX
Batch API returns its nearest guess (Rich & Carr, PO Box 15, Leicester, LE1 9GX). As this is a full address, it is given an R match success letter. However, as the input address did not specify PO Box details, Batch API is not confident that this is the right match.
reduced intermediate confidence
Confidence level 5 is returned when Batch API is reasonably sure that it has found the right match. This might occur if the input address is slightly inaccurate. Consider this UK input address:
Churchill Green House, Churchill Green, Churchill, Winscombe, Avon, BS25 5QH
In this example, the building name is incorrect (it should be Churchill House). However, Batch API is able to find the correct address. Only the variance in building name prevents a high confidence match.
Batch API returns a 9 when it is certain that the output address matches the input data. This happens when an input address is fully accurate, or when partial address data is detailed enough (for example, exact property number, street and locality) to have the remaining address details appended. Consider this UK input address:
Castle Gayer Cottage,Leys Lane, Marazion, Cornwall, TR17 0AQ
In this example, the address is spelt correctly and is found in the data exactly as typed. A High Confidence match is returned.
The second digit in the match code signifies the action that Batch API has performed on the postal code.
There are four possible values for this digit:
| Value | Description |
|---|---|
| 3 | The existing postal code has been corrected. |
| 2 | A new postal code has been added. |
| 1 | The existing postal code was already correct. |
| 0 | No action was taken. |
The third digit in the match code tells you what Batch API has done to the address.
There are three possible values for this digit:
| Value | Description |
|---|---|
| 3 | Part of or a whole address was returned. The amount of address is signified by the match success letter. |
| 2 | The existing address was enhanced. No significant information has been removed, but some information has been added. |
| 1 | The existing address was already correct. |
| 0 | No action was taken as the supplied address was not matched. |
The hexadecimal information bits provide details of each match made by Batch API. They consist of:
The generic information bits provide detailed information on how well an address match conforms to the Batch matching rules. A brief explanation of each of the generic information bits as well as the dataset-specific infobits is provided below.
The numbers below are added together to make up the hexadecimal match code. For example, 0x000A0000 would be the result of an error in the input street name (0x00080000) and an added or changed street descriptor (0x00020000).
| Match flag | Information bit | Description |
|---|---|---|
| Bad Order | 0x10000000 | The elements in the input address were not in the expected order. For example, in the address 'Top Flat, 4 Baker Street, Dyfed, Aberystwyth, SY23 2BJ', the county (Dyfed) should appear after the town (Aberystwyth). In this example, infobit 00000020 is also returned as a result of the address cleaning process. |
| Preferred Failed | 0x20000000 | Preferred matching rules were not satisfied, and the match will be marked with, at best, intermediate confidence. |
| Close | 0x40000000 | The address has been marked with, at best, intermediate confidence because the close matching rules were not satisfied. |
| Conditional Formatting | 0x80000000 | Conditional formatting has taken place. Some address elements in the specified output format were not present in the matched address record and have been replaced with equivalent address elements. For more information on how Batch can apply conditional formatting when using a particular dataset, and which address elements may be affected, consult the relevant Data Guide. |
| Extra Numbers | 0x01000000 | Extra numbers were found in the address. An example might be '4 Granary 8 Road, Devizes, Wiltshire, SN10 3DP'. A full match was achieved (4 Granary Road, Devizes, Wiltshire, SN10 3DP), but the additional number(s) (i.e. '8' in the above example) may reduce the confidence level to intermediate. |
| Numbers Split | 0x02000000 | Additional text between a number and its expected adjacent component has been found, for example between a property number and a street name. The confidence level has been reduced to intermediate. |
| No Place | 0x04000000 | No place element (e.g. a locality in Australia) was found in the address, so the confidence level may be reduced. |
| NumChumMissing | 0x08000000 | The item associated with a number is missing. For example, the British address '4, South Marston, Swindon, SN3 4XX' is missing the street name 'Ash Gardens' after the building number. In this example, infobits 0x10000000 and 0x2000000 are also returned due to the absence of a street name. In addition, further infobits are returned as a result of the address cleaning process (i.e. adding the street name and reformatting the address). |
| Essential Failed | 0x00100000 | One or more essential matching rules were not satisfied, so the match confidence has been reduced to low. |
| Timeout | 0x00200000 | A timeout has occurred, and the address was not matched. The default timeout period is 5 seconds; you can change this with the configuration setting EngineTimeout in qaserve.ini. |
| Superset | 0x00400000 | The input address begins with unmatched text before a premise number. For example, the input address 'Village Arcade, 5 Hillcrest Road, Pennant Hill, NSW, 2120' contains more information than the official version, which does not contain the 'Village Arcade' element before the premise number, '5'. See also 0x00004000, which is similar but occurs even if no premise number is present. |
| Leading Number | 0x00800000 | A leading number was unused in the input address. For example, the Level 5 element in the address 'L 5, 2/6 The Bollard, Corlette, NSW' is not found in the official address. |
| Range Ambiguity | 0x00010000 | There was ambiguity in the supplied range of the input address. For example, the address '26-30 Delhi Street, Adelaide SA 5000' has an ambiguous range because there is a 26, 28 and 30 Delhi Street and the input address cannot be matched to a specific property. |
| StreetDescChanged | 0x00020000 | A street descriptor has been added or has been changed. For example, with '10 Railway Road, Serviceton, Vic', the correct descriptor 'Street', is returned instead of 'Road'. |
| Unignorable Text | 0x00040000 | Additional text in the input address was too significant to ignore. For example, the French address '18 boulevard Voltaire, 75011 Paris CEDEX 11' contains unmatched, but significant, information 'CEDEX 11'. This returns an intermediate confidence level. |
| Street Name Error | 0x00080000 | There was an error in the input street name that Batch has amended. |
| Place Name Error | 0x00001000 | There was an error in an input place name (for example, an Australian locality) that Batch has amended. |
| Premise Changed | 0x00002000 | Batch has added or changed a key premise number or range compared with the input address, such as a building number in Australia data where a single number matched to a range, or organization names in the France data. |
| Leading Unmatched | 0x00004000 | The input address begins with unmatched text. For example, the input address 'Rose Cottage, Hillcrest Road, Pennant Hill, NSW, 2120' contains more information than the official version, which does not contain the 'Rose Cottage' element. See also 0x00400000, which is similar but occurs only when the unmatched text occurs directly before a premise number. |
| Name Used | 0x00008000 | A name was used to secure an address match. |
| Address Truncated | 0x00000100 | The address line settings of the currently configured layout are of an insufficient width to contain each address element. Widen the address lines to ensure that the address elements are not truncated. |
| Address Overflow | 0x00000200 | Complete address element(s) are unable to fit on the address line. Widen the address lines to ensure that all of the address elements are visible. |
| Dataplus Failure | 0x00000400 | Batch failed to generate one or more non-address items. It is likely that the DataPlus set could not be opened. |
| Enhance Overflow | 0x00000800 | When in enhanced cleaning mode, Batch cannot fill the unmatched address elements back into the database. To resolve this, widen the address lines or add additional lines. |
| Enhance Reformat | 0x00000010 | Postal address elements have been moved to the right or downwards to allow unmatched elements to be incorporated in an enhanced address. |
| Address Cleaned | 0x00000020 | Batch has determined that the supplied address has been non-trivially cleaned. This means that spelling may have been corrected, capitalization changed, or the input address elements could have been reformatted in some way. Note that quotes and spaces are ignored during Batch's comparison process. |
| Verified Correct | 0x00000040 | Key input address elements were judged effectively correct as supplied, although the output address's representation or formatting may differ (for example, address elements may have been expanded or abbreviated, capitalization changes made, etc.). |
| InvalidInputSpec | 0x00000080 | If the user defines InputLineCount (including blank) and the input line count does not match the number of lines defined in the input search string (allowing for quotes), this bit will be set. This bit does not affect match confidence. |
| Test Failed | 0x00000001 | The final tests on the address have failed against the strict matching rules; hence the match confidence level is reduced to, at best, intermediate confidence. |
| Premise Partial | 0x00000002 | Batch has found a premise level partial address match. |
| Street Partial | 0x00000004 | Batch has found a street level partial address match. |
| Place Partial | 0x00000008 | Batch has found a place level partial address match. |
| Dataset | Match flag | Information bit | Description |
|---|---|---|---|
| AUS | REST API: street_place_unclear |
0x10000000 | Exact street match isn't possible as more than one non-exact match is possible by changing provided street or place. |
| AUS | REST API: street_type_unclear |
0x20000000 | Multiple or invalid street type(s) provided. Matching street elements are not unique for locality/state combination. |
| AUS | REST API: invalid_postal_delivery |
0x40000000 | Multiple PO Box type(s) provided or required PO Box type conversion invalid given other changes to input address to obtain a match. |
| AUS | REST API: bord_loc_match_prohibited |
0x80000000 | A bordering locality match is prohibited because a match is already available in provided locality. |
| AUS | REST API: no_valid_secondary |
0x01000000 | No valid secondary information provided for Primary Point. |
| AUS | REST API: real_primary_point |
0x02000000 | Real Primary Point matches. |
| AUS | REST API: phantom_primary_point |
0x04000000 | Phantom Primary Point matches. |
| AUS | REST API: user_info_blank |
0x00100000 | Provided Customer Barcode information is blank. |
| AUS | REST API: user_info_invalid |
0x00200000 | Provided Customer Barcode information contains invalid character(s). |
| AUS | REST API: user_info_too_long52 |
0x00400000 | Provided Customer Barcode information is too long for AUSBAR.Ext52 format. |
| AUS | REST API: user_info_too_long67 |
0x00800000 | Provided Customer Barcode information is too long for AUSBAR.Ext67 format. |
| AUS | REST API: build_num_changed |
0x00010000 | Provided building number changed (e.g. single number vs. range, number with suffix vs. number only). |
| AUS | REST API: build_name_error |
0x00020000 | Building name is different from input address. |
| AUS | REST API: floor_level_changed |
0x00040000 | Floor/level element added or changed. |
| AUS | REST API: flat_unit_changed |
0x00080000 | Flat/unit element added or changed. |
| AUS | REST API: street_name_error |
0x00001000 | Street name is different from input address. |
| AUS | REST API: street_type_changed |
0x00002000 | Street type added or changed. |
| AUS | REST API: street_suffix_changed |
0x00004000 | Street type suffix added or changed. |
| AUS | REST API: street_alt_matched |
0x00008000 | An alternate street form matches and is retainable in output address. |
| AUS | REST API: locality_error |
0x00000100 | Locality is different from input address. |
| AUS | REST API: state_error |
0x00000200 | State is different from input address. |
| AUS | REST API: secondary_type_retained |
0x00000400 | Secondary type is retained in output address. |
| AUS | REST API: bord_locality_matched |
0x00000800 | Bordering locality and postcode combination matched and is retainable in output address. |
| AUS | REST API: group_did_matched |
0x00000010 | Street level (DID) address matches the input address. |
| AUS | REST API: locality_did_matched |
0x00000020 | Locality level (DID) address matches the input address. |
| AUG | REST API: street_alias_matched |
0x10000000 | Street alias matches and is retainable in output address. |
| AUG | REST API: loc_alias_matched |
0x20000000 | Locality alias matches and is retainable in output address. |
| AUG | REST API: bordering_loc_matched |
0x40000000 | Bordering locality matches and is retainable in output address. |
| AUG | REST API: prem_matched |
0x01000000 | Match to premises-level (building number) only. Doesn't match to provided sub-premises. |
| AUG | REST API: secondary_unmatched |
0x04000000 | A building number and valid secondary information provided but neither matched. The unmatched information can be retained in output address. |
| AUG | REST API: po_box_unmatched |
0x00100000 | Valid PO Box type provided but the address only matches to locality level. |
| FRA | REST API: already_correct |
0x10000000 | Address is correct as provided. |
| FRA | REST API: corrected |
0x20000000 | Provided address matches, but some elements are corrected or changed in the output address. |
| FRA | REST API: to_be_checked |
0x40000000 | A match was found but the address should be checked. |
| FRA | REST API: unclear |
0x80000000 | As well as the returned address, one or more alternatives have been found. |
| FRA | REST API: afnor_compliant_addr |
0x01000000 | The output address is AFNOR compliant. |
| FRA | REST API: street_retained |
0x00000010 | Street retained in output address. |
| FRA | REST API: locality_retained |
0x00000020 | Locality retained in output address. |
| FRA | REST API: po_box_retained |
0x00000040 | PO Box retained in output address. |
| FRA | REST API: org_retained |
0x00000080 | Organization retained in output address. |
| FRA | REST API: sec_street_retained |
0x00001000 | Secondary street retained in output address. |
| FRA | REST API: number_retained |
0x00000001 | Number retained in output address. |
| FRA | REST API: number_extretained |
0x00000002 | Number extension retained in output address. |
| FRA | REST API: sec_num_retained |
0x00000100 | Secondary premise number retained in output address. |
| FRA | REST API: sec_num_ext_retained |
0x00000200 | Secondary premise extension retained in output address. |
| DEU | REST API: town_reg_matched |
0x00000001 | Town - Region matches. |
| GBR | REST API: postcode_recoded |
0x10000000 | Postcode has been recoded. |
| GBR | REST API: multiple_recodes |
0x20000000 | Multiple recodes exist for input Postcode. |
| GBR | REST API: town_changed |
0x01000000 | Town added or changed. |
| GBR | REST API: county_changed |
0x02000000 | County added or changed. |
| GBR | REST API: pnr_county_present |
0x04000000 | PNR county present for output address. |
| GBR | REST API: dep_locality_changed |
0x00100000 | Dependent Locality added or changed. |
| GBR | REST API: double_dep_locality_changed |
0x00200000 | Double Dependent Locality added or changed. |
| GBR | REST API: pnr_locality_matched |
0x00400000 | PNR Locality matches and is retainable in output address. |
| GBR | REST API: street_name_error |
0x00010000 | Thoroughfare name difference. |
| GBR | REST API: street_desc_changed |
0x00020000 | Thoroughfare descriptor added or changed. |
| GBR | REST API: dep_street_name_error |
0x00040000 | Dependent Thoroughfare name difference. |
| GBR | REST API: dep_street_desc_changed |
0x00080000 | Dependent Thoroughfare descriptor added or changed. |
| GBR | REST API: build_num_changed |
0x00001000 | Provided main building number differs from the PAF (e.g. single number vs. range, number with suffix vs. number only). |
| GBR | REST API: build_name_error |
0x00002000 | Main building name difference. |
| GBR | REST API: sub_build_num_changed |
0x00004000 | Sub-building number differs from the PAF. |
| GBR | REST API: sub_build_name_error |
0x00008000 | Sub-building name difference. |
| GBR | REST API: organization_error |
0x00000100 | Organization name difference. |
| GBR | REST API: org_match_to_abbreviated |
0x00000200 | The organization name matches an abbreviated version (input words mapped to the PAF initials). |
| GBR | REST API: department_error |
0x00000400 | Department name difference. |
| NLD | REST API: town_changed |
0x01000000 | Town added or changed. |
| NLD | REST API: nen_town_matched |
0x02000000 | NEN town/city matches. |
| NLD | REST API: tpg_town_matched |
0x04000000 | TPG town/city matches. |
| NLD | REST API: unofficial_town_matched |
0x08000000 | The unofficial town/city name matches. |
| NLD | REST API: street_name_error |
0x00100000 | Street name difference. |
| NLD | REST API: nen_street_matched |
0x00200000 | NEN street matches. |
| NLD | REST API: tpg_street_matched |
0x00400000 | TPG street matches. |
| NLD | REST API: official_street_matched |
0x00800000 | Official street matches. |
| NLD | REST API: house_num_changed |
0x00010000 | House number/extension differs from the PAF. |
| NZL | REST API: sendright_valid_match |
0x10000000 | SendRight - Unique address match. |
| NZL | REST API: sendright_base_match |
0x20000000 | SendRight - Base address match. |
| NZL | REST API: sendright_invalid_match |
0x40000000 | SendRight - Invalid address match. |
| NZL | REST API: sub_preminfo_changed |
0x01000000 | Output address enhanced with sub-premises information. |
| NZL | REST API: street_type_changed |
0x02000000 | Street type difference. |
| NZL | REST API: street_name_changed |
0x04000000 | Street name difference. |
| NZL | REST API: street_direction_changed |
0x08000000 | Street direction difference. |
| NZL | REST API: rd_changed |
0x00200000 | Rural Delivery difference. |
| NZL | REST API: invalid_suburb_match |
0x00400000 | Valid match, but to an invalid suburb. |
| NZL | REST API: rd_no_premise |
0x00800000 | Rural delivery match, but no premise information. |
| NZL | REST API: post_restante_excl_soa |
0x00010000 | Matches to Poste Restante address. |
| NZL | REST API: private_bag_excl_soa |
0x00020000 | Private Bag with no bag number provided |
| NZL | REST API: lobby_changed |
0x00040000 | Lobby added or changed. |
| NZL | REST API: suburb_changed |
0x00080000 | Suburb added or changed. |
| NZL | REST API: city_changed |
0x00001000 | City added or changed. |
| NZL | REST API: suburb_alias_match |
0x00002000 | Suburb alias matches and is retainable in output address. |
| NZL | REST API: city_alias_match |
0x00004000 | City alias matches and is retainable in output address. |
| NZL | REST API: deleted_record |
0x00000100 | Deleted record matches. |
| NZL | REST API: presort_unique_match |
0x00000010 | PreSort - Unique match. |
| NZL | REST API: presort_base_match |
0x00000020 | PreSort - Base match. |
| NZL | REST API: presort_range_match |
0x00000040 | PreSort - Range match. |
| NZL | REST API: presort_rbase_match |
0x00000080 | PreSort - Rural Base match. |
| NZL | REST API: presort_ambig_match |
0x00000001 | PreSort - Ambiguous match. |
| NZL | REST API: confidence_decreased |
0x00000002 | Confidence level was decreased. |
| SGF | REST API: floor_unit_retained |
0x00000001 | Floor/unit number(s) retained in output address. |
| SGF | REST API: add_unit_retained |
0x00000002 | Additional unit information retained in output address. |
| IRL | REST API: eng_pri_locality_added |
0x10000000 | English Primary Locality added to output address. |
| IRL | REST API: gae_pri_locality_added |
0x20000000 | Gaelic Primary Locality added to output address. |
| IRL | REST API: eng_sec_locality_added |
0x40000000 | English Secondary Locality added to output address. |
| IRL | REST API: gae_sec_locality_added |
0x80000000 | Gaelic Secondary Locality added to output address. |
| IRL | REST API: street_retained |
0x01000000 | Street retained in output address. |
| IRL | REST API: street_added |
0x02000000 | Street added to output address. |
| IRL | REST API: match_bord_locality |
0x00100000 | Bordering Locality matches. |
| IRL | REST API: match_bord_dublin |
0x00200000 | Bordering Dublin district number matches. |
| IRL | REST API: wrong_dublin_district |
0x00400000 | Wrong Dublin district number provided. |
| IRL | REST API: match_bord_county |
0x00800000 | Bordering county matches. |
| IRL | REST API: post_town_added |
0x00020000 | Posttown added to output address. |
| IRL | REST API: gae_thoroughfare |
0x00001000 | Gaelic Primary Thoroughfare available. |
| IRL | REST API: gae_sec_thoroughfare |
0x00002000 | Gaelic Secondary Thoroughfare available. |
| IRL | REST API: gae_locality |
0x00004000 | Gaelic Locality available. |
| IRL | REST API: gae_sec_locality |
0x00008000 | Gaelic Secondary Locality available. |
| IRL | REST API: eng_post_town_removed |
0x00000100 | English Posttown removed from output address. |
| IRL | REST API: gae_post_town_removed |
0x00000200 | Gaelic Posttown removed from output address. |
| IRL | REST API: res_eng_post_town_removd |
0x00000400 | English resident preferred Posttown removed from output address. |
| IRL | REST API: res_gae_post_town_removd |
0x00000800 | Gaelic resident preferred Posttown removed from output address. |
| IRL | REST API: verified_correct_changed |
0x00000010 | Minor change applied. |
| IRL | REST API: eircode_only_input |
0x00000020 | Only Eircode provided in input. |
| Dataset | Match flag | Information bit | Description |
|---|---|---|---|
| APR | REST API: uprn_provided |
0x10000000 | UPRN was provided. |
| APR | REST API: uprn_matched |
0x20000000 | UPRN matches. |
| APR | REST API: uprn_corrected |
0x40000000 | UPRN was changed in output address. |
| APR | REST API: uprn_added |
0x80000000 | UPRN was added to output address. |
| APR | REST API: udprn_provided |
0x01000000 | UDPRN was provided. |
| APR | REST API: udprn_matched |
0x02000000 | UDPRN matches. |
| APR | REST API: udprn_corrected |
0x04000000 | UDPRN was changed in output address. |
| APR | REST API: udprn_added |
0x08000000 | UDPRN was added to output address. |
| APR | REST API: address_provided |
0x00100000 | Address was provided. |
| APR | REST API: language_changed |
0x00200000 | Language of address elements was changed (e.g. supplied in Welsh but returned in English). |
| APR | REST API: paf_fields_missing |
0x00400000 | Royal Mail PAF elements are missing from output address. |
| APR | REST API: gazetteer_fields_missing |
0x00800000 | Gazetteer elements are missing from output address. |
| AUS | REST API: bsp_state_nsw |
0x10000000 | BSP assigned state As NSW. |
| AUS | REST API: bsp_state_act |
0x20000000 | BSP assigned state As ACT. |
| AUS | REST API: bsp_state_vic |
0x40000000 | BSP assigned state As VIC. |
| AUS | REST API: bsp_state_qld |
0x80000000 | BSP assigned state As QLD. |
| AUS | REST API: bsp_state_sa |
0x01000000 | BSP assigned state As SA. |
| AUS | REST API: bsp_state_wa |
0x02000000 | BSP assigned state As WA. |
| AUS | REST API: bsp_state_tas |
0x04000000 | BSP assigned state As TAS. |
| AUS | REST API: bsp_state_nt |
0x08000000 | BSP assigned state As NT. |
| GBR | REST API: surname_matched |
0x10000000 | Provided surname matches. |
| GBR | REST API: forename_matched |
0x20000000 | Provided forename matches. |
| GBR | REST API: forename_initial_match |
0x40000000 | The provided forename initial matches the full forename. |
| GBR | REST API: middle_initial_matched |
0x80000000 | The provided forename and middle name (or forename initial and middle initial) matches the forename initial and middle initial. |
| GBR | REST API: name_title_matched |
0x01000000 | Provided title matches. |
| GBR | REST API: name_gender_match |
0x02000000 | The gender of the provided forename matches. |
| GBR | REST API: forename_matched_initial |
0x04000000 | The provided forename matches the forename initial. |
| GBR | REST API: forename_alias_matched |
0x00100000 | Provided forename matches to forename alias. |
| GBR | REST API: name_typo_match |
0x00200000 | Typo(s) exist in the provided forename and/or surname. |
| GBR | REST API: forename_swap_match |
0x00400000 | Provided forename and middle name were swapped. |
| GBR | REST API: multiple_name_matches |
0x00800000 | Multiple full name matches found. |
| GBR | REST API: dnb_org_present |
0x00010000 | Experian organization present for matched address. |
| GBR | REST API: dnb_alias_org_matched |
0x00020000 | Experian organization trading style alias retainable in output address. |
