Directories API

Look up a postal code

Resolve a US ZIP code into a city and state.

GEThttps://app.mindbill.org/partner/v2/postal-codes

Fill city and state after a user enters a ZIP code. lookupPostalCode() calls this endpoint.

AuthenticationServer API key or browser session + Origin

Permissions by credentialServer: payers:read · Browser: payers:read

IdempotencyNot required

Use this URL with a server API key or a browser session and its exact allowed Origin. Both credentials use the same request and response contract. See the component API inventory for exact paths and SDK methods.

Query parameters

FieldTypeDescription

postalCodeRequired

string

US ZIP code. The input is trimmed and the first five characters are used, including for ZIP+4 input.

Examples

curl 'https://app.mindbill.org/partner/v2/postal-codes?postalCode=94105' \
  --header "Authorization: Bearer $MINDBILL_API_KEY"

curl 'https://app.mindbill.org/partner/v2/postal-codes?postalCode=94105' \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example'

Response

200 OK

{
  "postalCode": "94105",
  "city": "San Francisco",
  "state": "CA"
}

FieldTypeDescription

postalCode

string

Normalized five-digit ZIP code. No data wrapper.

city

string

City name.

state

string

Two-letter state code.