API Documentation
Reverse Phone Append.
Start with a phone number, get back who it belongs to — the person or business name and their address. One number per GET, or thousands per POST.
- Endpoint
- https://rapid.peachtreedata.com/api/v1/reversephoneappend
- Methods
- GET for a single number · POST for a batch
- Formats
- JSON by default; append .xml for XML
Authentication
Every request carries your API key in the query string. The API is HTTPS-only, so the key is encrypted in transit. Query parameters can appear in any order, and responses are JSON by default — append .xml to the endpoint for XML.
https://rapid.peachtreedata.com/api/v1/reversephoneappend?apikey={apikey}&…Don't have a key? Sign up under plans & pricing below — keys work immediately.
Request
| Parameter | Required | Description |
|---|---|---|
| apikey | Yes | Your unique API key. |
| phonenumber | Yes | Phone number to look up. Example: 678-987-4600. |
| requestId | — | Any identifier you choose; echoed back so you can match responses to requests — important for batches, since response order isn't guaranteed. |
Phone numbers can be alphanumeric — the first ten digits in the string are used, so punctuation and extensions are fine. Strings with fewer than ten digits are considered invalid and aren't processed or billed.
Examples
curl "https://rapid.peachtreedata.com/api/v1/reversephoneappend?apikey={apikey}&phonenumber=(678)+987-4600"POST https://rapid.peachtreedata.com/api/v1/reversephoneappend?apikey={apikey}
Content-Type: application/json
[
{ "phoneNumber": "(678) 987-4600", "requestId": "00001" },
{ "...": "up to your plan's max numbers per request" }
]{
"firstName": "",
"middleName": "",
"lastName": "",
"businessName": "PEACHTREE DATA",
"address1": "2905 PREMIERE PKWY STE 200",
"address2": "",
"city": "DULUTH",
"state": "GA",
"zipCode": "30097-5275",
"phoneNumber": "6789874600",
"status": "Match",
"statusMessage": null,
"requestId": "0001"
}POST responses wrap the per-number results in a totals envelope (totalRequests, totalProcessed, totalInvalidRequests, totalError, responses).
Response reference
| Field | Type | Description |
|---|---|---|
| firstName | String(60) | First name of the person associated with the phone number. |
| middleName | String(60) | Middle name of the person associated with the phone number. |
| lastName | String(60) | Last name of the person associated with the phone number. |
| businessName | String(60) | Name of the business associated with the phone number. |
| address1 | String(60) | Primary address associated with the phone number. |
| address2 | String(60) | Secondary address associated with the phone number. |
| city | String(28) | City associated with the phone number. |
| state | String(2) | State abbreviation associated with the phone number. |
| zipCode | String(10) | Ten-digit ZIP Code (12345-1234) associated with the number. |
| phoneNumber | String(10) | The ten digits actually processed. |
| status | String(7) | Match — number found. NoMatch — number not found. Error — a processing error occurred. |
| statusMessage | String | When status is Error, the description. |
| requestId | String(50) | Echo of the requestId you sent, unchanged. |
HTTP response codes
| Code | Description |
|---|---|
| 200 | Processed successfully. |
| 400 | Bad request — the API key format is invalid, the key is missing, or the input wasn't properly passed. |
| 401 | Unauthorized — the API key is inactive or invalid. |
| 403 | Forbidden — the request exceeds the max items allowed per call, or the account isn't set up for this service. |
| 408 | Request timeout — processing exceeded the max processing time. |
| 500 | Internal server error during processing. |
Plans & pricing
Need higher volume or invoicing? Talk to us — we'll set up a plan that fits.
Matching phone numbers to people?
Tell us what you're building and we'll get you moving — usually the same day.