API Reference

Api Reference

Response Field Description

FieldTypeDescription
statuscodeIntegerHTTP-like custom response code indicating success (200 = OK)
statusBooleanTrue if transaction was successful
messageStringWhen Document Fetched Successfully
reference_idString/NumberA unique identifier used to track the specific API request or transaction
pincodeStringThe 6-digit postal PIN code provided in the request or matched in the database
office_nameStringName of the local post office corresponding to the given PIN code (e.g., “Baroda House S.O”)
division_nameStringName of the postal division under which the post office operates
region_nameStringName of the larger postal region that covers the division (e.g., “Delhi”)
area_nameStringGeneral area or locality name corresponding to the PIN code
district_nameStringName of the district associated with the PIN code (e.g., “Central Delhi”)
state_nameStringName of the state where the post office is located (e.g., “Delhi”)
city_nameStringName of the city corresponding to the PIN code
Language
Click Try It! to start a request and see the response here!