Address Verification API
Send a mobile number and the address your customer gave, and get the addresses on record with a match score, in one call.
The documentation opens in the VerifyAll dashboard after sign-in, for accounts with approved API access. New to the API? Start with the developer guide.
Overview
What the Address Verification API does
The Address Verification API takes a 10-digit Indian mobile number and answers with the addresses on record for it, each with its PIN code, state and how it is recorded for the number (for example a home or an office address), along with the name on record. An address recorded twice is listed once.
Send the address your customer gave you and the API finds the closest address on record and scores the two: match at 75 or more, partial from 50 to 74 and mismatch below 50. The closest address is returned with the score, so a reviewer can see exactly what was compared. Send a name as well and name_match compares it with the name on record: exact, partial or mismatch, with a score from 0 to 100.
Field visits are slow and costly, and address documents can be borrowed or edited. A check run from the mobile number the customer already gave you is a quick digital signal at onboarding: lenders confirm a current address before disbursal, insurers confirm a correspondence address, and any platform can decide which cases still need a visit.
How it works
- 1
Your server sends POST /universal/address-verification with the mobile number, the consent object and, for a comparison, the address and name you were given.
- 2
The request is checked first: a +91 or 0 prefix is removed, and a number that is not 10 digits starting with 6 to 9, an address under 10 characters or a missing consent object is refused with every problem listed, before anything is charged.
- 3
The number is checked against live records and the addresses come back in the same call, usually within a few seconds, with both matches worked out.
- 4
The result is stored in your VerifyAll account with a checkResultId; read it again, find it by your client_ref or download the PDF report for the customer’s file.
Request and response
Address verification API endpoints and fields
The main fields; the full reference with every field, error code and a cURL sample is in the dashboard docs.
| Endpoint | What it does |
|---|---|
| POST/universal/address-verification | Return the addresses on record for a mobile number and score an address |
Request fields
| Field | What it is |
|---|---|
| mobileRequired | The Indian mobile number whose addresses you want, 10 digits (a +91 or 0 prefix is removed). |
| consentRequired | obtained: true and a purpose of up to 200 characters, for the person the number belongs to. |
| addressOptional | The address you were given, 10 to 500 characters; sets address_match. |
| nameOptional | The name you were given; sets name_match. |
| client_refOptional | Your own reference, stored with the result (up to 100 characters). |
What the answer returns
| Field | What it is |
|---|---|
| mobile | The 10-digit mobile number checked. |
| name_on_record / name_match | The name on record for the number, and whether the name you sent matches: exact, partial, mismatch or not_checked, with a score from 0 to 100. |
| addresses[].address / pin_code / state | Each address on record, with its 6-digit PIN code and state (the state may be a two-letter code). |
| addresses[].type | How the address is recorded for the number, for example Office. |
| address_match | match, partial, mismatch or not_checked, with a score from 0 to 100. |
| address_match.closest | The address on record closest to the one you sent, with its PIN code; null when not checked. |
Base URL https://api.verifyall.ai. Authenticate with the X-API-Key header (a va_sandbox_ or va_live_ key). Every answer carries data, status_code, success, message and message_code; checks add outcome, checkResultId, charged and charged_amount.
Key features
Address Verification API features and capabilities
Every address on record
All the addresses held for the number come back, each with PIN code, state and type, not just the latest one.
Fixed match bands
address_match uses fixed bands (75 and above, 50 to 74, below 50), so a rule can accept, review or send for a visit without parsing addresses.
The address it compared with
closest shows which address on record your input was scored against, which makes a partial match quick to review by eye.
Name check in the same call
Send the customer’s name and see whether the number is held in that name, with exact, partial or mismatch and a score.
Use cases
Where businesses use the Address Verification API
Loan onboarding
Confirm the residential address an applicant typed before you disburse, without asking for another document.
Field-visit triage
Close strong matches digitally and send only partial matches and mismatches for a physical visit.
Insurance and broking KYC
Confirm the correspondence address a policyholder or investor gave at proposal or account opening.
Delivery and rental checks
Check the address a customer or partner gave for a high-value order, a rental or an at-home service booking.
Industries
Coverage
Indian mobile numbers, with the addresses on record for each number. A number with no address on record returns no record.
Limitations to plan for
- The addresses are those on record for the number. They can be older than where the person lives today, so treat a mismatch as a reason to ask, not as proof of fraud.
- The score compares the words of the two addresses, with the PIN code weighed in when both have one, so the same address written very differently can score lower. Review partial matches.
- A number with no record answers record_not_found. The lookup ran, so it is charged like any completed check.
- Checks about a person need the consent object, and you keep the consent record.
Integration
How to integrate the Address Verification API
From a business account to your first live call.
Step 1
Create a business account on VerifyAll and get it approved, as for running checks in the dashboard.
Step 2
Request Developer API access under Developers in the dashboard: the APIs you need, your expected monthly volume and your use case. The VerifyAll team reviews it and shares the API Services Agreement.
Step 3
Once the agreement is signed and access is approved, create your Sandbox key and build against sample data. Sandbox calls are never charged.
Step 4
Create your Production key, recharge your wallet and switch the key in your code: the endpoint and fields stay the same.
Get started
Request access to the Address Verification API
Tell us what you want to verify. We reply within one business day with access steps, Sandbox details and your API pricing.
View API documentation
The full reference for Address Verification API (endpoints, fields, errors, cURL) opens in the dashboard once your access is approved.
Open the docs (sign-in)Create a business account
API keys are issued to an approved business account. Sign up, then request access under Developers.
Create account
Pricing
Production calls are charged per check from your prepaid VerifyAll wallet, at your account’s API price; GST is added separately when you recharge. Sandbox calls are never charged. Your API prices are shown in the dashboard once access is approved. How pricing works
Already have a business account? Sign in to request access
Address Verification API: frequently asked questions
Answers for teams planning an integration.
Still have questions? Our team is happy to help.
Contact SupportRelated APIs
Mobile Number Verification API
LiveInstant answerFind out whether an Indian mobile number is live, who it is registered to and which operator serves it, before you rely on it.
View API detailsBank Account Verification API
LiveInstant answerSend an account number and IFSC and learn whether the account can receive money and whose name it is in, before any money moves.
View API detailsPAN Verification API
LiveInstant answerConfirm a PAN exists, see who holds it and match the name and date of birth your customer typed, in one call.
View API detailsBackground Verification API
LiveFinishes laterRun the background checks you choose on one person in a single request, and read back one report with an overall result and every check’s outcome.
View API details
All identity verification APIsRun Address verification in the dashboard, without codeBrowse the API Marketplace
Start with the Address Verification API
Request access, build against the Sandbox, then go live with your Production key.