COD address and phone checks
import { scoreAddress, phoneRiskSignals } from 'pakdatakit/quality'
Two checks for cash on delivery and other courier orders. scoreAddress() says how much a free-form address tells a rider. phoneRiskSignals() flags a phone number a courier cannot reach by SMS or call, or that looks made up.
scoreAddress() 85 / 100, phoneRiskSignals() Check
- Address score
- 85 / 100
- Missing
- postal code
- Warnings
- —
- Phone flags
- sequential-digits, test-number
Examples
Section titled “Examples”import { scoreAddress, phoneRiskSignals } from 'pakdatakit';
scoreAddress('House 7, Street 2, near Jamia Masjid, Multan');// → {// "score": 85,// "missing": [// "postalCode"// ],// "parsed": {// "raw": "House 7, Street 2, near Jamia Masjid, Multan",// "street": "House 7",// "area": "Street 2, near Jamia Masjid",// "city": "Multan",// "district": null,// "province": "Punjab",// "postalCode": null,// "warnings": []// }// }
phoneRiskSignals('0333 1234500');// → []
phoneRiskSignals('0300 1234567');// → ['sequential-digits', 'test-number']
phoneRiskSignals('042-35761234');// → ['landline']from pakdatakit import score_address, phone_risk_signals
score_address('House 7, Street 2, near Jamia Masjid, Multan')# → {# "score": 85,# "missing": [# "postalCode"# ],# "parsed": {# "raw": "House 7, Street 2, near Jamia Masjid, Multan",# "street": "House 7",# "area": "Street 2, near Jamia Masjid",# "city": "Multan",# "district": None,# "province": "Punjab",# "postal_code": None,# "warnings": []# }# }
phone_risk_signals('0333 1234500')# → []
phone_risk_signals('0300 1234567')# → ['sequential-digits', 'test-number']
phone_risk_signals('042-35761234')# → ['landline']import 'package:pakdatakit/pakdatakit.dart';
scoreAddress('House 7, Street 2, near Jamia Masjid, Multan');// → {// "score": 85,// "missing": [// "postalCode"// ],// "parsed": {// "raw": "House 7, Street 2, near Jamia Masjid, Multan",// "street": "House 7",// "area": "Street 2, near Jamia Masjid",// "city": "Multan",// "district": null,// "province": "Punjab",// "postalCode": null,// "warnings": []// }// }
phoneRiskSignals('0333 1234500');// → []
phoneRiskSignals('0300 1234567');// → [PhoneRiskFlag.sequentialDigits, PhoneRiskFlag.testNumber]
phoneRiskSignals('042-35761234');// → [PhoneRiskFlag.landline]using PakDataKit;
Quality.ScoreAddress("House 7, Street 2, near Jamia Masjid, Multan");// → {// "score": 85,// "missing": [// "postalCode"// ],// "parsed": {// "raw": "House 7, Street 2, near Jamia Masjid, Multan",// "street": "House 7",// "area": "Street 2, near Jamia Masjid",// "city": "Multan",// "district": null,// "province": "Punjab",// "postalCode": null,// "warnings": []// }// }
Quality.PhoneRiskSignals("0333 1234500");// → []
Quality.PhoneRiskSignals("0300 1234567");// → [PhoneRiskFlag.SequentialDigits, PhoneRiskFlag.TestNumber]
Quality.PhoneRiskSignals("042-35761234");// → [PhoneRiskFlag.Landline]use PakDataKit\Quality;
Quality::scoreAddress('House 7, Street 2, near Jamia Masjid, Multan');// → {// "score": 85,// "missing": [// "postalCode"// ],// "parsed": {// "raw": "House 7, Street 2, near Jamia Masjid, Multan",// "street": "House 7",// "area": "Street 2, near Jamia Masjid",// "city": "Multan",// "district": null,// "province": "Punjab",// "postalCode": null,// "warnings": []// }// }
Quality::phoneRiskSignals('0333 1234500');// → []
Quality::phoneRiskSignals('0300 1234567');// → ['sequential-digits', 'test-number']
Quality::phoneRiskSignals('042-35761234');// → ['landline']Reference
Section titled “Reference”scoreAddress()
Section titled “scoreAddress()”function scoreAddress(input: string): AddressScore;
type AddressPart = 'city' | 'houseNumber' | 'street' | 'area' | 'postalCode' | 'landmark';
interface AddressScore { score: number; // 0 (unusable) to 100 (every part present and consistent) missing: AddressPart[]; // in the order of ADDRESS_WEIGHTS parsed: ParsedAddress; // as parseAddress reads it, with any extra warnings}
const ADDRESS_WEIGHTS: Readonly<Record<AddressPart, number>> = { city: 30, houseNumber: 20, street: 15, area: 10, postalCode: 15, landmark: 10,};Parameters. input: a free-form Pakistani delivery address.
Returns a score from 0 to 100, the parts not found, and the parsed address. It looks for a city, a house, plot or flat number, a street, an area, a postal code and a landmark (“near”, “opp”, “nazd”, “qareeb” and their Urdu forms), and adds up ADDRESS_WEIGHTS. It never throws.
Caveats.
- This is a heuristic: it says how much an address tells a rider, not whether the address exists.
- A postal code scores in full only when it is a known post office code; an unknown one scores 5.
- A post office in a different province from the city lowers the score, with a warning in
parsed.warnings.
Related: parseAddress(), Postal codes.
phoneRiskSignals()
Section titled “phoneRiskSignals()”function phoneRiskSignals(input: string): PhoneRiskFlag[];
type PhoneRiskFlag = | 'invalid' | 'landline' | 'not-mobile' | 'repeated-digits' | 'sequential-digits' | 'test-number';Parameters. input: a phone number in local or international format.
Returns a list of reasons to double-check the number. A valid mobile number with nothing suspicious returns []. It never throws.
invalid: not a Pakistani phone number.landline: a fixed-line number (no SMS, often unanswered).not-mobile: a UAN, toll-free or other service number.repeated-digits: the 7-digit subscriber part uses at most two different digits (0300-0000000,0300-1111112).sequential-digits: the subscriber part is a run such as1234567or7654321.test-number: a placeholder often typed into forms (03XX-1234567,03XX-7654321,0312-3456789).
Caveats. Pure heuristics on the number itself: no list of real numbers, no personal data, no network call.
Related: analyzeNumber(), validatePhone().
Related
Section titled “Related”- Address: parse a free-form address.
- Courier: courier helpers.
- Numbers: landlines, UAN and toll-free numbers.
- Phone: validate and format mobile numbers.
- API reference