v1

latestOpenAPI 3.1.02026-07-241695611.0 MB
Person Search

Get Person Searches

get/person_searches

Query parameters

qstring nullable

The query param, can either be a search name or a search id. If it is a search id, it will be used to search by id. If it is a search name, it will be used to search by name. If it is not provided, it will be ignored.

The query param, can either be a search name or a search id. If it is a search id, it will be used to search by id. If it is a search name, it will be used to search by name. If it is not provided, it will be ignored.

limitinteger

Maximum number of records to return in a single page. Must be between 1 and 1000.

Maximum number of records to return in a single page. Must be between 1 and 1000.

offsetinteger nullable

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

Number of records to skip from the beginning. Use 0 for the first page. Cannot be used with cursor.

cursorstring nullable

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

Opaque pagination cursor token that identifies the position in the result set. Use the cursor from the previous response to get the next page. Cannot be used with offset.

start_datestring date nullable

Filter records created on or after this date (format: YYYY-MM-DD).

Filter records created on or after this date (format: YYYY-MM-DD).

end_datestring date nullable

Filter records created on or before this date (format: YYYY-MM-DD).

Filter records created on or before this date (format: YYYY-MM-DD).

tzstring

IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

Example:UTC

IANA timezone identifier used to interpret start_date and end_date (defaults to UTC).

Response

List of person searches.

idstring uuid required

The unique identifier of the search.

state'PENDING' | 'EXECUTING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' required
created_atstring date-time required

The datetime the search was created.

updated_atstring date-time nullable

The datetime the search was updated at (generally when the search completed).

reference_idstring nullable

The reference ID associated with the search.

tin_matchedboolean nullable

Whether the SSN for this person search matches with the name provided

errorstring nullable

Any errors that occurred.

warningsstring[]

Any warnings that occurred.

Example response

[
  {
    "created_at": "2026-07-16T19:24:27.815920",
    "updated_at": "2026-07-16T19:24:27.815934",
    "reference_id": "Search1234",
    "person": {
      "id": "8e3b7f77-2799-4931-a322-9f80cc67eebe",
      "first_name": "John",
      "last_name": "Doe",
      "ssn": "XXXXX1234",
      "middle_name": "Michael",
      "phone_number": "+17075489914",
      "email": "johndoe@example.com",
      "date_of_birth": "1990-01-15",
      "suffix": "Jr.",
      "title": "Mr.",
      "created_at": "2025-01-15T12:00:00Z",
      "updated_at": "2025-01-15T12:00:00Z",
      "dockets": [
        {
          "docket_number": "A19284",
          "court": "Supreme Court of Orange County",
          "division": "Civil Court Division",
          "judges": [
            "Honorable Paul Shaw"
          ],
          "title": "Doe v. City of New York",
          "case_type": "Civil",
          "status": "Pending",
          "parties": [
            {
              "party_type": "Complaintant",
              "counsel": [
                "Robin Keller"
              ]
            }
          ],
          "updates": [
            {
              "title": "Update 2",
              "contents": "New details about the case.",
              "date": "2024-06-01",
              "exhibits": [
                {
                  "title": "Exhibit 1A"
                }
              ]
            }
          ]
        }
      ],
      "liens": [
        {
          "filing_number": "P98172",
          "filing_type": "Lien for Loan Default",
          "filing_date": "2023-09-18",
          "lapse_date": "2023-04-15",
          "status": "Under Appeal",
          "number_of_pages": 14,
          "document_filename": "docket_47182.pdf",
          "parties": [
            {
              "name": "Louis Schneider",
              "address": {
                "street": "913 Hendrix Gardens Suite 492",
                "city": "Jasonfurt",
                "zip": "19773",
                "latitude": 38.03012,
                "longitude": 78.47665
              },
              "type": "individual"
            }
          ],
          "amendments": [
            {
              "filing_number": "H76162",
              "filing_type": "Notarized Letter",
              "filing_date": "2023-11-27",
              "number_of_pages": 4
            }
          ],
          "collateral_statements": [
            {
              "text": "2022 Blue Honda Civic"
            }
          ]
        }
      ],
      "watchlist_hits": [
        {
          "code": "DMF",
          "count": 1,
          "details": [
            {
              "address": "123 Main St",
              "date_of_birth": "1980-01-01",
              "name": "John Doe"
            }
          ]
        }
      ]
    },
    "tin_matched": true,
    "error": "RuntimeError The Search could not be completed."
  }
]