Skip to main content
POST
/
v2
/
job_descriptions
Upload a job description for parsing
curl --request POST \
  --url https://{region}.affinda.com/v2/job_descriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form url=https://api.affinda.com/static/sample_job_descriptions/example.pdf \
  --form 'data={
  "jobTitle": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>"
  },
  "contactEmail": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "contactName": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "contactPhone": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "startDate": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "2022-02-09"
  },
  "endDate": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "2022-02-09"
  },
  "jobType": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "languages": [
    {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "pageIndex": 0,
      "raw": "2/9/2022",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "dataPoint": "<string>",
      "contentType": "<string>"
    }
  ],
  "skills": [
    {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "pageIndex": 0,
      "raw": "2/9/2022",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "dataPoint": "<string>",
      "contentType": "<string>"
    }
  ],
  "organizationName": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "organizationWebsite": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "educationLevel": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "educationAccreditation": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": "John Smith"
  },
  "expectedRemuneration": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": {
      "minimum": "3455343.50",
      "maximum": "55545343.50",
      "currency": "USD",
      "unit": "Annually"
    }
  },
  "location": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>"
  },
  "certifications": [
    {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "pageIndex": 0,
      "raw": "2/9/2022",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "dataPoint": "<string>",
      "contentType": "<string>",
      "parsed": "John Smith"
    }
  ],
  "yearsExperience": {
    "id": 2,
    "rectangle": {
      "x0": 2.43,
      "y0": 4.55,
      "x1": 4.56,
      "y1": 6.32,
      "pageIndex": 1
    },
    "pageIndex": 0,
    "raw": "2/9/2022",
    "confidence": 0.86,
    "classificationConfidence": 0.95,
    "textExtractionConfidence": 0.9,
    "isVerified": true,
    "isClientVerified": true,
    "isAutoVerified": true,
    "dataPoint": "<string>",
    "contentType": "<string>",
    "parsed": {
      "minimum": 0.5,
      "maximum": 5
    }
  }
}' \
  --form 'identifier=<string>' \
  --form 'customIdentifier=<string>' \
  --form fileName=Document.pdf \
  --form wait=true \
  --form rejectDuplicates=true \
  --form language=en \
  --form expiryTime=2023-11-07T05:31:56Z \
  --form 'regionBias={"country": "vn"}' \
  --form lowPriority=true
{
  "data": {
    "jobTitle": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": {
        "name": "Software Developer",
        "emsiId": "ETE2AD3A1C11B4EC9B",
        "managementLevel": "Mid",
        "classification": {
          "socCode": 2463,
          "title": "Clergy",
          "minorGroup": "Welfare Professionals",
          "subMajorGroup": "BUSINESS, MEDIA AND PUBLIC SERVICE PROFESSIONALS",
          "majorGroup": "PROFESSIONAL OCCUPATIONS",
          "minorGroupCode": 4122,
          "subMajorGroupCode": 4122,
          "majorGroupCode": 4122
        }
      }
    },
    "contactEmail": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "<string>"
    },
    "contactName": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "<string>"
    },
    "contactPhone": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "<string>"
    },
    "startDate": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "2022-02-09"
    },
    "endDate": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "2022-02-09"
    },
    "jobType": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "<string>"
    },
    "languages": [
      {
        "id": 2,
        "rectangle": {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        },
        "rectangles": [
          {
            "x0": 2.43,
            "y0": 4.55,
            "x1": 4.56,
            "y1": 6.32,
            "pageIndex": 1
          }
        ],
        "pageIndex": 0,
        "raw": "<string>",
        "confidence": 0.86,
        "classificationConfidence": 0.95,
        "textExtractionConfidence": 0.9,
        "isVerified": true,
        "isClientVerified": true,
        "isAutoVerified": true,
        "contentType": "<string>",
        "dataPoint": "<string>",
        "parsed": "Mandarin Chinese"
      }
    ],
    "skills": [
      {
        "id": 2,
        "rectangle": {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        },
        "rectangles": [
          {
            "x0": 2.43,
            "y0": 4.55,
            "x1": 4.56,
            "y1": 6.32,
            "pageIndex": 1
          }
        ],
        "pageIndex": 0,
        "raw": "<string>",
        "confidence": 0.86,
        "classificationConfidence": 0.95,
        "textExtractionConfidence": 0.9,
        "isVerified": true,
        "isClientVerified": true,
        "isAutoVerified": true,
        "contentType": "<string>",
        "dataPoint": "<string>",
        "parsed": "Mandarin Chinese"
      }
    ],
    "organizationName": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "<string>"
    },
    "organizationWebsite": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "<string>"
    },
    "educationLevel": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "<string>"
    },
    "educationAccreditation": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": "<string>"
    },
    "expectedRemuneration": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": {
        "minimum": "3455343.50",
        "maximum": "55545343.50",
        "currency": "USD",
        "unit": "Annually"
      }
    },
    "location": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": {
        "rawInput": "Blacksburg, VA",
        "formatted": "Blacksburg, VA, USA",
        "postalCode": "3124",
        "state": "Virginia",
        "stateCode": "TX",
        "country": "United States",
        "countryCode": "US",
        "streetNumber": "1",
        "street": "Smith St",
        "apartmentNumber": "12",
        "city": "Blacksburg",
        "latitude": "67.0124",
        "longitude": "67.0124",
        "poBox": "P.O. Box 123"
      }
    },
    "certifications": [
      {
        "id": 2,
        "rectangle": {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        },
        "rectangles": [
          {
            "x0": 2.43,
            "y0": 4.55,
            "x1": 4.56,
            "y1": 6.32,
            "pageIndex": 1
          }
        ],
        "pageIndex": 0,
        "raw": "<string>",
        "confidence": 0.86,
        "classificationConfidence": 0.95,
        "textExtractionConfidence": 0.9,
        "isVerified": true,
        "isClientVerified": true,
        "isAutoVerified": true,
        "contentType": "<string>",
        "dataPoint": "<string>",
        "parsed": "<string>"
      }
    ],
    "yearsExperience": {
      "id": 2,
      "rectangle": {
        "x0": 2.43,
        "y0": 4.55,
        "x1": 4.56,
        "y1": 6.32,
        "pageIndex": 1
      },
      "rectangles": [
        {
          "x0": 2.43,
          "y0": 4.55,
          "x1": 4.56,
          "y1": 6.32,
          "pageIndex": 1
        }
      ],
      "pageIndex": 0,
      "raw": "<string>",
      "confidence": 0.86,
      "classificationConfidence": 0.95,
      "textExtractionConfidence": 0.9,
      "isVerified": true,
      "isClientVerified": true,
      "isAutoVerified": true,
      "contentType": "<string>",
      "dataPoint": "<string>",
      "parsed": {
        "minimum": 0.5,
        "maximum": 5
      }
    },
    "rawText": "Human Resources Assistant Switzerland '... <rest of job description text>'"
  },
  "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",
        "height": 700,
        "width": 500,
        "rotation": 90,
        "imageTranslated": "https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062"
      }
    ],
    "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"
  }
}

Authorizations

​
Authorization
string
header
required

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

multipart/form-data

Job Description to upload, either via fileupload or URL to a file

​
file
file

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

​
url
string | null

URL to download the job description.

Example:

"https://api.affinda.com/static/sample_job_descriptions/example.pdf"

​
data
object

A JSON-encoded string of the JobDescriptionData object.

​
identifier
string
deprecated

Deprecated in favor of customIdentifier.

​
customIdentifier
string

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

​
fileName
string | null

Optional filename of the file

Example:

"Document.pdf"

​
wait
boolean
default:true

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.

Example:

true

​
rejectDuplicates
boolean | null

If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.

Example:

true

​
language
string | null

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

Example:

"en"

​
expiryTime
string<date-time> | null

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

​
regionBias
string

A JSON representation of the RegionBias object.

Example:

"{\"country\": \"vn\"}"

​
lowPriority
boolean

Explicitly mark this document as low priority.

Example:

true

Response

Only returned when wait=True, will return the created resume

​
data
object
required
​
meta
object
required
​
error
object
required