The Address object

The Address object represents a physical address captured through the Geophrase widget and resolved via the Resolve endpoint. It contains everything you need to identify the capture, render it back to the customer, and locate the place on a map.

The short_link and qr_code are the routing bridge between a captured address and the rider who delivers it. Print the QR on the parcel (or drop the short link into your courier's landmark field) and any rider can scan or tap it to open turn-by-turn navigation to the captured GPS pin. No Geophrase account or app is required on their end.

All fields are always present. No field is ever null. order_id, landmark, and address_line_two may be empty strings if not supplied.

Example object

{
    "short_code": "cea-yau-cal",
    "short_link": "https://gphr.in/cea-yau-cal",
    "qr_code": "https://storage.googleapis.com/geophrase/qr-codes/cea-yau-cal.png",
    "captured_at": 1778485231452,
    "order_id": "ORD-8786",
    "address": {
        "city": "Bengaluru",
        "state": "Karnataka",
        "digi_pin": "1A2-B3C-4D5E",
        "landmark": "Map: gphr.in/cea-yau-cal",
        "latitude": 12.9545,
        "longitude": 77.5736,
        "postal_code": 560004,
        "address_type": "HOUSE",
        "address_line_one": "123, Vidyarathi Bhavan",
        "address_line_two": "Near Gandhi Bazaar",
        "contact_full_name": "Suresh Kumar",
        "verified_mobile_num": "9999999999"
    }
}

Top-level fields

Field	Type	Description
`short_code`	String	A unique, human-readable identifier for the captured address.
`short_link`	String	Public short URL pointing to the captured address (`https://gphr.in/<short_code>`). Opening it routes a rider to the captured GPS pin.
`qr_code`	String	URL to a QR code image that encodes `short_link`. Print it on the shipping label so a rider can scan straight to the customer's location.
`captured_at`	Number	Capture timestamp as milliseconds since the Unix epoch.
`order_id`	String	Merchant-supplied reference echoed back from the resolve request. Can be an empty string if no `order_id` was supplied. See Resolve endpoint for how `order_id` is stored and updated.
`address`	Object	Structured address fields. See below.

`address` fields

Field	Type	Description
`city`	String	The city where the address is located.
`state`	String	State or union territory name.
`digi_pin`	String	India Post DIGIPIN code for the coordinate.
`landmark`	String	A nearby landmark to help locate the address. Can be an empty string if user left it empty.
`latitude`	Number	Geographic latitude of the address coordinate.
`longitude`	Number	Geographic longitude of the address coordinate.
`postal_code`	Number	6-digit Indian postal code.
`address_type`	String	The type of address. Possible values are `HOUSE`, `OFFICE`, `OTHER`.
`address_line_one`	String	The first line of the address, typically house number and street name.
`address_line_two`	String	The second line of the address, for additional details. Can be an empty string if user left it empty.
`contact_full_name`	String	The full name of the contact person at the address.
`verified_mobile_num`	String	The OTP-verified mobile number associated with this address.

The Address object

Example object

Top-level fields

address fields

`address` fields