Authorizations
Basic authentication using an API key, e.g. {Authorization: Bearer 75z0bb4fbdf97b7e4111ff6c0015471094155f91}
.
You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.
Body
Resume to upload, either via fileupload or URL to a file
File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG, TIFF, ODT, XLS, XLSX
Deprecated in favor of customIdentifier
.
Specify a custom identifier for the document if you need one, not required to be unique.
Optional filename of the file
"Document.pdf"
URL to download the resume.
"https://api.affinda.com/static/sample_resumes/example.pdf"
Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese.
"en"
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.
true
Whether to redact headshot
Whether to redact personal details (e.g. name, address)
Whether to redact work details (e.g. company names)
Whether to redact education details (e.g. university names)
Whether to redact referee details
Whether to redact location names
Whether to redact dates
Whether to redact gender
Whether to redact PDF metadata
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.