How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Affinda

Affinda Search and Match API

Resume search, job description search, and matching across parsed-document indexes. Score candidates against a job description (or vice versa), retrieve match details, configure search and embed parameters, and request job-title and skill suggestions. Includes index management for organizing parsed documents and embeddable UI configuration for resume and JD search components.

Documentation Provider Profile APIs.io OpenAPI GitHub

Affinda Search and Match API is one of 16 APIs that Affinda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Search, Matching, Resume Search, Job Description Search, and Recruitment. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 24 operations across 19 paths, and defines 98 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against a single base URL, https://{region}.affinda.com.

24 operations 19 paths 98 schemas 2 DELETE8 GET3 PATCH11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Server
https://{region}.affinda.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Affinda Search and Match API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Basic authentication using an API key, e.g. {Authorization: Bearer aff0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings pag…

Paths & Operations 24

Across 19 paths, the API surfaces 24 operations — 2 DELETE, 8 GET, 3 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Search & Match 24
POST
/v3/documents/create_from_data
Create a document from raw data
createDocumentFromData 1 param body → 200201400401403default
POST
/v3/documents/{identifier}/update_data
Update a document's data
updateDocumentData 1 param body → 200400401default
GET
/v3/occupation_groups
List occupation groups
listOccupationGroups → 200400401default
POST
/v3/resume_search
Search through parsed resumes
createResumeSearch 2 params body → 201400401default
POST
/v3/resume_search/details/{identifier}
Get search result of specific resume
getResumeSearchDetail 1 param body → 200400401default
GET
/v3/resume_search/config
Get the config for the logged in user's embeddable resume search tool
getResumeSearchConfig → 200401default
PATCH
/v3/resume_search/config
Update the config for the logged in user's embeddable resume search tool
updateResumeSearchConfig body → 200400401default
POST
/v3/resume_search/embed
Create a signed URL for the embeddable resume search tool
createResumeSearchEmbedUrl body → 200401default
GET
/v3/resume_search/match
Match a single resume and job description
getResumeSearchMatch 13 params → 200400401default
GET
/v3/resume_search/suggestion_job_title
Get job title suggestions based on provided job title(s)
getResumeSearchSuggestionJobTitle 1 param → 200400401default
GET
/v3/resume_search/suggestion_skill
Get skill suggestions based on provided skill(s)
getResumeSearchSuggestionSkill 1 param → 200400401default
POST
/v3/job_description_search
Search through parsed job descriptions
createJobDescriptionSearch 2 params body → 201400401default
POST
/v3/job_description_search/details/{identifier}
Get search result of specific job description
getJobDescriptionSearchDetail 1 param body → 200400401default
GET
/v3/job_description_search/config
Get the config for the logged in user's embeddable job description search tool
getJobDescriptionSearchConfig → 200401default
PATCH
/v3/job_description_search/config
Update the config for the logged in user's embeddable job description search tool
updateJobDescriptionSearchConfig body → 200400401default
POST
/v3/job_description_search/embed
Create a signed URL for the embeddable job description search tool
createJobDescriptionSearchEmbedUrl body → 200401default
GET
/v3/index
Get list of all indexes
getAllIndexes 4 params → 200400401default
POST
/v3/index
Create a new index
createIndex body → 201400401default
PATCH
/v3/index/{name}
Update an index
updateIndex 1 param body → 200400401default
DELETE
/v3/index/{name}
Delete an index
deleteIndex 1 param → 204400401default
GET
/v3/index/{name}/documents
Get indexed documents for a specific index
getAllIndexDocuments 3 params → 200400401default
POST
/v3/index/{name}/documents
Index a new document
createIndexDocument 1 param body → 201400401default
DELETE
/v3/index/{name}/documents/{identifier}
Delete an indexed document
deleteIndexDocument 2 params → 204400401default
POST
/v3/index/{name}/documents/{identifier}/re_index
Re-index a document
reIndexDocument 2 params → 200400401default

Schemas 98

The contract defines 98 schemas that model the data the API accepts and returns. The most detailed are ResumeSearchParameters (39 properties), DocumentMeta (39 properties), JobDescriptionSearchParameters (30 properties), JobDescriptionSearchConfig (30 properties). Each schema is shown below with its type and property counts.

Identifier
string
A random string that uniquely identify the resource.
CustomFieldConfig
object
2 properties 2 required
DocumentError
object
2 properties
ResumeSearchDetail
object
9 properties
ExpectedRemunerationAnnotation
objectnull
OccupationGroupSearchScoreComponent
object
3 properties 1 required
JobTitleAnnotation
objectnull
ResumeSearchParametersCustomData
object
ValidationRule
object
A validation rule for a collection
2 properties 2 required
Index
object
3 properties 3 required
ResumeSearchMatch
object
2 properties
ResumeSearchParametersSkill
object
2 properties
OccupationGroup
object
3 properties 3 required
LocationSearchScoreComponent
object
3 properties 1 required
docType
string
ResumeData
objectnull
A JSON-encoded string of the ResumeData object.
25 properties
email
string
LanguagesSearchScoreComponent
object
3 properties 1 required
DocumentMeta_properties-identifier
string
Unique identifier for the document
properties-id
integer
Uniquely identify a user.
LanguageAnnotation
objectnull
DateAnnotation
objectnull
SkillsSearchScoreComponent
object
3 properties 1 required
Annotation
objectnull
16 properties 13 required
errorDetail
stringnull
JobDescriptionSearch
object
5 properties
LanguageAnnotationUpdate
objectnull
DocumentCreateFromData
object
1 property 1 required
JobTitleSearchScoreComponent
object
3 properties 1 required
JobDescriptionSearchDetail
object
9 properties
customIdentifier
stringnull
Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique.
identifier
string
Uniquely identify a workspace.
EducationSearchScoreComponent
object
3 properties 1 required
JobDescriptionDataUpdate
objectnull
A JSON-encoded string of the JobDescriptionData object.
17 properties
ResumeSearchParameters
object
39 properties 1 required
JobDescriptionSearchResult
object
14 properties 13 required
errorCode
stringnull
RegionBias
objectnull
4 properties
properties-identifier
string
Uniquely identify a collection.
ResumeSearchConfig
object
30 properties
IndexCreate
object
2 properties 1 required
validatable
boolean
name
string
OccupationGroupSearchResult
object
5 properties 2 required
JobTitleParsed
object
1 property
IndexUser
object
The user who created this index
4 properties 4 required
EducationLevel
stringnull
Document
object
5 properties 2 required
DocumentWarning
object
2 properties
SkillAnnotationUpdate
objectnull
YearsExperienceAnnotationUpdate
objectnull
properties-avatar
stringnull
URL of the user's avatar.
ThemeConfig
object
4 properties
TextAnnotationUpdate
objectnull
LocationAnnotationUpdate
objectnull
LocationAnnotation
objectnull
Index_properties-name
string
Unique index name
Rectangle
object
5 properties 4 required
User
object
5 properties
Tag
object
4 properties 4 required
ResumeSearchEmbed
object
1 property
Extractor_properties-identifier
string
Uniquely identify an extractor.
PaginatedResponse
object
3 properties 1 required
SearchExpressionSearchScoreComponent
object
3 properties 1 required
YearsExperienceAnnotation
objectnull
ManagementLevelSearchScoreComponent
object
3 properties 1 required
SearchConfigAction
object
2 properties 2 required
SkillAnnotation
objectnull
PageMeta
object
7 properties 6 required
User_properties-name
string
IndexUpdate
object
1 property
FileName
stringnull
Optional filename of the file
PaletteColorOptions
object
4 properties 1 required
TextAnnotation
objectnull
ResumeSkill
object
5 properties
JobDescriptionSearchParameters
objectnull
30 properties 1 required
JobDescriptionSearchConfig
object
30 properties
ExpiryTime
stringnull
The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry.
Accreditation
objectnull
4 properties
Location
objectnull
14 properties 1 required
JobDescriptionSearchEmbed
object
1 property
UserNullable
objectnull
5 properties
ResumeSearchParametersLocation
object
4 properties
JobDescriptionData
objectnull
A JSON-encoded string of the JobDescriptionData object.
18 properties
JobTitleAnnotationUpdate
objectnull
AnnotationContentType
string
The different data types of annotations
DocumentMeta
object
39 properties 3 required
SearchParametersCustomData
object
6 properties 2 required
ExperienceSearchScoreComponent
object
3 properties 1 required
DateAnnotationUpdate
objectnull
ManagementLevel
stringnull
ResumeSearch
object
5 properties
AnnotationBase
objectnull
13 properties
CustomDataSearchScoreComponent
object
Education
object
6 properties
ExpectedRemunerationAnnotationUpdate
objectnull
ResumeSearchResult
object
14 properties 13 required
RequestError
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-search-match-api-openapi.yml Raw ↑

Other APIs Affinda publishes across the network.

Affinda Documents API
AE Profile APIs.io
Affinda Document Types API
AE Profile APIs.io
Affinda Workspaces API
AE Profile APIs.io
Affinda Organizations API
AE Profile APIs.io
Affinda Data Sources API
AE Profile APIs.io
Affinda Annotations API
AE Profile APIs.io
Affinda Validation Results API
AE Profile APIs.io
Affinda Tags API
AE Profile APIs.io
Affinda Usage API
AE Profile APIs.io
Affinda Webhooks API
AE Profile APIs.io
Affinda Add x-hidden to endpoints API
AE Profile APIs.io
Affinda Deprecated End Points API
AE Profile APIs.io
#Search#Matching#Resume Search#Job Description Search#Recruitment
← Back to A APIs
API Details
ID
affinda:affinda-search-match-api
Server
https://{region}.affinda.com
Docs
https://docs.affinda.com/reference
Provider
Affinda
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=affinda-search-match-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/affinda-search-match-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Affinda Search and Match API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.