address_cleanse
Theaddress_cleanse command is a pre-processing feature that increases match rates for address data within kyc_match. It standardizes raw user input into carrier-accepted formats by applying global mapping logic and operator-specific syntax rules.
Address normalization compares supplied information with standard tools like Google Maps to ensure the data conforms to formats likely to be accepted by the operator. Where known, operator-specific rules are applied to the address, such as standardizing the spelling of "Street" or "Avenue", to improve the probability of a successful match. For systems unable to delineate addresses into separate fields, the feature supports the inline_address input string, which automatically parses a single line of text into the required format.
This is a chargeable optional feature requested on a query-by-query basis. Setting the normalize field to TRUE triggers the operation, while setting the return_address parameter to TRUE ensures the modified address is included in the response. When active, the service returns the normalized_address JSON block alongside the standard kyc_results, providing a clear view of the modifications made to achieve the match.
Response Reference
| Field Name | Data Type | Output Values | Description |
|---|---|---|---|
| normalized_address | JSON Block | {address components} | Returned if address normalization is requested. Contains the corrected and formatted values for each address field used in the KYC match attempt. |
|
street_no street city province postcode country |
String | [string], Omitted |
The updated, standardized values for each challenge field. The match scores in kyc_results are calculated against these specific values.Omitted if normalization was not requested, if normalize_address is "n/a", or if Status 1 or 2 is returned.
|
| normalize_address | String | success, n/a, Omitted |
Indicates the outcome of the cleansing operation: success: Normalization completed successfully. n/a: Service unable to normalize the address for the destination territory. Omitted if normalization was not requested or if Status 1 or 2 is returned. |
Summary Table
| Command | Description | Response Values |
|---|---|---|
address_cleanse |
Normalizes and sanitizes the provided address to conform to MNO-specific formatting standards and mapping logic. |
|
Read this in the portal, with search and the reference beside it: Address Cleanse