Webhooks
Create a webhook subscription
Register a new webhook subscription for property events.
Authorization
ApiKeyAuth x-api-key<token>
API key for authentication. Get your key from the Whitepages developer portal.
In: header
Request Body
application/json
url*string
HTTPS URL for webhook delivery
Match
^https://Length
1 <= length <= 2048name?Name|Name
Human-readable label (max 255 chars)
event_type*string
Event type to subscribe to (e.g., 'deed.transfer', 'deed.*')
region*string
Region in 'type:value' format
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.whitepages.com/v1/webhooks/" \ -H "Content-Type: application/json" \ -d '{ "url": "string", "event_type": "string", "region": "string" }'{
"result": {
"id": "string",
"url": "string",
"name": "string",
"event_type": "string",
"region": "string",
"status": "string",
"created_at": "string",
"updated_at": "string"
}
}{
"error": {
"code": 400,
"message": "Bad Request",
"long_message": "Invalid person ID format: 'sdf'. Person ID must start with 'P' followed by exactly 10 alphanumeric characters. Example: 'PABcd12345e' or 'P1234567890'.",
"meta": null
},
"wp_trace_id": "3b0b537a60d84057817bb40563ca5c99"
}{
"message": "Forbidden"
}{
"error": {
"code": 400,
"message": "Short error message",
"long_message": "The request was malformed",
"meta": {
"field": "email",
"validation_error": "Invalid email format"
}
},
"wp_trace_id": "550e8400-e29b-41d4-a716-446655440000"
}{
"error": {
"code": 400,
"message": "Short error message",
"long_message": "The request was malformed",
"meta": {
"field": "email",
"validation_error": "Invalid email format"
}
},
"wp_trace_id": "550e8400-e29b-41d4-a716-446655440000"
}{
"message": "Too Many Requests"
}{
"error": {
"code": 400,
"message": "Short error message",
"long_message": "The request was malformed",
"meta": {
"field": "email",
"validation_error": "Invalid email format"
}
},
"wp_trace_id": "550e8400-e29b-41d4-a716-446655440000"
}Gets person details by id GET
Retrieve detailed person information by Whitepages person ID. This endpoint accepts a valid Whitepages person ID in the path parameter and returns the complete person record if the ID exists in our data.
List webhook subscriptions GET
List webhook subscriptions with optional filtering.