Phone Append
Find a phone number from a person's name and address.
Credits: 3 per request
Request
http
POST /v1/phone-appendParameters
| Field | Type | Required | Description |
|---|---|---|---|
name | object | Yes | Person's name |
name.first | string | Yes | First name |
name.last | string | Yes | Last name |
address | object | Yes | Person's address |
address.street | string | Yes | Street address |
address.city | string | Yes | City |
address.state | string | Yes | State (2-letter code) |
address.zip | string | No | ZIP code (improves accuracy) |
Example
bash
curl -X POST https://api.braidisdata.com/v1/phone-append \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": { "first": "Jane", "last": "Doe" },
"address": {
"street": "123 Main St",
"city": "Austin",
"state": "TX",
"zip": "78701"
}
}'Response
json
{
"success": true,
"credits_used": 3,
"credits_remaining": 997,
"confidence": 0.91,
"data": {
"name": {
"first": "Jane",
"last": "Doe",
"full": "Jane Doe"
},
"phones": [
{
"number": "+15125551234",
"type": "mobile",
"carrier": "AT&T",
"primary": true
},
{
"number": "+15125559876",
"type": "landline",
"carrier": "AT&T",
"primary": false
}
]
}
}Response Fields
| Field | Type | Description |
|---|---|---|
phones | array | List of matched phone numbers |
phones[].number | string | Phone number in E.164 format |
phones[].type | string | mobile, landline, voip |
phones[].carrier | string | Carrier name |
phones[].primary | boolean | Whether this is likely the primary number |
INFO
Results typically include 1-3 phone numbers sorted by likelihood. The primary flag indicates the most likely current number.