v1

latestOpenAPI 3.0.3MIT2026-07-22153276289.7 KB
Resume Redactor

Get redaction results for a specific resume

Returns all the redaction results for that resume if processing is completed. The identifier is the unique ID returned after POST-ing the resume via the /redacted_resumes endpoint.

get/v2/redacted_resumes/{identifier}

Path parameters

identifierstring required
Example:ELglqBbT

Document identifier

Response

Successfully retrieved redacted resume

Example response

{
  "data": {
    "redactedPdf": "https://api-data.affinda.com/media/redacted_resumes/resume_redacted.pdf"
  },
  "meta": {
    "customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834",
    "fileName": "Document.pdf",
    "ready": true,
    "readyDt": "2020-12-10T01:43:32.276724Z",
    "language": "en",
    "pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
    "parentDocument": {
      "identifier": "mEFayXdO"
    },
    "childDocuments": [
      {
        "identifier": "mEFayXdO"
      }
    ],
    "pages": [
      {
        "image": "https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
        "imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
        "height": 700,
        "width": 500,
        "rotation": 90
      }
    ],
    "reviewUrl": "https://app.affinda.com/review/XJ5kK123?signature=12345",
    "ocrConfidence": 0.97,
    "documentType": "resume",
    "regionBias": {
      "strict": true
    }
  },
  "error": {
    "errorCode": "document_conversion_failed",
    "errorDetail": "Unable to convert word document"
  }
}