Skip to main content
POST
/
v1
/
privacy
/
config
Create privacy config for organization
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/privacy/config \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "pii_scrubbing_enabled": true,
  "scrub_types": [
    "ssn",
    "credit_card",
    "iban",
    "us_bank_number"
  ],
  "custom_deny_patterns": [
    {
      "name": "<string>",
      "regex": "<string>",
      "replacement_label": "<string>",
      "description": "<string>",
      "score": 0.85
    }
  ],
  "custom_allow_patterns": [
    {
      "name": "<string>",
      "regex": "<string>",
      "description": "<string>"
    }
  ],
  "score_threshold": 0.7,
  "audio_scrubbing_enabled": true,
  "audio_retention_policy": "redacted_audio_retained",
  "audio_redaction_fill": "tone_1khz",
  "supported_languages": [
    "en"
  ],
  "default_language": "en",
  "language_detection_enabled": false
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pii_scrubbing_enabled": true,
  "scrub_types": [
    "<string>"
  ],
  "custom_deny_patterns": [
    {
      "name": "<string>",
      "regex": "<string>",
      "replacement_label": "<string>",
      "description": "<string>",
      "score": 0.85
    }
  ],
  "custom_allow_patterns": [
    {
      "name": "<string>",
      "regex": "<string>",
      "description": "<string>"
    }
  ],
  "score_threshold": 123,
  "audio_scrubbing_enabled": true,
  "audio_retention_policy": "<string>",
  "audio_redaction_fill": "<string>",
  "supported_languages": [
    "<string>"
  ],
  "default_language": "<string>",
  "language_detection_enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Body

application/json
pii_scrubbing_enabled
boolean
default:true
scrub_types
string[]

PIIType enum values to scrub

custom_deny_patterns
CustomDenyPattern · object[]
Maximum array length: 128
custom_allow_patterns
CustomAllowPattern · object[]
Maximum array length: 128
score_threshold
number
default:0.7

Presidio confidence threshold

Required range: 0 <= x <= 1
audio_scrubbing_enabled
boolean
default:true
audio_retention_policy
enum<string>
default:redacted_audio_retained
Available options:
transcript_only,
redacted_audio_retained,
raw
audio_redaction_fill
enum<string>
default:tone_1khz
Available options:
silence,
tone_1khz
supported_languages
string[]

ISO-639-1 codes the org wants to scrub (subset of {en,es,fr,de,pt})

default_language
string
default:en

Fallback language when detection is off or fails

language_detection_enabled
boolean
default:false

Detect language per scrub call; when false default_language is always used

Response

Successful Response

id
string<uuid>
required
organization_id
string<uuid>
required
pii_scrubbing_enabled
boolean
required
scrub_types
string[]
required
custom_deny_patterns
CustomDenyPattern · object[]
required
custom_allow_patterns
CustomAllowPattern · object[]
required
score_threshold
number
required
audio_scrubbing_enabled
boolean
required
audio_retention_policy
string
required
audio_redaction_fill
string
required
supported_languages
string[]
required
default_language
string
required
language_detection_enabled
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required