Property Detail API
/property_detail
Provides the resident and contact details (phone and email) linked to an address referenced by a GNAF ID. Automatically performs a connectivity and DNC check.
Example Request
GETGET /property_detail?gnaf_id=GANSW716615055&timeout=20
Available Response Data
- check_circle Check Completion Status Boolean
- check_circle Property Address Details
- check_circle Number of Records Available
- check_circle Array of Resident Records (Names, Demographics)
- check_circle Live Phone Connectivity Results per resident
- check_circle DNC (Do Not Call) Register Status per phone number
Request Schema
| Field Name | Type | Required | Description |
|---|---|---|---|
| gnaf_id | string | Yes | The address GNAF ID. |
| timeout | string | No | Maximum seconds to wait for checks to complete. |
Technical Use Cases
Telemarketing Compliance
Pull resident details for a target location while simultaneously verifying their Do Not Call (DNC) status to ensure strict compliance.
Asset & Debt Recovery
Identify current occupants and verifiable contact numbers for a specific property.
Webhooks & Events
property-check-completed
Because live connectivity checks take time, this webhook fires when the polling requirement ends and the completion status switches to true.
Compliance & Security
Common Questions
Everything you need to know about implementation details and compliance infrastructure.
help_center General
Why does the timeout parameter exist?
add
Why does the timeout parameter exist?
Live carrier connectivity checks can take several seconds. The timeout allows your UI to return partial data immediately while the backend finishes pinging the phone networks.