Address Presence Check API
Overview
The Address Presence Check API allows you to retrieve historical addresses associated with a mobile phone number in India. The API aggregates address information from multiple data sources and returns all available addresses linked to the provided phone number, along with the source category and the date when the address was recorded.
This API is useful for determining whether address information is available for a phone number and for obtaining a consolidated view of addresses from different sources such as e-commerce platforms, utility bills, and other verified datasets.
Use Cases
- Retrieve historical addresses associated with a mobile number.
- Verify whether address data exists for a customer.
- Access addresses collected from multiple sources such as e-commerce, utility bills, and other data repositories.
- Enhance customer verification, onboarding, fraud detection, and risk assessment workflows.
Endpoint
POST /api/v3/address/presence-check
Headers
Header | Required | Description |
|---|---|---|
Authorization | Yes | API authorization token |
Content-Type | Yes | application/json |
Request Body
Field | Type | Required | Description |
|---|---|---|---|
phoneNumber | String | Yes | 10-digit Indian mobile number whose associated addresses need to be retrieved. |
Sample Request
Response
Field | Type | Description |
|---|---|---|
result | Object | API result object |
result.phoneNumber | String | Phone number provided in the request |
result.hasAddress | Boolean | Indicates whether address data exists for the phone number |
result.allAddresses | Array | List of all available addresses associated with the phone number |
result.allAddresses[].fullAddress | String | Complete address retrieved from the source |
result.allAddresses[].asOfDate | String (YYYY-MM-DD) | Date on which the address was recorded |
result.allAddresses[].category | String | Source category of the address (e.g. ECOM, UTILITY BILL, OTHER WEB) |
reason | String | API response message |
code | String | API response code |
Sample Response
{
"result": {
"phoneNumber": "9304XXXX89",
"hasAddress": true,
"allAddresses": [
{
"fullAddress": "XXXXXXXX XXXXXXX, XXXXXXXXX XXXXXXXXXXX, XXXXXXXXX XXXXX, XXXXXXXXXX, XXXXXXXXX, Karnataka",
"asOfDate": "2025-01-10",
"category": "ECOM"
},
{
"fullAddress": "W/O XXXXX XXXXX, X.X. XXX, XXXXXXXXX XXXXXXX, XXXXX XXXX, XXXXX XX. XXXXXXX, XXXXXXXXX, XXXXXX, Bihar, 800XXX",
"asOfDate": "2018-02-01",
"category": "OTHER WEB"
},
{
"fullAddress": "X.X. XXX, XXXXXXXXX XXXXXXX, XXXXX XXXX, XXXXXXXXX, XXXXX XX. XXXXXXX, XXXXXX, Bihar, 800XXX",
"asOfDate": "2018-01-07",
"category": "UTILITY BILL"
}
]
},
"reason": "Request Successful",
"code": "S001"
}Response Codes
Code | Description |
|---|---|
S001 | Request Successful |
Notes
- This API is supported only for Indian mobile numbers.
- Multiple addresses may be returned for a single phone number.
- Addresses are returned along with their source category and the date on which they were recorded.
- If no address is available, hasAddress will be false and allAddresses will be an empty array.