AFaffinda
Resume Redactor

Upload a resume for redacting

Uploads a resume for redacting.

post/v2/redacted_resumes

Request

Request body multipart/form-data

filestring binary

File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG, TIFF, ODT, XLS, XLSX

identifierstring

Deprecated in favor of customIdentifier.

customIdentifierstring

Specify a custom identifier for the document if you need one, not required to be unique.

fileNamestring nullable

Optional filename of the file

urlstring nullable

URL to download the resume.

languagestring nullable

Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.

waitboolean

If "true" (default), will return a response only after processing has completed. If "false", will return an empty data object which can be polled at the GET endpoint until processing is complete.

redactHeadshotstring

Whether to redact headshot

redactPersonalDetailsstring

Whether to redact personal details (e.g. name, address)

redactWorkDetailsstring

Whether to redact work details (e.g. company names)

redactEducationDetailsstring

Whether to redact education details (e.g. university names)

redactRefereesstring

Whether to redact referee details

redactLocationsstring

Whether to redact location names

redactDatesstring

Whether to redact dates

redactGenderstring

Whether to redact gender

redactPdfMetadatastring

Whether to redact PDF metadata

expiryTimestring date-time nullable

The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.

Example request

{
  "fileName": "Document.pdf",
  "url": "https://api.affinda.com/static/sample_resumes/example.pdf",
  "language": "en",
  "wait": true
}

Response

Only returned when wait=True, will return the created 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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.