Welcome to the new Affinda Docs – explore the Academy, browse guides, or ask the AI assistant any questions you have!
curl --request POST \
--url https://{region}.affinda.com/v2/redacted_resumes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'identifier=<string>' \
--form 'customIdentifier=<string>' \
--form fileName=Document.pdf \
--form url=https://api.affinda.com/static/sample_resumes/example.pdf \
--form language=en \
--form wait=true \
--form redactHeadshot=true \
--form redactPersonalDetails=true \
--form redactWorkDetails=true \
--form redactEducationDetails=true \
--form redactReferees=true \
--form redactLocations=true \
--form redactDates=true \
--form redactGender=true \
--form redactPdfMetadata=true \
--form expiryTime=2023-11-07T05:31:56Z
{
"data": {
"redactedPdf": "https://api-data.affinda.com/media/redacted_resumes/resume_redacted.pdf"
},
"meta": {
"identifier": "<string>",
"customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834",
"fileName": "Document.pdf",
"ready": true,
"readyDt": "2020-12-10T01:43:32.276724Z",
"failed": false,
"expiryTime": "2023-11-07T05:31:56Z",
"language": "en",
"pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"parentDocument": {
"identifier": "<string>"
},
"childDocuments": [
{
"identifier": "<string>"
}
],
"pages": [
{
"id": 2,
"pageIndex": 0,
"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
}
],
"isVerified": false,
"reviewUrl": "https://app.affinda.com/review/XJ5kK123?signature=12345",
"ocrConfidence": 0.97,
"createdDt": "2023-11-07T05:31:56Z",
"documentType": "resume",
"regionBias": {
"country": "<string>",
"countries": [
"<string>"
],
"squareCoordinates": [
123
],
"strict": true
},
"isOcrd": true
},
"error": {
"errorCode": "document_conversion_failed",
"errorDetail": "Unable to convert word document"
}
}
Uploads a resume for redacting.
curl --request POST \
--url https://{region}.affinda.com/v2/redacted_resumes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'identifier=<string>' \
--form 'customIdentifier=<string>' \
--form fileName=Document.pdf \
--form url=https://api.affinda.com/static/sample_resumes/example.pdf \
--form language=en \
--form wait=true \
--form redactHeadshot=true \
--form redactPersonalDetails=true \
--form redactWorkDetails=true \
--form redactEducationDetails=true \
--form redactReferees=true \
--form redactLocations=true \
--form redactDates=true \
--form redactGender=true \
--form redactPdfMetadata=true \
--form expiryTime=2023-11-07T05:31:56Z
{
"data": {
"redactedPdf": "https://api-data.affinda.com/media/redacted_resumes/resume_redacted.pdf"
},
"meta": {
"identifier": "<string>",
"customIdentifier": "46ab8b02-0e5b-420c-877c-8b678d46a834",
"fileName": "Document.pdf",
"ready": true,
"readyDt": "2020-12-10T01:43:32.276724Z",
"failed": false,
"expiryTime": "2023-11-07T05:31:56Z",
"language": "en",
"pdf": "https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062",
"parentDocument": {
"identifier": "<string>"
},
"childDocuments": [
{
"identifier": "<string>"
}
],
"pages": [
{
"id": 2,
"pageIndex": 0,
"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
}
],
"isVerified": false,
"reviewUrl": "https://app.affinda.com/review/XJ5kK123?signature=12345",
"ocrConfidence": 0.97,
"createdDt": "2023-11-07T05:31:56Z",
"documentType": "resume",
"regionBias": {
"country": "<string>",
"countries": [
"<string>"
],
"squareCoordinates": [
123
],
"strict": true
},
"isOcrd": true
},
"error": {
"errorCode": "document_conversion_failed",
"errorDetail": "Unable to convert word document"
}
}
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.
Resume to upload, either via fileupload or URL to a file
The body is of type object
.
Only returned when wait=True, will return the created redacted resume
The response is of type object
.