API References

Scan Text

Scan text for sensitive data. Runs the configured detection entities over the request text and returns every match as a character range with its entity type and confidence score. Detections below the confidence threshold are omitted.

POST
/scan

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for the scan endpoint: the text to inspect and which entity types to detect.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/scan" \  -H "Content-Type: application/json" \  -d '{    "text": "string"  }'
{  "results": [    {      "start": 0,      "end": 0,      "score": 0,      "entity_type": "string"    }  ],  "usage": {    "input_tokens": 0,    "inference_ms": 0  }}
{  "error": {    "code": "invalid_json",    "message": "string",    "details": [      {        "path": [          "string"        ],        "code": "missing",        "message": "string",        "limit": 0,        "min": 0,        "max": 0,        "expected": "string",        "allowed": [          "string"        ],        "tokens": 0      }    ]  }}
{  "error": "string",  "signup": true}
{  "error": "string",  "signup": true}
{  "error": "string",  "signup": true}
{  "error": {    "code": "invalid_json",    "message": "string",    "details": [      {        "path": [          "string"        ],        "code": "missing",        "message": "string",        "limit": 0,        "min": 0,        "max": 0,        "expected": "string",        "allowed": [          "string"        ],        "tokens": 0      }    ]  }}
{  "error": {    "code": "invalid_json",    "message": "string",    "details": [      {        "path": [          "string"        ],        "code": "missing",        "message": "string",        "limit": 0,        "min": 0,        "max": 0,        "expected": "string",        "allowed": [          "string"        ],        "tokens": 0      }    ]  }}
Empty
© 2026 Quba, Ltd.