v1

latestOpenAPI 3.1.02026-07-26320320.3 KB

Bulk SkipTrace API (v2)

Skiptrace up to 1,000 people in one API call

post/v2/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"
  },
  "match": true,
  "cached": true,
  "statusCode": 200,
  "statusMessage": "Success",
  "live": true,
  "requestExecutionTimeMS": "186ms"
}