Verify v1 · Mailpoint
Before calling these endpoints, use a Geoscape Hub application with access to this API product. Authenticate with your Consumer Key in the Authorization header. See Authentication, Error Handling, Rate Limiting, and Attribution for shared integration guidance.
Validate
Authentication: Use your Consumer Key in the
Authorizationheader.
Match an Australian postal address and return its DPID and available postal attributes.
- No match returns
200,matchScore: 0, andproperties.dpid: "00000000". Do not accept the sentinel DPID - Geometry is omitted when no physical location is available
Requires paid-plan access. Each processed request costs 2 credits. See Interpreting Results for postal match levels and barcodes.
Code
Validate › Request Body
queryThe address string to search for.
Validate › Responses
Mailpoint matching completed. A no-match result uses the documented sentinel DPID.
attributionData attribution notice.
requestTimeStampUnix timestamp in seconds for the response.
requestDateTimeUTC date and time for the request.
typecrsCoordinate reference system of the returned geometry (GDA94).
pafVersionVersion of the Australia Post Postal Address File (PAF) used for matching.
pafExpiryExpiry date of the PAF release, in DD-MM-YYYY format.
matchScorePostal match score from 0 to 100. It is not a probability. Zero indicates no match.
matchTypePostal match level, when available: address, street, or locality. A broader match does not confirm a specific delivery address.