Overview of Affinda's Recruitment AI Suite
This page contains information about all the Affinda Recruitment Products
- Overview
- Getting Started with Affinda Recruit
- Product Specific Guides
- Onboarding with Affinda
- Integration Guide
- Information Security
The following guide is intended for customers using Affinda's Recruitment Product suite including our Resume Parser, Job Description Parser, Search & Match and Resume Redactor
For customers looking at automate other document types, please see our Platform Product Guide.
Overview of Affinda Recruitment AI suite
Affinda Recruitment AI product suite covers five complimentary products. These products leverage our core technology and the data extracted from the Resume Parser to deliver time-saving products to the recruitment industry.
Getting Started with Affinda Recruit
Video not matching the portal you're using? You might be on our legacy platform. Please review Affinda's Legacy Portal Guide for more information.
Product Specific Guides
- Resume Parser Guide
- Search & Match Guide
- Job Description Parser Guide
- Resume Redactor Guide
- Resume Summary Guide
Onboarding with Affinda
Creating your Free Trial
To create an account, navigate to the registration page at https://app.affinda.com/. When signing up for Affinda, please choose "Recruitment" as your product of interest to access the complete recruitment suite. After creating your account, you will be given instant free trial access to the application. This free trial includes 200 free credits that expire after 30 days.
After creating your free trial, you should automatically see the Recruitment workspace, which includes all the recruitment tools for testing. If the workspace doesn’t appear, please reach out to your Affinda account manager or submit a request via our contact form.
Managing team members
Within the Affinda platform, teams can collaborate to configure their workflow and document types and to process documents on an ongoing basis.
User Permissions
Organization Permissions
At an Organization level, Affinda has three levels of permissions.
- Owners
Can manage other Users, Workspaces, Document Types and Billing - Admins
Can manage other Users, Workspaces and Document Types - Members
Their only role is to validate documents within Workspaces for which they have been granted permission. Members cannot change any settings (unless they have been added as Workspace Admins - see below)
Adding New Users
To invite new Users to your Organization, navigate to the 'Members' settings from your Organization homepage. The invited User will receive an email inviting them to accept the invitation, at which point they will be prompted to either log in to their existing account or register a new account.
Integration Guide
Authentication token
Affinda's API users basic authentication using API keys. Each Affinda user will have their own API keys to manage within their user profile settings
Each API key is only viewable once when created for security purposes. As a result, users should ensure that they copy their API keys and store them in a safe location within their own environment.
API keys can always be revoked and re-generated if a user fails to copy their initial key
Key rotation
Users can manage API keys effectively via the rotation capabilities offered through the web app.
- Viewing the key: Once you create a key, you can only view it once within your user settings page in the application. It is crucial that you copy and store it in a safe location within your environment.
- Maximum of 3 API keys: You can generate a maximum of three API keys within the Affinda app.
- Naming and Expiry: Each API key can be named and set with an expiry date or to never expire, based on your requirements.
Processing Resumes/Job Descriptions
-
Document Upload via API: Documents can be uploaded to Affinda by sending a request to the POST documents endpoint. Each new document upload will consume one credit. Upon successful upload, the API response will include a unique document identifier (e.g., "document": "EfHgjcsD").
-
The following parameters are required to successfully send a POST request to Affinda:
- Workspace ID: Log in to your Affinda application and go to Workspace > Settings> Workflow>Configure Integrations to find your Workspace ID
- Document Type ID: Open an already uploaded document in the app, then navigate to Configure Fields > Settings > Document Type ID. Copy the Document Type ID and paste it into the "documentType" field in your API request.
- Bearer Token: Log in to your Affinda application and go to Workspace > Settings> Workflow>Configure Integrations to manage API keys
-
-
Retrieve document after initial parsing: To retrieve the results of a previously processed document, clients can use the Get Document endpoint. Retrieving results from this endpoint does not consume any credits.
Can’t find your Document Type ID? You might be using Affinda's Legacy Portal. Check out the Affinda's Legacy Portal Guidefor instructions on using the Affinda A
There are a number of decisions for customers when uploading a document via API
| Area | Description |
|---|---|
| Document | Either a file or URL needs to be included in the POST request. The following formats are supported: PDF, ZIP, DOC, DOCX,XLS, XLSX, ODT, RTF, TXT, HTML, PNG, JPG, TIFF, JPEG- Volume Limits: There is no limit to the number of documents you can submit to the Affinda API. However, you will be limited to 30 documents per minute that will be processed by our high priority queue. If you would like to specify which queue to use, you can set the lowPriority parameter during document submission. Note that if you explicitly set lowPriority to false, and if you have exceeded the high priority queue rate limit, you will receive a 429 (Too Many Requests) response.- Page Limits: The default page limit for all customers is 10 pages. Settings may be adjusted to increase this limit on a case-by-case basis. Please get in contact with your Affinda account manager for details or submit a request via our contact form . |
| Workspace and Document Type ID | Specify Document Type ID instead of Workspace ID:Customers using our Resume or Job Description Parser typically know the type of document being submitted. Therefore, we recommend specifying both the relevant Document Type ID and Workspace ID when sending documents via the API. This avoids relying on automatic classification to route the document to the correct model, ensuring more accurate and efficient processing. Find Workspace ID: Log in to your Affinda application and go to Workspace > Settings> Workflow>Configure Integrations to find your Workspace ID: Find Document Type ID: Open an already uploaded document in the app, then navigate to Configure Fields > Settings > Document Type ID. Copy the Document Type ID and paste it into the "documentType" field in your API request. Important note: Each organisation has a maximum limit of 100 workspaces. If you anticipate exceeding this limit, please contact your Affinda account manager for assistance or submit a request through our contact form. |
| Synchronous or Asynchronous Responses | Within the request, customers can set waitto true / false depending if the parsing response needs to be returned synchronously or not. For customers who are bulk uploading, it is recommended to set waitto false.- Synchronous - If "true" (default), will return a response only after processing has been completed. - Asynchronous - If "false", will return the document identifier and other metadata alongside an empty data object. The data object can be returned at a later date by either: - Polling GET endpoint until processing is complete; or - Setting up webhooks to get a notification that parsing has completed and then using the GET endpoint to pull the extracted data |
| Parsing Time | For customers who need real-time responses where seconds count, please set parameters to the following when submitting a document: - enableValidationTool: False - deleteAfterParse: True - compact: True By setting these parameters, Affinda can bypass the need to save any data to our database, which eliminates unnecessary processing time and reduces the overall time taken to return results. However, note that this means that: - The document can not be viewed in the Affinda app(e.g. for 'human in the loop' validation) - The document is not retained in our system so responses can not be fetched at a later date - Field metadata is not returned, only the 'parsed' value |
Integration through a third-party
Affinda is now available on Zapier, making it simpler to integrate our document processing solution with your favorite apps. Learn how to automate your document workflows using Affinda and Zapier HERE
Information Security
Product overview
Affinda is ISO27001 certified, reflecting our commitment to rigorous, best-in-class information security practices and robust risk management protocols. All our products are designed with privacy, security, and compliance as core principles.
- Resume and Job Description Parsers: Affinda’s parsers convert unstructured resumes and job descriptions into structured data, enabling faster, more informed decisions for HR and recruiters. Unlike generative AI services, Affinda is an extractive AI solution. Our proprietary technology extracts data from documents, reducing risks commonly associated with generative AI, such as copyright infringement and bias risks. We do not use large language models like GPT and ensure data privacy by not using client documents to train our models.
- Search and Match: Affinda’s search algorithm delivers precise, relevant results based solely on user-defined criteria. No AI is employed, ensuring full control and transparency in the decision-making process.
- Resume Redactor: Our Resume Redactor, powered by the same proprietary AI technology as our Resume Parser, redacts sensitive information from resumes. We also offer an LLM Redactor for enhanced accuracy and expanded field coverage, adhering to the same stringent security standards.
- Resume Summary: Affinda's CV Summary leverages LLM technology to automatically generate concise overviews of candidates' experience, skills, and qualifications based on their resumes. To promote fair and unbiased recruitment, personal details such as names, ages, and nationalities are excluded, enabling hiring teams to focus solely on candidates' qualifications and job suitability.
On-Premise Deployment
Most customers benefit from Affinda's technology through our hosted solution. However, some may require a locally deployed solution for specific needs. To support these users, we’ve published an Affinda Self-Hosted Deployment Guide
If you’re interested in a local deployment, please contact your Affinda account manager for further details or submit a request via our contact form.
Document Lifecycle
The Affinda API provides customers full control over the lifecycle of their submitted documents.
Lifecycle options can be set per document and include:
Deletion
When a document is deleted, the document and all associated files are immediately removed from our servers. All access to the document will be lost. Document metadata, which may include file names but does not include the file content, may remain in Affinda’s database or backups of Affinda’s database for some time.
Expiration
A typical scenario when incorporating the API into a web app is to enable a customer’s end users to perform document parses on demand. In such cases, it is not necessary or desirable to store the result indefinitely. To facilitate this, the API allows a customer to specify an expiry time when they submit the document. When a document has an expiration set, it will be deleted automatically at the expiration date.
Offboarding
- User Offboarding: When a user is removed from an organisation, they are automatically offboarded and will no longer have access to any data within the organisation
- Delete Organisation: An organization can be deleted either via API or through the Affinda app by navigating to: Organization > Settings > "Delete [Organization Name]".