# Affinda Documentation ## Docs - [Getting started with the Affinda platform](https://docs.affinda.com/academy/getting-started.md): Learn the basics of navigating the Affinda app: organizations, workspaces, document types, workflows, and document statuses for new users. - [Improving accuracy: a deep dive into extraction models](https://docs.affinda.com/academy/improving-accuracy.md): Strategies and best practices to push Affinda extraction models to 99%+ accuracy, including training data, schema tuning, and validation feedback loops. - [Create your integration with our AI Integration Agent](https://docs.affinda.com/academy/integration-agent.md): Use the Affinda AI Integration Agent to build no-code data exports to downstream applications like ATS, ERP, and CRM systems using natural language. - [Creating a new model](https://docs.affinda.com/academy/model-creation.md): Step-by-step guide to creating and configuring a new Affinda Information Extraction model in minutes, including schema setup and training data. - [User validation of extracted data](https://docs.affinda.com/academy/review-extraction.md): Validate extracted data in the Affinda review interface to correct values, improve model accuracy over time, and approve documents for downstream export. - [Schema design and field configuration best practices](https://docs.affinda.com/academy/schema-design.md): Practical guidance for designing document schemas and configuring fields in Affinda to maximize extraction accuracy and downstream integration quality. - [Integration workflows and solution design patterns](https://docs.affinda.com/academy/solution-design.md): Compare integration workflow patterns for connecting Affinda to your existing document processing pipelines, including API, email, and ATS integrations. - [Reviewing splitting and classification results](https://docs.affinda.com/academy/split-classify.md): Review, adjust, and confirm Affinda's automatic document splitting and classification output before extraction runs on each individual document. - [Achieving straight-through processing](https://docs.affinda.com/academy/straight-through-processing.md): Configure machine validation, confidence thresholds, and automation rules to achieve straight-through processing for high-volume document workflows. - [Table Editor](https://docs.affinda.com/academy/table-editor.md): Use the Affinda table editor to add, remove, and correct rows and columns in extracted tables before approving documents for downstream export. - [Batch create annotations](https://docs.affinda.com/api-reference/annotations/batch-create-annotations.md): Batch create annotations - [Batch delete annotations](https://docs.affinda.com/api-reference/annotations/batch-delete-annotations.md): Batch delete annotations - [Batch update annotations](https://docs.affinda.com/api-reference/annotations/batch-update-annotations.md): Batch update annotations - [Create a annotation](https://docs.affinda.com/api-reference/annotations/create-a-annotation.md): Create a annotation - [Delete an annotation](https://docs.affinda.com/api-reference/annotations/delete-an-annotation.md): Deletes the specified annotation from the database. - [Get list of all annotations](https://docs.affinda.com/api-reference/annotations/get-list-of-all-annotations.md): Returns your annotations. - [Get specific annotation](https://docs.affinda.com/api-reference/annotations/get-specific-annotation.md): Return a specific annotation. - [Update an annotation](https://docs.affinda.com/api-reference/annotations/update-an-annotation.md): Update data of an annotation. - [Add value for a data source](https://docs.affinda.com/api-reference/data-sources/add-value-for-a-data-source.md): Adds a value to a mapping data source - [Create a data source](https://docs.affinda.com/api-reference/data-sources/create-a-data-source.md): Create a custom mapping data source. - [Delete specific data source](https://docs.affinda.com/api-reference/data-sources/delete-specific-data-source.md): Delete the specified mapping data source from the database. - [Delete specific data source value](https://docs.affinda.com/api-reference/data-sources/delete-specific-data-source-value.md): Delete the specified mapping data source value from the database. - [Get specific data source](https://docs.affinda.com/api-reference/data-sources/get-specific-data-source.md): Return a specific mapping data source. - [Get specific data source value](https://docs.affinda.com/api-reference/data-sources/get-specific-data-source-value.md): Return a specific mapping dta source value. - [List data sources](https://docs.affinda.com/api-reference/data-sources/list-data-sources.md): Returns the list of all custom mapping data sources. - [List values for a data source](https://docs.affinda.com/api-reference/data-sources/list-values-for-a-data-source.md): Returns the list of all values in a mapping data source - [Replace values for a data source](https://docs.affinda.com/api-reference/data-sources/replace-values-for-a-data-source.md): Replaces the list of all values in a mapping data source Note: For large data sources (e.g. > 1000 values), it can take a few minutes after the request completes for the new values to be searchable. - [Update specific data source value](https://docs.affinda.com/api-reference/data-sources/update-specific-data-source-value.md): Update the specified mapping data source value. - [Create a collection](https://docs.affinda.com/api-reference/deprecated-end-points/create-a-collection.md): Create a collection - [Create a data point](https://docs.affinda.com/api-reference/deprecated-end-points/create-a-data-point.md): Create a custom data point. - [Create a data point choice](https://docs.affinda.com/api-reference/deprecated-end-points/create-a-data-point-choice.md): Create a custom data point choice. - [Create a mapping](https://docs.affinda.com/api-reference/deprecated-end-points/create-a-mapping.md): Create a custom mapping. - [Create data field for a collection along with a new data point.](https://docs.affinda.com/api-reference/deprecated-end-points/create-data-field-for-a-collection-along-with-a-new-data-point.md): Create data field for a collection along with a new data point. - [Delete a collection](https://docs.affinda.com/api-reference/deprecated-end-points/delete-a-collection.md): Deletes the specified collection from the database. - [Delete a data point](https://docs.affinda.com/api-reference/deprecated-end-points/delete-a-data-point.md): Deletes the specified data point from the database. - [Delete a data point choice](https://docs.affinda.com/api-reference/deprecated-end-points/delete-a-data-point-choice.md): Deletes the specified data point choice from the database. - [Delete specific mapping](https://docs.affinda.com/api-reference/deprecated-end-points/delete-specific-mapping.md): Delete the specified mapping from the database. - [Get data field for a collection assosciated with a data point.](https://docs.affinda.com/api-reference/deprecated-end-points/get-data-field-for-a-collection-assosciated-with-a-data-point.md): Get a data field for a collection assosciated with a data point - [Get list of all collections](https://docs.affinda.com/api-reference/deprecated-end-points/get-list-of-all-collections.md): Returns your collections. - [Get list of all data points](https://docs.affinda.com/api-reference/deprecated-end-points/get-list-of-all-data-points.md): Returns your custom data points as well as Affinda's off-the-shelf data points. - [Get list of data point choices](https://docs.affinda.com/api-reference/deprecated-end-points/get-list-of-data-point-choices.md): Returns available choices for a specific enum data point. - [Get specific collection](https://docs.affinda.com/api-reference/deprecated-end-points/get-specific-collection.md): Return a specific collection. - [Get specific data point](https://docs.affinda.com/api-reference/deprecated-end-points/get-specific-data-point.md): Return a specific data point. - [Get specific data point choice](https://docs.affinda.com/api-reference/deprecated-end-points/get-specific-data-point-choice.md): Return a specific data point choice. - [Get specific mapping](https://docs.affinda.com/api-reference/deprecated-end-points/get-specific-mapping.md): Return a specific mapping. - [Get usage by collection](https://docs.affinda.com/api-reference/deprecated-end-points/get-usage-by-collection.md): Return monthly credits consumption of a collection. Deprecated: use `GET /v3/usage?organization={id}&document_type={id}` instead. The new endpoint returns a unified daily series and uses the modern "document type" terminology. - [List mappings](https://docs.affinda.com/api-reference/deprecated-end-points/list-mappings.md): Returns the list of all custom data mappings. - [Replace choices of a data point](https://docs.affinda.com/api-reference/deprecated-end-points/replace-choices-of-a-data-point.md): Replace choices of a data point. Existing choices and incoming choices are matched base on their `value`. New `value` will be created, existing `value` will be updated, and `value` not in incoming choices will be deleted. - [Update a collection](https://docs.affinda.com/api-reference/deprecated-end-points/update-a-collection.md): Update data of a collection. - [Update a data point](https://docs.affinda.com/api-reference/deprecated-end-points/update-a-data-point.md): Update data of a data point. - [Update a data point choice](https://docs.affinda.com/api-reference/deprecated-end-points/update-a-data-point-choice.md): Update data of a data point choice. - [Update data field for a collection assosciated with a data point.](https://docs.affinda.com/api-reference/deprecated-end-points/update-data-field-for-a-collection-assosciated-with-a-data-point.md): Update data field for a collection assosciated with a data point - [Update specific mapping](https://docs.affinda.com/api-reference/deprecated-end-points/update-specific-mapping.md): Updates a specific mapping. - [Create a document type](https://docs.affinda.com/api-reference/document-types/create-a-document-type.md): Create a new document type in the specified organization. - [Delete a document type](https://docs.affinda.com/api-reference/document-types/delete-a-document-type.md): Delete a document type. - [Generate JSON schema from a document type](https://docs.affinda.com/api-reference/document-types/generate-json-schema-from-a-document-type.md): Generate JSON schema from a document type. - [Generate Pydantic models from a document type](https://docs.affinda.com/api-reference/document-types/generate-pydantic-models-from-a-document-type.md): Generate Pydantic models from a document type. - [Get a document type](https://docs.affinda.com/api-reference/document-types/get-a-document-type.md): Returns the details of a specific document type. - [List document types](https://docs.affinda.com/api-reference/document-types/list-document-types.md): Returns a list of document types that the user has access to. - [Update a document type](https://docs.affinda.com/api-reference/document-types/update-a-document-type.md): Update an existing document type. - [Delete a document](https://docs.affinda.com/api-reference/documents/delete-a-document.md): Deletes the specified document from the database. - [Get list of all documents](https://docs.affinda.com/api-reference/documents/get-list-of-all-documents.md): Returns all the document summaries for that user, limited to 300 per page. - [Get redacted document](https://docs.affinda.com/api-reference/documents/get-redacted-document.md): Get the redacted version of a document. The original document is not modified. - [Get specific document](https://docs.affinda.com/api-reference/documents/get-specific-document.md): Return a specific document. - [Update a document](https://docs.affinda.com/api-reference/documents/update-a-document.md): Update file name, expiry time, or move to another collection, etc. - [Upload a document for parsing](https://docs.affinda.com/api-reference/documents/upload-a-document-for-parsing.md): Uploads a document for parsing via file upload or URL. When successful, returns an `identifier` in the response for subsequent use with the [/documents/{identifier}](#get-/v3/documents/-identifier-) endpoint to check processing status and retrieve results.
- [Delete an invoice](https://docs.affinda.com/api-reference/invoice-extractor/delete-an-invoice.md): Delete the specified invoice from the database. Note, any invoices deleted from the database will no longer be used in any tailored customer models. - [Get list of all invoices](https://docs.affinda.com/api-reference/invoice-extractor/get-list-of-all-invoices.md): Returns all the invoice summaries for that user, limited to 300 per page. - [Get parse results for a specific invoice](https://docs.affinda.com/api-reference/invoice-extractor/get-parse-results-for-a-specific-invoice.md): Returns all the parse results for that invoice if processing is completed. The `identifier` is the unique ID returned after POST-ing the invoice via the [/invoices](#post-/invoices) endpoint. - [Upload an invoice for parsing](https://docs.affinda.com/api-reference/invoice-extractor/upload-an-invoice-for-parsing.md): Uploads an invoice for parsing. When successful, returns an `identifier` in the response for subsequent use with the [/invoices/{identifier}](#get-/invoices/-identifier-) endpoint to check processing status and retrieve results. - [Delete a job description](https://docs.affinda.com/api-reference/job-description-parser/delete-a-job-description.md): Deletes the specified job description from the database - [Get job description results for a specific job description file](https://docs.affinda.com/api-reference/job-description-parser/get-job-description-results-for-a-specific-job-description-file.md): Returns all the results for that job description if processing is completed. The `identifier` is the unique ID returned after POST-ing the resume via the [/job_descriptions](#post-/job_descriptions) endpoint. - [Get list of all job descriptions](https://docs.affinda.com/api-reference/job-description-parser/get-list-of-all-job-descriptions.md): Returns all the job descriptions for that user, limited to 300 per page. - [Update a job description's data](https://docs.affinda.com/api-reference/job-description-parser/update-a-job-descriptions-data.md): Update data of a job description. The `identifier` is the unique ID returned after POST-ing the job description via the [/job_descriptions](#post-/job_descriptions) endpoint. - [Upload a job description for parsing](https://docs.affinda.com/api-reference/job-description-parser/upload-a-job-description-for-parsing.md): Uploads a job description for parsing. When successful, returns an `identifier` in the response for subsequent use with the [/job_descriptions/{identifier}](#get-/job_descriptions/-identifier-) endpoint to check processing status and retrieve results. Job Descriptions can be uploaded as a file or a… - [Get detail of an organization](https://docs.affinda.com/api-reference/organizations/get-detail-of-an-organization.md): Get detail of an organization. - [Get list of all organizations](https://docs.affinda.com/api-reference/organizations/get-list-of-all-organizations.md): Returns all the organizations - [Delete a resume](https://docs.affinda.com/api-reference/resume-parser/delete-a-resume.md): Deletes the specified resume from the database - [Get list of all resumes](https://docs.affinda.com/api-reference/resume-parser/get-list-of-all-resumes.md): Returns all the resume summaries for that user, limited to 300 per page. - [Get parse results for a specific resume](https://docs.affinda.com/api-reference/resume-parser/get-parse-results-for-a-specific-resume.md): Returns all the parse results for that resume if processing is completed. The `identifier` is the unique ID returned after POST-ing the resume via the [/resumes](#post-/resumes) endpoint. - [Update a resume's data](https://docs.affinda.com/api-reference/resume-parser/update-a-resumes-data.md): Update data of a parsed resume. The `identifier` is the unique ID returned after POST-ing the resume via the [/resumes](#post-/resumes) endpoint. - [Upload a resume for parsing](https://docs.affinda.com/api-reference/resume-parser/upload-a-resume-for-parsing.md): **New customers:** this endpoint is part of our legacy v2 API. We recommend using the [POST /documents](#post-/documents) endpoint from our updated API instead — it supports parsing of all document types (resumes, invoices, etc.) through a single, unified interface.

Uploads a resume for pa… - [Delete a redacted resume](https://docs.affinda.com/api-reference/resume-redactor/delete-a-redacted-resume.md): Deletes the specified resume from the database - [Get list of all redacted resumes](https://docs.affinda.com/api-reference/resume-redactor/get-list-of-all-redacted-resumes.md): Returns all the redacted resume information for that resume - [Get redaction results for a specific resume](https://docs.affinda.com/api-reference/resume-redactor/get-redaction-results-for-a-specific-resume.md): Returns all the redaction results for that resume if processing is completed. The `identifier` is the unique ID returned after POST-ing the resume via the [/redacted_resumes](#post-/redacted_resumes) endpoint. - [Upload a resume for redacting](https://docs.affinda.com/api-reference/resume-redactor/upload-a-resume-for-redacting.md): Uploads a resume for redacting. - [Create a signed URL for the embeddable job description search tool](https://docs.affinda.com/api-reference/search-&-match--embedding/create-a-signed-url-for-the-embeddable-job-description-search-tool.md): Create and return a signed URL of the job description search tool which then can be embedded on a web page. An optional parameter `config_override` can be passed to override the user-level configurations of the embeddable search tool. - [Create a signed URL for the embeddable resume search tool](https://docs.affinda.com/api-reference/search-&-match--embedding/create-a-signed-url-for-the-embeddable-resume-search-tool.md): Create and return a signed URL of the resume search tool which then can be embedded on a web page. An optional parameter `config_override` can be passed to override the user-level configurations of the embeddable resume search tool. - [Get the config for the logged in user's embeddable job description search tool](https://docs.affinda.com/api-reference/search-&-match--embedding/get-the-config-for-the-logged-in-users-embeddable-job-description-search-tool.md): Return configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc. - [Get the config for the logged in user's embeddable resume search tool](https://docs.affinda.com/api-reference/search-&-match--embedding/get-the-config-for-the-logged-in-users-embeddable-resume-search-tool.md): Return configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc. - [Update the config for the logged in user's embeddable job description search tool](https://docs.affinda.com/api-reference/search-&-match--embedding/update-the-config-for-the-logged-in-users-embeddable-job-description-search-tool.md): Update configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc. - [Update the config for the logged in user's embeddable resume search tool](https://docs.affinda.com/api-reference/search-&-match--embedding/update-the-config-for-the-logged-in-users-embeddable-resume-search-tool.md): Update configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc. - [Create a new index](https://docs.affinda.com/api-reference/search-&-match--indexing/create-a-new-index.md): Create an index for the search tool - [Delete an index](https://docs.affinda.com/api-reference/search-&-match--indexing/delete-an-index.md): Deletes the specified index from the database - [Delete an indexed document](https://docs.affinda.com/api-reference/search-&-match--indexing/delete-an-indexed-document.md): Delete the specified indexed document from the database - [Get indexed documents for a specific index](https://docs.affinda.com/api-reference/search-&-match--indexing/get-indexed-documents-for-a-specific-index.md): Returns all the indexed documents for that index - [Get list of all indexes](https://docs.affinda.com/api-reference/search-&-match--indexing/get-list-of-all-indexes.md): Returns all the indexes - [Index a new document](https://docs.affinda.com/api-reference/search-&-match--indexing/index-a-new-document.md): Create an indexed document for the search tool - [Update an index](https://docs.affinda.com/api-reference/search-&-match--indexing/update-an-index.md): Updates the specified index - [Get job title suggestions based on provided job title(s)](https://docs.affinda.com/api-reference/search-&-match--searching/get-job-title-suggestions-based-on-provided-job-titles.md): Provided one or more job titles, get related suggestions for your search. - [Get search result of specific job description](https://docs.affinda.com/api-reference/search-&-match--searching/get-search-result-of-specific-job-description.md): This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this job description. The `identifier` is the unique ID returned via the [/job_description_search](#post-/job_description_search) endpoint. - [Get search result of specific resume](https://docs.affinda.com/api-reference/search-&-match--searching/get-search-result-of-specific-resume.md): This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this resume. The `identifier` is the unique ID returned via the [/resume_search](#post-/resume_search) endpoint. - [Get skill suggestions based on provided skill(s)](https://docs.affinda.com/api-reference/search-&-match--searching/get-skill-suggestions-based-on-provided-skills.md): Provided one or more skills, get related suggestions for your search. - [List occupation groups](https://docs.affinda.com/api-reference/search-&-match--searching/list-occupation-groups.md): Returns the list of searchable occupation groups. - [Match a single resume and job description](https://docs.affinda.com/api-reference/search-&-match--searching/match-a-single-resume-and-job-description.md): Get the matching score between a resume and a job description. The score ranges between 0 and 1, with 0 being not a match at all, and 1 being perfect match.
Note, this score will not directly match the score returned from POST [/resume_search/details/{identifier}](#post-/resume_search/details/-… - [Search through parsed job descriptions](https://docs.affinda.com/api-reference/search-&-match--searching/search-through-parsed-job-descriptions.md): Searches through parsed job descriptions. You can search with custom criterias or a resume. - [Search through parsed resumes](https://docs.affinda.com/api-reference/search-&-match--searching/search-through-parsed-resumes.md): Searches through parsed resumes. Users have 3 options to create a search:

1. Match to a job description - a parsed job description is used to find candidates that suit it
2. Match to a resume - a parsed resume is used to find other candidates that have similar attributes
3. S… - [Create a document from raw data](https://docs.affinda.com/api-reference/search-&-match/create-a-document-from-raw-data.md): Creates a document directly from structured resume or job description data for use in Search & Match functionality. This endpoint is specifically designed for programmatic document creation without file uploads.
If you want to upload a document with a file or URL, see the main [POST /v3/documen… - [Create a new index](https://docs.affinda.com/api-reference/search-&-match/create-a-new-index.md): Create an index for the search tool - [Create a signed URL for the embeddable job description search tool](https://docs.affinda.com/api-reference/search-&-match/create-a-signed-url-for-the-embeddable-job-description-search-tool.md): Create and return a signed URL of the job description search tool which then can be embedded on a web page. An optional parameter `config_override` can be passed to override the user-level configurations of the embeddable search tool. - [Create a signed URL for the embeddable resume search tool](https://docs.affinda.com/api-reference/search-&-match/create-a-signed-url-for-the-embeddable-resume-search-tool.md): Create and return a signed URL of the resume search tool which then can be embedded on a web page. An optional parameter `config_override` can be passed to override the user-level configurations of the embeddable resume search tool. - [Delete an index](https://docs.affinda.com/api-reference/search-&-match/delete-an-index.md): Deletes the specified index from the database - [Delete an indexed document](https://docs.affinda.com/api-reference/search-&-match/delete-an-indexed-document.md): Delete the specified indexed document from the database - [Get indexed documents for a specific index](https://docs.affinda.com/api-reference/search-&-match/get-indexed-documents-for-a-specific-index.md): Returns all the indexed documents for that index - [Get job title suggestions based on provided job title(s)](https://docs.affinda.com/api-reference/search-&-match/get-job-title-suggestions-based-on-provided-job-titles.md): Provided one or more job titles, get related suggestions for your search. - [Get list of all indexes](https://docs.affinda.com/api-reference/search-&-match/get-list-of-all-indexes.md): Returns all the indexes - [Get search result of specific job description](https://docs.affinda.com/api-reference/search-&-match/get-search-result-of-specific-job-description.md): This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this job description. The `identifier` is the unique ID returned via the [/job_description_search](#post-/job_description_search) endpoint. - [Get search result of specific resume](https://docs.affinda.com/api-reference/search-&-match/get-search-result-of-specific-resume.md): This contains more detailed information about the matching score of the search criteria, or which search criteria is missing in this resume. The `identifier` is the unique ID returned via the [/resume_search](#post-/resume_search) endpoint. - [Get skill suggestions based on provided skill(s)](https://docs.affinda.com/api-reference/search-&-match/get-skill-suggestions-based-on-provided-skills.md): Provided one or more skills, get related suggestions for your search. - [Get the config for the logged in user's embeddable job description search tool](https://docs.affinda.com/api-reference/search-&-match/get-the-config-for-the-logged-in-users-embeddable-job-description-search-tool.md): Return configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc. - [Get the config for the logged in user's embeddable resume search tool](https://docs.affinda.com/api-reference/search-&-match/get-the-config-for-the-logged-in-users-embeddable-resume-search-tool.md): Return configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc. - [Index a new document](https://docs.affinda.com/api-reference/search-&-match/index-a-new-document.md): Create an indexed document for the search tool - [List occupation groups](https://docs.affinda.com/api-reference/search-&-match/list-occupation-groups.md): Returns the list of searchable occupation groups. - [Match a single resume and job description](https://docs.affinda.com/api-reference/search-&-match/match-a-single-resume-and-job-description.md): Get the matching score between a resume and a job description. The score ranges between 0 and 1, with 0 being not a match at all, and 1 being perfect match.
Note, this score will not directly match the score returned from POST [/resume_search/details/{identifier}](#post-/resume_search/details/-… - [Re-index a document](https://docs.affinda.com/api-reference/search-&-match/re-index-a-document.md): Re-index a document. This is relevant if you updated the document's data via the /annotations endpoint, and want to refresh the document's data in the search index. - [Search through parsed job descriptions](https://docs.affinda.com/api-reference/search-&-match/search-through-parsed-job-descriptions.md): Searches through parsed job descriptions. You can search with custom criterias or a resume. - [Search through parsed resumes](https://docs.affinda.com/api-reference/search-&-match/search-through-parsed-resumes.md): Searches through parsed resumes. Users have 3 options to create a search:

1. Match to a job description - a parsed job description is used to find candidates that suit it
2. Match to a resume - a parsed resume is used to find other candidates that have similar attributes
3. S… - [Update a document's data](https://docs.affinda.com/api-reference/search-&-match/update-a-documents-data.md): Update data of a document. Only applicable for resumes and job descriptions. For other document types, please use the `PATCH /annotations/{id}` endpoint or the `POST /annotations/batch_update` endpoint. - [Update an index](https://docs.affinda.com/api-reference/search-&-match/update-an-index.md): Updates the specified index - [Update the config for the logged in user's embeddable job description search tool](https://docs.affinda.com/api-reference/search-&-match/update-the-config-for-the-logged-in-users-embeddable-job-description-search-tool.md): Update configurations such as which fields can be displayed in the logged in user's embeddable job description search tool, what are their weights, what is the maximum number of results that can be returned, etc. - [Update the config for the logged in user's embeddable resume search tool](https://docs.affinda.com/api-reference/search-&-match/update-the-config-for-the-logged-in-users-embeddable-resume-search-tool.md): Update configurations such as which fields can be displayed in the logged in user's embeddable resume search tool, what are their weights, what is the maximum number of results that can be returned, etc. - [Add a tag to documents](https://docs.affinda.com/api-reference/tags/add-a-tag-to-documents.md): Add a tag to documents. Tags are used to group documents together. Tags can be used to filter documents. - [Create a tag](https://docs.affinda.com/api-reference/tags/create-a-tag.md): Create a tag - [Delete an tag](https://docs.affinda.com/api-reference/tags/delete-an-tag.md): Deletes the specified tag from the database. - [Get list of all tags](https://docs.affinda.com/api-reference/tags/get-list-of-all-tags.md): Returns your tags. - [Get specific tag](https://docs.affinda.com/api-reference/tags/get-specific-tag.md): Return a specific tag. - [Remove a tag from documents](https://docs.affinda.com/api-reference/tags/remove-a-tag-from-documents.md): Remove a tag from documents. - [Update a tag](https://docs.affinda.com/api-reference/tags/update-a-tag.md): Update data of an tag. - [Get usage](https://docs.affinda.com/api-reference/usage/get-usage.md): Returns daily credits consumption for an organization over a date range. Optionally scope the report to a single workspace or document type. `workspace` and `document_type` cannot be combined: usage data is aggregated independently along each axis, so a per-(workspace × document type) slice is not a… - [Batch create validation results](https://docs.affinda.com/api-reference/validation-results/batch-create-validation-results.md): Batch create validation results. - [Batch delete validation results](https://docs.affinda.com/api-reference/validation-results/batch-delete-validation-results.md): Batch delete validation results - [Create a validation result](https://docs.affinda.com/api-reference/validation-results/create-a-validation-result.md): Create a validation result. - [Delete a validation result](https://docs.affinda.com/api-reference/validation-results/delete-a-validation-result.md): Remove validation result. - [Get list of all validation results](https://docs.affinda.com/api-reference/validation-results/get-list-of-all-validation-results.md): Returns the validation results of a document. - [Get specific validation result](https://docs.affinda.com/api-reference/validation-results/get-specific-validation-result.md): Return a specific validation result. - [Update a validation result](https://docs.affinda.com/api-reference/validation-results/update-a-validation-result.md): Update a validation result. - [Activate a resthook subscription](https://docs.affinda.com/api-reference/webhook-api/activate-a-resthook-subscription.md): After creating a subscription, we'll send a POST request to your target URL with a `X-Hook-Secret` header. You should response to this with a 200 status code, and use the value of the `X-Hook-Secret` header that you received to activate the subscription using this endpoint. - [Create a resthook subscription](https://docs.affinda.com/api-reference/webhook-api/create-a-resthook-subscription.md): After a subscription is successfully created, we'll send a POST request to your target URL with a `X-Hook-Secret` header.
You need to response to this request with a 200 status code to confirm your subscribe intention.
Then, you need to use the `X-Hook-Secret` to activate the subscript… - [Delete a resthook subscription](https://docs.affinda.com/api-reference/webhook-api/delete-a-resthook-subscription.md): Deletes the specified resthook subscription from the database. - [Get list of all resthook subscriptions](https://docs.affinda.com/api-reference/webhook-api/get-list-of-all-resthook-subscriptions.md): Returns your resthook subscriptions. - [Get specific resthook subscription](https://docs.affinda.com/api-reference/webhook-api/get-specific-resthook-subscription.md): Return a specific resthook subscription. - [Update a resthook subscription](https://docs.affinda.com/api-reference/webhook-api/update-a-resthook-subscription.md): Update data of a resthook subscription. - [Activate a resthook subscription](https://docs.affinda.com/api-reference/webhooks/activate-a-resthook-subscription.md): After creating a subscription, we'll send a POST request to your target URL with a `X-Hook-Secret` header.
You should response to this with a 200 status code, and use the value of the `X-Hook-Secret` header that you received to activate the subscription using this endpoint. - [Create a resthook subscription](https://docs.affinda.com/api-reference/webhooks/create-a-resthook-subscription.md): After a subscription is successfully created, we'll send a POST request to your target URL with a `X-Hook-Secret` header.
You need to response to this request with a 200 status code to confirm your subscribe intention.
Then, you need to use the `X-Hook-Secret` to activate the subscript… - [Delete a resthook subscription](https://docs.affinda.com/api-reference/webhooks/delete-a-resthook-subscription.md): Deletes the specified resthook subscription from the database. - [Get list of all resthook subscriptions](https://docs.affinda.com/api-reference/webhooks/get-list-of-all-resthook-subscriptions.md): Returns your resthook subscriptions. - [Get specific resthook subscription](https://docs.affinda.com/api-reference/webhooks/get-specific-resthook-subscription.md): Return a specific resthook subscription. - [Update a resthook subscription](https://docs.affinda.com/api-reference/webhooks/update-a-resthook-subscription.md): Update data of a resthook subscription. - [Create a workspace](https://docs.affinda.com/api-reference/workspaces/create-a-workspace.md): Create a workspace - [Delete a workspace](https://docs.affinda.com/api-reference/workspaces/delete-a-workspace.md): Deletes the specified workspace from the database. - [Get list of all workspaces](https://docs.affinda.com/api-reference/workspaces/get-list-of-all-workspaces.md): Returns your workspaces. - [Get specific workspace](https://docs.affinda.com/api-reference/workspaces/get-specific-workspace.md): Return a specific workspace. - [Update a workspace](https://docs.affinda.com/api-reference/workspaces/update-a-workspace.md): Update a workspace. - [Billing, credits, and payment options](https://docs.affinda.com/billing.md): Overview of Affinda's credit-based pricing, payment methods, invoicing, and enterprise billing options for document parsing and extraction usage. - [Checkboxes](https://docs.affinda.com/configuration/checkboxes.md): Capture selected and unselected options from forms with checkbox fields in Affinda, including configuration options for grouped and individual checkboxes. - [Document Classification](https://docs.affinda.com/configuration/classification.md): Configure Affinda's document classification to automatically route incoming files into the correct document type for downstream extraction and workflows. - [Confidence](https://docs.affinda.com/configuration/confidence.md): Understand how Affinda calculates field-level and document-level confidence scores, and how to use them to drive automation and validation rules. - [Document Status](https://docs.affinda.com/configuration/document-status.md): Reference for every document status in Affinda, including processing, ready for review, validated, and rejected, and how documents move between them. - [Remove duplicate documents](https://docs.affinda.com/configuration/duplicates.md): Configure Affinda's de-duplication to detect and remove duplicate documents during ingestion, keeping your workflows clean and avoiding double-processing. - [Upload documents via email](https://docs.affinda.com/configuration/email-upload.md): Configure a dedicated inbox to upload documents to Affinda via email, including handling attachments, sender allowlists, and routing to document types. - [Data Export](https://docs.affinda.com/configuration/export-data.md): Compare the available ways to export extracted data from Affinda, including the API, webhooks, integration agent, CSV downloads, and direct integrations. - [General Field Configuration](https://docs.affinda.com/configuration/field-configuration.md): Configure field properties in Affinda such as data types, required flags, default values, and parsing rules so extracted data matches your downstream schema. - [Glossary of Terms](https://docs.affinda.com/configuration/glossary.md): This is the Affinda glossary of terms, providing brief definitions of the key concepts and acronyms used across our documentation. - [Configure table and group fields](https://docs.affinda.com/configuration/group-table-fields.md): Use group and table field types in Affinda to extract repeated structured data such as line items, transactions, and nested objects from your documents. - [Image fields and signature extraction](https://docs.affinda.com/configuration/images.md): Use image field types in Affinda to extract logos, signatures, photos, and other visual elements as cropped images alongside text data from documents. - [Document Ingestion Options](https://docs.affinda.com/configuration/ingestion.md): Compare ingestion options for sending documents to Affinda, including the web app, API, email upload, and direct integrations with cloud storage providers. - [Configure the Integrations Agent](https://docs.affinda.com/configuration/integration-agent.md): Configure the Affinda Integrations Agent to build no-code data export integrations with downstream systems using natural language instructions. - [Overview of Machine Validation](https://docs.affinda.com/configuration/machine-validation.md): Use Affinda's machine validation to automatically approve high-confidence documents and route low-confidence cases to human reviewers for full automation. - [Model Memory](https://docs.affinda.com/configuration/model-memory.md): Learn how Affinda's Model Memory feature uses past corrections to improve extraction accuracy over time without requiring full model retraining. - [OCR and Text Extraction](https://docs.affinda.com/configuration/ocr.md): Learn how Affinda performs OCR (optical character recognition) and text extraction across PDFs, scans, and images, including supported languages and quality. - [Picklist Fields](https://docs.affinda.com/configuration/picklists.md): Configure picklist fields in Affinda to constrain extracted values to a fixed list of options, including hard-coded, dynamic, and API-driven picklists. - [Pre-Processing Overview](https://docs.affinda.com/configuration/preprocessing.md): Overview of pre-processing steps Affinda applies to incoming documents, including format conversion, deskewing, OCR, splitting, and classification. - [Document Redaction](https://docs.affinda.com/configuration/redaction.md): Configure document redaction in Affinda to mask or remove sensitive data such as PII before exporting redacted versions of documents downstream. - [Document Splitting](https://docs.affinda.com/configuration/splitting.md): Configure Affinda's automatic document splitting to break up multi-document PDFs into individual files for separate classification and extraction. - [Standard Data Types](https://docs.affinda.com/configuration/standard-fields.md): Reference for Affinda's standard data types including text, number, date, currency, and boolean, with parsing rules and supported formats for each. - [User Management and Permissions](https://docs.affinda.com/configuration/user-management.md): Manage users, roles, and permissions in the Affinda app to control who can upload documents, validate extractions, configure models, and export data. - [User Validation](https://docs.affinda.com/configuration/user-validation.md): Review and correct extracted data in the Affinda document validation interface, including keyboard shortcuts, side-by-side viewing, and bulk approval. - [Validation Rules](https://docs.affinda.com/configuration/validation-rules.md): Apply custom validation rules in Affinda to enforce business logic on extracted data, flag errors before export, and gate documents for human review. - [Configure your document workflow](https://docs.affinda.com/configuration/workflow.md): Configure each step in the Affinda document workflow, including ingestion, splitting, classification, extraction, validation, and export rules. - [Data retention policies and controls](https://docs.affinda.com/data-retention.md): Configure how long Affinda retains uploaded documents and extracted data, including retention periods, deletion controls, and compliance considerations. - [Deployment and Data Residency](https://docs.affinda.com/deployment-data-residency.md): Affinda's regional server locations, data residency controls, and enterprise deployment options for AU, EU, and US data sovereignty requirements. - [Error glossary and troubleshooting](https://docs.affinda.com/error-glossary.md): Reference for common Affinda API and platform errors, including likely causes and recommended fixes for upload, parsing, and validation failures. - [Frequently asked questions](https://docs.affinda.com/faqs.md): Answers to common questions about the Affinda platform, including pricing, supported document types, accuracy, integrations, and security practices. - [Welcome to Affinda Docs](https://docs.affinda.com/home.md): Guides, tutorials, and API reference for the Affinda document AI platform, covering extraction models, validation, integrations, and best practices. - [API authentication with rotatable keys](https://docs.affinda.com/reference/authentication.md): Authenticate requests to the Affinda API using rotatable API keys, including how to generate, rotate, and revoke keys for production and test environments. - [Client Libraries](https://docs.affinda.com/reference/client-libraries.md): Use Affinda's open-source client libraries to integrate the API quickly from Python, JavaScript, TypeScript, .NET, and Java applications. - [Embed the Affinda validation interface](https://docs.affinda.com/reference/embedded.md): Embed the Affinda document validation interface inside your own application using iframes or SSO, including configuration options and authentication tokens. - [API quick start guide](https://docs.affinda.com/reference/getting-started.md): Quick start for the Affinda API: create an API key, upload your first document, retrieve extracted data, and integrate the response into your application. - [API volume, file size, and rate limits](https://docs.affinda.com/reference/limits.md): Reference for Affinda's API rate limits, file size and page limits, supported file types, and concurrent upload thresholds for parsing and extraction. - [Metadata](https://docs.affinda.com/reference/metadata.md): Reference for field and document metadata returned in the Affinda API response, including bounding boxes, page numbers, parsed values, and confidence scores. - [Structured Outputs](https://docs.affinda.com/reference/pydantic-models.md): Generate structured outputs using Pydantic models from your document types and ensure type-safe validation of Affinda API responses. - [Generate TypeScript interfaces](https://docs.affinda.com/reference/typescript-interfaces.md): Auto-generate TypeScript interfaces from your Affinda document types for type-safe consumption of API responses in JavaScript and TypeScript projects. - [Document upload options for the API](https://docs.affinda.com/reference/upload-options.md): Compare options for uploading documents to the Affinda API, including multipart file uploads, URL-based ingestion, base64 payloads, and async processing. - [Webhooks](https://docs.affinda.com/reference/webhooks.md): Configure webhooks to receive event notifications from Affinda when documents are uploaded, parsed, validated, or rejected, including signature verification. - [Additional Affinda resources and links](https://docs.affinda.com/resources.md): Find additional resources for the Affinda platform, including product updates, the trust center, status page, billing information, and the error glossary. - [Search and Match scoring algorithm](https://docs.affinda.com/resumes/algorithm.md): How Affinda's Search & Match algorithm scores candidates against jobs, including the weighting of skills, experience, education, and location signals. - [Resume parsing credits and pricing](https://docs.affinda.com/resumes/credits.md): How resume parsing credits work in Affinda, including how credits are consumed per document, how to purchase top-ups, and how to monitor credit usage. - [Resume Parser data fields reference](https://docs.affinda.com/resumes/data-extracted.md): Comprehensive reference for fields extracted by Affinda's Resume Parser, including personal details, work history, education, skills, certifications, and more. - [Getting Started](https://docs.affinda.com/resumes/getting-started.md): The information in this section is focused on Affinda products that serve the Recruitment Technology industry, including our Resume Parser. - [Index candidate and job data for search](https://docs.affinda.com/resumes/indexing-data.md): Add candidates and jobs to an Affinda index so the data is available for Search & Match queries, including index management and update operations. - [Integrate Affinda's Resume Parser](https://docs.affinda.com/resumes/integration.md): Integrate Affinda's Resume Parser into your ATS, recruitment platform, or HR system using the API, webhooks, and client libraries with code examples. - [Job Description Parser](https://docs.affinda.com/resumes/job-description-parser.md): Overview of Affinda's Job Description Parser, including the list of fields extracted from job postings such as title, requirements, skills, and salary. - [Resume Redactor](https://docs.affinda.com/resumes/resume-redactor.md): How Affinda's Resume Redactor removes personal and demographic data from resumes to support unbiased recruitment, including the list of redactable fields. - [Resume Summary](https://docs.affinda.com/resumes/resume-summary.md): Generate AI-powered candidate summaries from parsed resumes with Affinda Resume Summary, including configuration options and supported output formats. - [Self-hosted deployment for Resume Parser](https://docs.affinda.com/resumes/self-hosted.md): Run Affinda's Resume Parser in a self-hosted or on-premises deployment, including infrastructure requirements, licensing, and operational considerations. - [Taxonomies](https://docs.affinda.com/resumes/taxonomies.md): Affinda's Resume Parser uses pre-built taxonomies to standardize key fields like skills, making data more accurate and consistent across your systems. - [Affinda system status and uptime](https://docs.affinda.com/status.md): Check the live status of Affinda services, view incident history, scheduled maintenance windows, and uptime reports for the platform and API. - [Trust center, security, and compliance](https://docs.affinda.com/trust.md): Review Affinda's trust center for security policies, compliance certifications, data protection practices, and answers to common procurement questions. - [Product Updates](https://docs.affinda.com/updates.md): Release notes for the Affinda platform, including new features, improvements, and bug fixes for extraction models, validation, integrations, and the API. ## OpenAPI Specs - [api_spec](https://api.affinda.com/static/v3/api_spec.yaml)