Phone Batch Cleansing
Data must be provided in a csv file, containing the following columns.
| Column | Type | Required | Description |
|---|---|---|---|
id | string | A unique identifier for the row | |
phone_country | string | ✔️ | The country provided in ISO 3166 format |
phone_number | string | ✔️ | The phone number to be cleansed |
It is possible to perform more than one type of cleanse on a single CSV file. For example, a phone cleanse could be run on a file, followed by an address cleanse. Make sure that all the required columns are included for each cleanse you wish to perform. The columns can be included in any order. Fields can be left blank if the column is not applicable.
Cleansed File
The returned file will contain the provided columns, and the following:
phone_match_statusphone_error_codescleansed_phone_countrycleansed_phone_number_internationalcleansed_phone_number_national
The phone_match_status column will contain the status of the cleanse.
| Status | Description |
|---|---|
full_match | The phone number was found and is a perfect match |
partial_match | The phone number was found for a different country |
no_match | The phone number was not found |
error | There was an error with the phone cleanse |
The phone_error_codes column will contain a comma separated list of reasons why the cleanse wasn't a full match
phone_country
| Error | Description |
|---|---|
phone_country_corrected | The provided country was not valid for the phone number |
phone_number
| Error | Description |
|---|---|
phone_number_invalid_format | The provided phone number is not in a valid format |
phone_number_invalid | The provided phone number is not a valid number |