Get PII Redaction

Retrieves a previously created redacted resume by redactionId.

Request Details

path Parameters

Field	Type	Required	Description
id	string	Yes	The unique identifier of the resume
redactionId	string	Yes	The unique identifier of the redaction

Sample Request & Response

GET

/v1/resumes/{id}/redactions/{redactionId}

Sample Request

Headers:

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

Path Parameters:

{
  "id": "string (required) - The unique identifier of the resume",
  "redactionId": "string (required) - The unique identifier of the redaction"
}

Sample Response (200)

{
  "resumeId": "resume_abc123",
  "redactedFields": [
    "personalInfo.name",
    "personalInfo.email",
    "personalInfo.phone",
    "personalInfo.location",
    "personalInfo.url",
    "personalInfo.profiles.username",
    "personalInfo.profiles.url",
    "references[].name",
    "references[].email",
    "references[].phone",
    "work[work_1].company",
    "work[work_1].location",
    "work[work_1].url",
    "work[work_2].location",
    "education[edu_1].institution",
    "education[edu_1].url",
    "volunteer[vol_1].organization",
    "volunteer[vol_1].location",
    "projects[proj_1].url",
    "certificates[cert_1].issuer",
    "certificates[cert_1].url",
    "publications[pub_1].url"
  ],
  "redactionSummary": {
    "total": 22,
    "bySection": {
      "personalInfo": 6,
      "references": 3,
      "work": 4,
      "education": 2,
      "volunteer": 2,
      "projects": 1,
      "certificates": 2,
      "publications": 2
    }
  },
  "redactedResume": {
    "id": "resume_abc123",
    "personalInfo": {
      "name": "[REDACTED]",
      "occupation": "Software Engineer",
      "email": "[REDACTED]",
      "phone": "[REDACTED]",
      "url": "[REDACTED]",
      "summary": "Experienced engineer...",
      "location": "[REDACTED]",
      "profiles": [
        {
          "network": "LinkedIn",
          "username": "[REDACTED]",
          "url": "[REDACTED]"
        },
        {
          "network": "GitHub",
          "username": "janedoe",
          "url": "https://github.com/janedoe"
        }
      ]
    },
    "work": [
      {
        "__id": "work_1",
        "company": "[REDACTED]",
        "position": "Senior Developer",
        "location": "[REDACTED]",
        "url": "[REDACTED]",
        "startDate": "2020-01-01",
        "endDate": "2023-05-01",
        "summary": "Led a team...",
        "highlights": [
          {
            "__id": "hl_1",
            "value": "Scaled X by 40%"
          }
        ]
      },
      {
        "__id": "work_2",
        "company": "Acme Corp",
        "position": "Developer",
        "location": "[REDACTED]",
        "url": "https://acme.example",
        "startDate": "2018-01-01",
        "endDate": "2019-12-31",
        "summary": "Built Y...",
        "highlights": []
      }
    ],
    "education": [
      {
        "__id": "edu_1",
        "institution": "[REDACTED]",
        "area": "Computer Science",
        "studyType": "Bachelor's",
        "startDate": "2014-09-01",
        "endDate": "2018-06-01",
        "score": "3.8",
        "summary": "Dean's list",
        "courses": []
      }
    ],
    "volunteer": [
      {
        "__id": "vol_1",
        "organization": "[REDACTED]",
        "position": "Mentor",
        "startDate": "2019-01-01",
        "endDate": "2020-01-01",
        "summary": "Mentored students",
        "highlights": []
      }
    ],
    "projects": [
      {
        "__id": "proj_1",
        "name": "Open Source Tool",
        "startDate": "2022-01-01",
        "endDate": "2022-10-01",
        "description": "CLI utility",
        "highlights": [],
        "url": "[REDACTED]"
      }
    ],
    "references": [
      {
        "__id": "ref_1",
        "name": "[REDACTED]",
        "position": "Engineering Manager",
        "company": "TechCorp",
        "email": "[REDACTED]",
        "phone": "[REDACTED]",
        "relationship": "Manager"
      }
    ],
    "certificates": [
      {
        "__id": "cert_1",
        "name": "AWS SAA",
        "date": "2021-05-01",
        "issuer": "[REDACTED]",
        "url": "[REDACTED]"
      }
    ],
    "publications": [
      {
        "__id": "pub_1",
        "name": "Scaling React Apps",
        "publisher": "Example Press",
        "releaseDate": "2020-07-01",
        "url": "[REDACTED]",
        "summary": "Best practices..."
      }
    ]
  }
}