Address Parser

Introduction

This API allows users to parse the address line . It takes single address line, breaking it down into structured components: city, district, post office, and state.

API details

Endpoint

POST https://api.signzy.app/api/v3/address/parser

POST https://api-preproduction.signzy.app/api/v3/address/parser

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.

Request body

{
    "address": "Baladmari Cha Bagan, Agia Road  Near BOC, Baladmari Cha Bagan, Goalpara, Assam, 783121",
    "postOffice":true
}

Code samples

curl --location 'https://api-preproduction.signzy.app/api/v3/address/parser' \
--header 'Content-Type: application/json' \
--data '{
    "address": "Baladmari Cha Bagan, Agia Road  Near BOC, Baladmari Cha Bagan, Goalpara, Assam, 783121",
    "postOffice":true
}'

Response body parameters

Parameter	Data Type	Description
parsedAddress	Object	response object containing the parsed address.
parsedAddress.district	String	district specified in address line.
parsedAddress.state	Array of String	Name of the state in full and short form [ Uttar Prasesh, UP]
parsedAddress.city	String	Name of the city from address line.
parsedAddress.pincode	String	pincode from address line .
parsedAddress.country	Array of String	Name of country [ "IN", "IND", "INDIA" ]
parsedAddress.addressLine	String	cleaned address line after removing pincode country name ,
parsedAddress.postOffice	String	near by post office name from address line.

{
    "parsedAddress": {
        "district": "GOALPARA",
        "state": [
            "ASSAM",
            "AS"
        ],
        "city": "GOALPARA",
        "pincode": "783101",
        "country": [
            "IN",
            "IND",
            "INDIA"
        ],
        "addressLine": "BALADMARI CHA BAGAN,AGIA ROAD NEAR BOC,BALADMARI CHA BAGAN",
        "postOffice": "Baladmari"
    }
}

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!