Address Match
Introduction
The Address Match API is a sophisticated tool designed to simplify and enhance the process of address verification. This API efficiently compares two given address strings and determines their similarity, providing a clear indication of whether the addresses match. Upon a simple request with two addresses, the API analyzes and returns a detailed response, including the difference in distance (in kilometers and meters), pin match results, and a distance match status. Furthermore, it calculates an address match score using the Jaro-Winkler method for precise similarity measurement. This API is indispensable for applications involving address verification, fraud detection, or logistics, where accurate address matching is crucial.
API details
Endpoint
POST https://api.signzy.app/api/v3/matcher/addressMatcherPOST https://api-preproduction.signzy.app/api/v3/matcher/addressMatcherRequest body parameters
Parameter | Data Type | Description | Required |
|---|---|---|---|
address1 | String | First line of the address | Yes |
address2 | String | Second line of the address | Yes |
{
"address1": "Address 1",
"address2": "Address 2"
}Request Headers
Name | Value | Required | Description |
|---|---|---|---|
Content-type | application/json | Mandatory | The type of content that the request body contains. |
Authorization | XXXXXXXXXXXXXXX | Mandatory | An authentication token to authorize the request. Reach out to the Signzy support team to get one created. |
Code Samples
curl --location 'https://api-preproduction.signzy.app/api/v3/matcher/addressMatcher' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Authorization token>' \
--data '{
"address1": "<Address 1>",
"address2": "<Address 2>"
}'Response body parameters
Parameter | Data type | Description |
|---|---|---|
result | Object | Response of the API |
result.addressDiffInKm | Integer | The difference in kilometers between the two addresses |
result.addressDiffInMeters | Integer | The difference in meters between the two addresses |
result.pinMatchResult | String | Indicates if the PIN codes match |
result.distanceMatch | String | If the distance in Kms is between 0-50 then Match, 50-500 is "Partial Match" and more than 500 is 'No Match'. |
result.addressMatch | String | Indicates if the address strings are matching. The possible values are 'Direct Match' and 'No Match'. |
result.addressMatchJaroWinklerScore | String | The Jaro-Winkler score for address string similarity. |
{
"result": {
"addressDiffInKm": 0,
"addressDiffInMeters": 597,
"pinMatchResult": "Match",
"distanceMatch": "Match",
"addressMatch": "No Match",
"addressMatchJaroWinklerScore": "45.01"
}
}Contact Us for Any Assistance
If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.
We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!