Scan Plain Text

Scan Plain Text

post

Provide a list of arbitrary string data, and scan each item with the provided detectors to uncover sensitive information. Returns a list equal in size to the number of provided string payloads. The item at each list index will be a list of all matches for the provided detectors, or an empty list if no occurrences are found.

Authorizations

Body

The request body of the /v3/scan endpoint

policyUUIDsstring[]optional

A list of UUIDs referring to policies to use to scan the request payload. Policies can be built in the Nightfall Dashboard. Maximum 1.

policyobjectoptional

Policy can contain a list of pre-configured detection rule UUID's and/or a list of inline detection rules with which to scan the request payload. At least one list must be non-empty.

payloadstring[]optional

The text sample(s) you wish to scan. This data is passed as a string list, so you may choose to segment your text into multiple items for better granularity. The aggregate size of your text (summed across all items in the list) must not exceed 500 KB for any individual request, and the number of items in that list may not exceed 50,000.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.nightfall.ai/v3/scan' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "policyUUIDs": [
      "text"
    ],
    "policy": {
      "detectionRuleUUIDs": [
        "text"
      ],
      "detectionRules": [
        {
          "name": "text",
          "logicalOp": "ANY",
          "detectors": [
            {
              "minNumFindings": 1,
              "minConfidence": "VERY_UNLIKELY",
              "detectorUUID": "text",
              "displayName": "text",
              "detectorType": "NIGHTFALL_DETECTOR",
              "nightfallDetector": "AMERICAN_BANKERS_CUSIP_ID",
              "regex": {
                "pattern": "text",
                "isCaseSensitive": true
              },
              "wordList": {
                "values": [
                  "text"
                ],
                "isCaseSensitive": true
              },
              "contextRules": [
                {
                  "regex": {
                    "pattern": "text",
                    "isCaseSensitive": true
                  },
                  "proximity": {
                    "windowBefore": 1,
                    "windowAfter": 1
                  },
                  "confidenceAdjustment": {
                    "fixedConfidence": "VERY_UNLIKELY"
                  }
                }
              ],
              "exclusionRules": [
                {
                  "matchType": "PARTIAL",
                  "exclusionType": "REGEX",
                  "regex": {
                    "pattern": "text",
                    "isCaseSensitive": true
                  },
                  "wordList": {
                    "values": [
                      "text"
                    ],
                    "isCaseSensitive": true
                  }
                }
              ],
              "redactionConfig": {
                "maskConfig": {
                  "maskingChar": "text",
                  "charsToIgnore": [
                    "text"
                  ],
                  "numCharsToLeaveUnmasked": 1,
                  "maskLeftToRight": true
                },
                "infoTypeSubstitutionConfig": {},
                "substitutionConfig": {
                  "substitutionPhrase": "text"
                },
                "cryptoConfig": {
                  "publicKey": "text"
                },
                "removeFinding": true
              },
              "scope": "Content"
            }
          ]
        }
      ],
      "contextBytes": 1,
      "defaultRedactionConfig": {
        "maskConfig": {
          "maskingChar": "text",
          "charsToIgnore": [
            "text"
          ],
          "numCharsToLeaveUnmasked": 1,
          "maskLeftToRight": true
        },
        "infoTypeSubstitutionConfig": {},
        "substitutionConfig": {
          "substitutionPhrase": "text"
        },
        "cryptoConfig": {
          "publicKey": "text"
        },
        "removeFinding": true
      },
      "alertConfig": {
        "slack": {
          "target": "text"
        },
        "email": {
          "address": "text"
        },
        "url": {
          "address": "text"
        },
        "siem": {
          "address": "text",
          "sensitiveHeaders": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "plainTextHeaders": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      }
    },
    "payload": [
      "text"
    ]
  }'

200

400

401

422

429

500

200

{
  "findings": [
    [
      {
        "finding": "text",
        "redactedFinding": "text",
        "beforeContext": "text",
        "afterContext": "text",
        "detector": {
          "name": "text",
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "subdetector": {
            "name": "text",
            "uuid": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "confidence": "VERY_UNLIKELY",
        "location": {
          "byteRange": {
            "start": 1,
            "end": 1
          },
          "codepointRange": {
            "start": 1,
            "end": 1
          }
        },
        "redactedLocation": {
          "byteRange": {
            "start": 1,
            "end": 1
          },
          "codepointRange": {
            "start": 1,
            "end": 1
          }
        }
      }
    ]
  ],
  "redactedPayload": [
    "text"
  ]
}

Success