---
title: National Criminal Screening V1
slug: us-apis/national-criminal-screening-v1
description: Signzy's National Criminal Screening service offers real-time criminal data from government sources. This document provides API details for accessing the service, along with a sample response in JSON format. It also explains parameters and descriptions fo
createdAt: 2023-01-19T05:23:14.000Z
---

## Introduction

National Criminal Screening of Signzy delivers unrivaled coverage, accuracy and compliance of criminal data collected daily from thousands of sources at the federal, state, county, and local levels.

Sources include Criminal Prosecutions, Arrest Records, Warrant Lists, Criminal Newsletters & Press Releases, Most Wanted, Sex Offenders, Corrections/Inmate Data, Child Support Violations, Open Court Cases, Early Release & Parole Lists, Career Offenders, and more.

Data is updated in real-time to provide an accurate report of all court records in a certain region or jurisdiction, not just convictions. Our Criminal data is 100% from applicable government sources.  Access is subject to each individual source’s infrastructure and their update schedules (scraped or direct integrations), which we follow accordingly to ensure the most up to date data is available.

**Note:&#x20;**&#x54;his API works best with minimum input parameters. The search query should be kept light to fetch the maximum possible matches, and then the returned records should be filtered based on additional attributes. Passing too many filters in the initial search can result in no matches being returned even for valid records.

## API Details

### Sample cURL

::::Tabs
:::Tab{title="Production"}
```curl
curl --location 'https://api.signzy.us/api/v3/us/national-criminal-search' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data '{
 "businessName": "",
 "Ssn":"",
 "lastName": "Dalmer",
 "firstName": "Jeffrey",
 "middleName": "",
 "suffix": "",
 "addressLine1": "",
 "addressLine2": "",
 "dob": "",
 "dobTo": "",
 "offenseCity": "",
 "offenseCounty": "",
 "offenseState": "",  
 "personCity": "",  
 "personState": "",  
 "categoryTypes": ""
}'
```
:::

:::Tab{title="Pre-Production"}
```curl
curl --location 'https://api-preproduction.signzy.us/api/v3/us/national-criminal-search' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data '{
 "businessName": "",
 "Ssn":"",
 "lastName": "Dalmer",
 "firstName": "Jeffrey",
 "middleName": "",
 "suffix": "",
 "addressLine1": "",
 "addressLine2": "",
 "dob": "",
 "dobTo": "",
 "offenseCity": "",
 "offenseCounty": "",
 "offenseState": "",  
 "personCity": "",  
 "personState": "",  
 "categoryTypes": ""
}'
```
:::
::::

### Request Body Parameters



| Parameter     | Data Type           | Required     | Description                                                                |
| ------------- | ------------------- | ------------ | -------------------------------------------------------------------------- |
| firstName     | string              | Conditional¹ | Max 64 characters; letters, spaces, -, ', ., accents; at least one letter. |
| lastName      | string              | Conditional¹ | Same validation as firstName.                                              |
| middleName    | string              | No           | Same validation as firstName.                                              |
| suffix        | string              | No           | Maximum 4 characters.                                                      |
| businessName  | string              | Conditional¹ | Maximum 200 characters.                                                    |
| ssn           | string              | No           | 9-digit SSN (dashes stripped); rejects all-zero groups, 666, and 900–999.  |
| dob           | string (YYYY-MM-DD) | No           | Valid date, year ≥1900, not future, subject must be ≥18 years old.         |
| dobTo         | string (YYYY-MM-DD) | No           | Year ≥1900, not future, must be later than dob.                            |
| addressLine1  | string              | No           | Maximum 500 characters.                                                    |
| addressLine2  | string              | No           | Maximum 500 characters.                                                    |
| offenseCity   | string              | No           | Maximum 60 characters.                                                     |
| offenseCounty | string              | No           | Maximum 60 characters.                                                     |
| offenseState  | string              | No           | Two-letter US state code.                                                  |
| personCity    | string              | No           | Maximum 60 characters.                                                     |
| personState   | string              | No           | Two-letter US state code.                                                  |

:::hint{type="info"}
<u>**\*Using Date of Birth Filter :-**</u>

- If you include any date of birth (DOB) information in the search request, **it must include a Birth Year**.
- A request with only Birth Month and Day (without a Year) will result in the error.&#x20;
- Only Acceptable Inputs are :- Either Pass only Birth Year or Birth Year + Birth Month + Birth Day. Any other Combination of inputs will result in error.
- If no DOB is provided at all (i.e., all DOB fields are removed from the request), the search will still run successfully.
:::

### Sample Response

:::CodeblockTabs
200

```none
{
  "result": {
    "crimRecords": [
      {
        "recordId": "",
        "categoryCode": "",
        "names": [
          {
            "givenName": "",
            "middleName": "",
            "familyName": "",
            "nameSuffix": "",
            "ssnNum": "",
            "matchConfidenceScore": "",
            "sourceReference": "",
            "completeName": ""
          }
        ],
        "attributes": [
          {
            "dateOfBirth": "",
            "estimatedAge": "",
            "birthState": "",
            "hairColor": "",
            "eyeColor": "",
            "heightValue": "",
            "weightValue": "",
            "ethnicity": "",
            "gender": "",
            "complexion": "",
            "militaryBackground": "",
            "scarsMarks": "",
            "sourceReference": ""
          }
        ],
        "profilePhotos": [
          {
            "sourceReference": "",
            "originState": ""
          }
        ],
        "knownAddresses": [
          {
            "attentionName": "",
            "houseNo": "",
            "direction": "",
            "streetNameFull": "",
            "streetTypeCode": "",
            "postDirection": "",
            "unitCode": "",
            "unitNo": "",
            "cityName": "",
            "stateCode": "",
            "zipCode": "",
            "zip4": "",
            "countyName": "",
            "geoLongitude": "",
            "geoLatitude": "",
            "verificationCodesRaw": "",
            "fullAddress": ""
          }
        ],
        "caseRecords": [
          {
            "caseNo": "",
            "caseTypeCode": "",
            "categoryRaw": "",
            "categoryMapped": "",
            "ncicCodeStandard": "",
            "dataSource": "",
            "courtTypeCode": "",
            "courtName": "",
            "courtCountyName": "",
            "totalFees": "",
            "totalFines": "",
            "caseFiledDate": ""
          }
        ],
        "offenseHistory": [
          {
            "offenseCodeList": [""],
            "offenseDesc": [""],
            "offenseOccurredDate": "",
            "chargeFiledDate": "",
            "originCounty": "",
            "originState": "",
            "convictedDate": "",
            "convictionLocation": "",
            "caseDisposition": "",
            "caseDispositionDate": "",
            "isSentenced": "",
            "probationStartDate": "",
            "sourceMapping": "",
            "classificationCodeDesc": "",
            "classificationSubCodeDesc": ""
          }
        ],
        "additionalDetails": [
          {
            "arrestdate": "",
            "arrestingAgency": ""
          }
        ],
        "media": [
          {
            "imageBase64Data": "",
            "fileType": "",
            "thumbnailUrl": "",
            "imageWidth": "",
            "imageHeight": "",
            "thumbnailWidth": "",
            "thumbnailHeight": ""
          }
        ]
      }
    ],
    "crimRecordCount": 0
  },
  "reason": "",
  "code": ""
}
```
:::

### Response Body Parameters



| Parameter         | Data Type | Required | Description                                                                                                                                                                                                                                                                                                                            |
| ----------------- | --------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| recordId          | string    | Yes      | Vendor Poseidon record ID.                                                                                                                                                                                                                                                                                                             |
| categoryCode      | string    | Yes      | Record category code.                                                                                                                                                                                                                                                                                                                  |
| names             | array     | Yes      | Name variants (givenName, middleName, familyName, nameSuffix, ssnNum, matchConfidenceScore, sourceReference, completeName).                                                                                                                                                                                                            |
| attributes        | array     | Yes      | Offender attributes (dateOfBirth, estimatedAge, birthState, hairColor, eyeColor, heightValue, weightValue, ethnicity, gender, complexion, militaryBackground, scarsMarks, sourceReference).                                                                                                                                            |
| profilePhotos     | array     | Yes      | Profile photo references (sourceReference, originState).                                                                                                                                                                                                                                                                               |
| knownAddresses    | array     | Yes      | Known addresses (attentionName, houseNo, direction, streetNameFull, streetTypeCode, postDirection, unitCode, unitNo, cityName, stateCode, zipCode, zip4, countyName, geoLongitude, geoLatitude, verificationCodesRaw, fullAddress).                                                                                                    |
| caseRecords       | array     | Yes      | Case details (caseNo, caseTypeCode, categoryRaw, categoryMapped, ncicCodeStandard, dataSource, courtTypeCode, courtName, courtCountyName, totalFees, totalFines, caseFiledDate).                                                                                                                                                       |
| offenseHistory    | array     | Yes      | Offense history (offenseCodeList\[], offenseDesc\[], offenseOccurredDate, chargeFiledDate, originCounty, originState, convictedDate, convictionLocation, caseDisposition, caseDispositionDate, isSentenced, probationStartDate, sourceMapping, classificationCodeDesc, classificationSubCodeDesc). All dates are in YYYY-MM-DD format. |
| additionalDetails | array     | Yes      | Raw vendor passthrough data with date fields normalized.                                                                                                                                                                                                                                                                               |
| media             | array     | Yes      | Images (imageBase64Data, fileType, thumbnailUrl, imageWidth, imageHeight, thumbnailWidth, thumbnailHeight). Image download URL is removed.                                                                                                                                                                                             |

### Sample Error

:::CodeblockTabs
400

```none
{
    "result": {},
    "reason": "Bad Request: Either firstName and lastName or businessName is required",
    "code": "E001"
}
```
:::

### error Response Parameter



| HTTP Status Code | Error Code | Description           |
| ---------------- | ---------- | --------------------- |
| 400              | E001       | Bad Request           |
| 401              | E101       | Unauthorized Access   |
| 403              | E201       | Forbidden             |
| 404              | E301       | Data Not Found        |
| 409              | E401       | Upstream error        |
| 429              | E501       | Rate Limit Exceeded   |
| 500              | E601       | Internal Server Error |
| 503              | E701       | Service Unavailable   |
| 504              | E801       | Timeout               |

:::hint{type="info"}
### Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [help@signzy.com](#). We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!
:::

