v1

latestOpenAPI 3.1.02026-07-26320320.3 KB

Bulk SkipTrace API

Skiptrace up to 1,000 people in one API call

post/v1/SkipTraceBatch

Headers

x-user-idstring

Denote a unique user identifier to this api call by passing it in this header field

Request body

webcomplete_urlstring required

must be a valid https POST endpoint. The webhook_url should return a https status of 200. The response body can be empty.

Response

200

batchIdstring

batchRequestIdstring

requestIdstring

responseCodeinteger

requestDatestring

responseMessagestring

warningsstring

matchboolean

cachedboolean

statusCodeinteger

statusMessagestring

creditsinteger

liveboolean

requestExecutionTimeMSstring

Example response

{
  "batchId": "2067cf32-159f-4364-af53-64aaea795158",
  "batchRequestId": "7563461e-5195-4741-8751-1cc4d966dd83",
  "requestId": "ca3487cd-ad21-4abd-8a76-e8f68b581f1e",
  "requestDate": "2022-04-27T13:23:43.953Z",
  "responseMessage": "Successful",
  "warnings": "None",
  "input": {
    "key": 1,
    "first_name": "Justin",
    "last_name": "Winthers",
    "address": "1428 Fishers Mill Ct",
    "city": "Herndon",
    "state": "VA",
    "zip": "20170",
    "mail_address": "1428 Fishers Mill Ct",
    "mail_city": "Herndon",
    "mail_state": "VA",
    "mail_zip": "20170"
  },
  "output": {
    "identity": {
      "names": [
        {
          "prefix": "Mr",
          "firstName": "Justin",
          "lastName": "Winthers",
          "middleName": "E",
          "fullName": "Justin E Winthers"
        }
      ],
      "address": {
        "house": "1428",
        "street": "Fishers Mill Court",
        "city": "Herndon",
        "state": "VA",
        "zip": "20170",
        "formattedAdddress": "1428 Fishers Mill Court, Herndon, Virginia"
      },
      "addressHistory": [
        {
          "house": "1428",
          "street": "Fishers Mill Court",
          "city": "Herndon",
          "state": "VA",
          "zip": "20170",
          "formattedAdddress": "1428 Fishers Mill Court, Herndon, Virginia"
        }
      ],
      "phones": [
        {
          "phone": "2022559348",
          "phoneDisplay": "202-255-9348",
          "isConnected": true,
          "doNotCall": true,
          "phoneType": "mobile",
          "validSince": "2007-09-16"
        }
      ],
      "emails": [
        {
          "email": "jwinthers@gmail.com",
          "emailType": "personal"
        }
      ]
    },
    "demographics": {
      "dob": "1973-03-01 - 1973-03-31",
      "gender": "male",
      "age": "49 years old",
      "images": [
        {
          "url": "https://s-media-cache-ak0.pinimg.com/avatars/justinwinthers_1402025249_140.jpg"
        }
      ],
      "social": [
        {
          "name": "MySpace",
          "category": "personal_profiles",
          "domain": "myspace.com",
          "url": "https://myspace.com/justinwinthers"
        }
      ],
      "jobs": [
        {
          "title": "Information Technology and Services",
          "industry": "Information Technology and Services",
          "display": "Information Technology and Services"
        }
      ],
      "names": [
        {
          "prefix": "Mr",
          "firstName": "Justin",
          "lastName": "Winthers",
          "middleName": "E",
          "fullName": "Justin E Winthers",
          "lastSeen": "2021-04-10",
          "validSince": "2000-06-19"
        }
      ]
    },
    "relationships": [
      {
        "type": "other",
        "name": {
          "firstName": "Gabriel",
          "lastName": "Benn",
          "middleName": "Asheru",
          "fullName": "Gabriel Asheru Benn"
        }
      }
    ],
    "stats": {
      "searchResults": 1,
      "names": 3,
      "addresses": 17,
      "phoneNumbers": 7,
      "emailAddresses": 13,
      "associates": 15,
      "jobs": 3,
      "socialProfiles": 9,
      "images": 2
    }
  },
  "match": true,
  "cached": true,
  "statusCode": 200,
  "statusMessage": "Success",
  "live": true,
  "requestExecutionTimeMS": "186ms"
}