Address API — how to use it

1. Getting an account and your key

Go to the dashboard and create an account with your email and a password. It is free and it takes a minute — no card, no sales call. You get 1,000 address checks a month straight away.

Your API key lives under Install & settings. You only need it if you are connecting your own website or shop; for checking addresses by hand you never touch it.

2. Checking one address

Check an address in the left menu. Type or paste the address, add the phone number if you have it, and press Check. You get back:

• A cleaned-up address — PIN code, city, district and state filled in and corrected.
• Whether the PIN matches the city — the single most common mistake in a delivery address.
• Whether the phone number looks real — the operator and circle it belongs to.
• What's missing — no house number, no landmark, only a PIN, and so on.

Each check counts as one against your monthly quota, whether you do it here or through the API.

3. Checking a whole spreadsheet

Bulk upload takes a CSV or Excel file and checks every row. Useful before a delivery run, or when you're cleaning an old customer list.

1. Put one address per row. A column called address is enough; phone, pincode, name and order_id are used if present.
2. Upload the file. Large files take a few minutes — you can leave the page.
3. Download the result: your original columns, plus the corrected address and the findings for each row.

Every row counts as one check. A 5,000-row file uses 5,000 checks, so look at your quota first.

4. RTO risk scoring (Pro)

On the Pro plan each order also gets a risk score — how likely that cash-on-delivery order is to come back undelivered. It uses the address quality, the PIN code's history, the phone, the order value and your own rules.

You see it two ways: RTO overview for the picture across all orders, and Orders for the list with each score. Risk rules is where you set what counts as risky for your business — order value thresholds, PIN codes you have been burned by, whether a missing landmark matters.

5. The review queue

Orders your rules flagged land in Review queue. For each one you can approve it, ask for prepayment, or cancel it. The point is that somebody looks before a risky parcel goes out, rather than after it comes back.

The number next to the menu item is how many are waiting. Clear it daily — a queue nobody looks at is worse than no queue.

6. Putting it on your website

Install & settings has ready-made options that need no developer:

• WooCommerce and Shopify — connect the shop and addresses are checked at checkout automatically.
• The checkout widget — one line of script on your checkout page. It fills the city and state from the PIN as the customer types and warns them if the address is incomplete.

Anything more involved — your own app, your own back office — is in the developer guide. You can also just send that link to whoever built your site.

7. Quotas, plans and invoices

Current prices are on the pricing page, which always shows what is live.

• Plans are prepaid and do not auto-renew. We email you 7 days and 1 day before one ends.
• Renew early and the days are added on, not lost.
• Switching plans converts the unused days of your current plan into days on the new one.
• If you run out of checks, the API says so and the checkout widget quietly lets orders through rather than blocking your customers.
• Yearly costs ten months' price. Prices exclude GST; add your GSTIN under Plan & billing to claim input credit.

8. When something looks wrong