Upgrading to API V3

The latest version of the Affinda API (v3) is more generalized and flexible compared to the previous version (v2). With this new version, the 'document' endpoint can now handle a wide range of different document types, making it more powerful and efficient. Customers now have greater functionality and control over their data, allowing them to upload and return data more conveniently.


Affinda has no plans to retire API v2 and it will continue to be supported for the foreseeable future.

However, new products (e.g. NextGen Resume Parser) may not be supported by this version

Main differences between API V2 and V3

1. Document agnostic end-points

  • V2: Separate endpoints were available for each document type supported, which meant that customers had to upload documents to specific endpoints for resumes, job descriptions, or invoices.
  • V3: Uploading documents can now be done via a single 'documents' endpoint, and the response received depends on the document type considered. While this is a different end-point, the way that this works is largely the same as in V2 (e.g. same parameters).

2. Document organisation

  • V2: No ability to organise documents of the same type into logical groups (e.g. all resumes are all located in the same queue).
  • V3: We leverage the hierarchy of Workspaces and Collections found in our web app to organise documents in logical groups and potentially apply different settings to those groups (e.g. date format). When uploading documents, customers need to specify either the Workspace or Collection to upload to.

3. Capabilities

  • V2: Set of capabilities is largely restricted to uploading documents and receiving the results.
  • V3: Option exists to make use of a far wider range of features, such as adding tags, mata mapping, validation rules and managing user access.