Skip to main content
Version: 2025-04-10

PII

API docs by Redocly

PII

Download OpenAPI specification:Download

Lazarus IT: support@lazarusai.com URL: https://lazarus-ai.atlassian.net/servicedesk/customer/portal/8 License: Get Lazarus Terms of Service

Extract and redact personally identifiable information

Extract, JSON response

Make a request to extract PII data and receive JSON response data.

File upload options

We support requests with Content-Type application/json or multipart/form-data. Note that application/json requests are preferred as multipart/form-data requests do not support all flags and fields.

  • [application/json] inputURL link to file
  • [application/json] base64 base64 encoded file data
  • [multipart/form-data] file upload local file from browser
header Parameters
orgId
required
string (orgId) non-empty ^[a-zA-Z0-9\-_]+$

Organization ID

authKey
required
string (authKey) non-empty ^[a-zA-Z0-9\-_]+$

Authentication key

apiVersion
string (apiVersion) non-empty YYYY-MM-DD
Default: 2025-02-27

API Version

Request Body schema:
Any of
inputURL
required
string non-empty https?://(?:www\\.)?[a-zA-Z0-9./]+

File to upload: Must be a PDF, JPEG, PNG, or TXT. Note that TIFF files are currently unsupported for PII.

forceBase64
boolean
Default: false

Setting this parameter to true converts files to Base64 format before sending them on to the model.

pageQualityWeight
number <float> [ 0 .. 1 ]
Default: 0.5

Hyperparameter to weigh word confidences against confidence that a given word is PII.

redact
boolean
Default: false

Set to true to include the redacted file in the response as a base64-encoded PDF.

SFTP (object) or InputOutputSFTP (object)

SFTP authentication details. Required for SFTP URLs in inputURL or outputURL. Option to provide separate server authentication info for inputURL and outputURL.

staticIP
boolean
Default: false

Set to true for static IP for webhook and outputURL if they exist

Responses

Request samples

Content type
Example
{
  • "inputURL": "string",
  • "forceBase64": false,
  • "pageQualityWeight": 0.5,
  • "redact": false,
  • "sftp": {
    },
  • "staticIP": false
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "items": [
    ],
  • "redactedFile": {
    }
}

Redact, JSON response

Make a request to redact PII data from a document and receive JSON response data.

File upload options

We support requests with Content-Type application/json or multipart/form-data. Note that application/json requests are preferred as multipart/form-data requests do not support all flags and fields.

  • [application/json] inputURL link to file
  • [application/json] base64 base64 encoded file data
  • [multipart/form-data] file upload local file from browser
header Parameters
orgId
required
string (orgId) non-empty ^[a-zA-Z0-9\-_]+$

Organization ID

authKey
required
string (authKey) non-empty ^[a-zA-Z0-9\-_]+$

Authentication key

apiVersion
string (apiVersion) non-empty YYYY-MM-DD
Default: 2025-02-27

API Version

Request Body schema:
Any of
inputURL
required
string non-empty https?://(?:www\\.)?[a-zA-Z0-9./]+

URL for the file to extract data from: Must be a PDF, JPEG, PNG, TIFF, or TXT. Note that TIFF files are currently unsupported for PII.

forceBase64
boolean
Default: false

Setting this parameter to true converts files to Base64 format before sending them on to the model.

getPII
boolean

Set to true to run the PII model first and redact any identified regions.

pageQualityWeight
number <float> [ 0 .. 1 ]
Default: 0.5

Hyperparameter to weigh word confidences against confidence that a given word is PII.

keywords
Array of strings

Labels of fields to redact.

Array of objects (PageContent)

List of page content to redact regions to redact. Can directly insert results from /pii response field "items" or custom regions and dimensions.

SFTP (object) or InputOutputSFTP (object)

SFTP authentication details. Required for SFTP URLs in inputURL or outputURL. Option to provide separate server authentication info for inputURL and outputURL.

staticIP
boolean
Default: false

Set to true for static IP for webhook and outputURL if they exist

Responses

Request samples

Content type
Example
{
  • "inputURL": "string",
  • "forceBase64": false,
  • "getPII": true,
  • "pageQualityWeight": 0.5,
  • "keywords": [
    ],
  • "pages": [
    ],
  • "sftp": {
    },
  • "staticIP": false
}

Response samples

Content type
application/json
{
  • "status": "SUCCESS",
  • "redactedFile": {
    }
}