Create PII Redaction

Creates a redacted version of the parsed resume. Specify which fields and targets to redact; the response returns a redactionId, the list of redacted fields, and the redacted resume.

Sample Request & Response

POST

/v1/resumes/{id}/redactions

Sample Request

Headers:

{
  "Authorization": "Bearer <YOUR_API_KEY>"
}

Body:

{
  "fields": [
    "personalInfo.name",
    "personalInfo.email",
    "personalInfo.phone",
    "personalInfo.location",
    "personalInfo.url",
    "personalInfo.profiles.username",
    "personalInfo.profiles.url",
    "references.name",
    "references.email",
    "references.phone"
  ],
  "targets": {
    "work": [
      {
        "entryId": "work_1",
        "fields": [
          "company",
          "location",
          "url"
        ]
      },
      {
        "entryId": "work_2",
        "fields": [
          "location"
        ]
      }
    ],
    "education": [
      {
        "entryId": "edu_1",
        "fields": [
          "institution",
          "url"
        ]
      }
    ],
    "volunteer": [
      {
        "entryId": "vol_1",
        "fields": [
          "organization",
          "location"
        ]
      }
    ],
    "projects": [
      {
        "entryId": "proj_1",
        "fields": [
          "url"
        ]
      }
    ],
    "certificates": [
      {
        "entryId": "cert_1",
        "fields": [
          "issuer",
          "url"
        ]
      }
    ],
    "publications": [
      {
        "entryId": "pub_1",
        "fields": [
          "url"
        ]
      }
    ]
  },
  "options": {
    "mode": "mask",
    "placeholder": "[REDACTED]",
    "applyToAllIfNoTargets": true
  }
}

Sample Response (200)