> ## Documentation Index
> Fetch the complete documentation index at: https://docs.affinda.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search and Match product overview

> Overview of Affinda's Search & Match product for ranking candidates against jobs, including the available variations and workflow guidance for getting started.

Affinda's Search & Match is a flexible and transparent solution designed to transform how recruiters find the right candidates for job openings. Affinda's Search & Match solution can be integrated with Affinda's industry-leading Resume Parser and Job Description Parser products, or users can incorporate their candidate database and search parameters.

<div className="relative w-full pb-[calc(56.22457282343368%+41px)] h-0">
  <iframe src="https://demo.arcade.software/40I4Pj21H3mPAgAvKVkE?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Affinda Candidate Match" loading="lazy" allow="clipboard-write" allowFullScreen className="absolute left-0 top-0 h-full w-full" style={{ colorScheme:"light" }} />
</div>

## Types of matching

### Candidate Matching

* **Search by Job Description** - search an index of candidate resume data against a single job description to find the best candidates for a given role
* **Find Similar Candidates** - search an index of candidate resume data against a single candidate to find similar candidates

### Job Matching

Search an index of job descriptions against a single candidate to find the best role for a given candidate

### Profile Scoring

Returns a single score assessing the match of a single candidate with a single job description

## Using Search & Match

1. Create an index
2. Add resumes or job descriptions to the index
3. Search the index either via API or using the Affinda Search Interface
4. The search query can be created automatically using a resume or job description or manually using a custom query
5. (optional) Adjust category weights and query elements

## Integrating Search & March

There are two ways that customers can use the Search & Match product.

### **Option 1: Embedding the Affinda Search UI**

Affinda's Search Interface can be customised and embedded within recruitment platforms and job boards. A customised and signed URL is generated by our API which can then be added securely to your platform as an iFrame. Each URL is valid for 60 minutes.

Generating a URL to be embedded within your platform is a two-step process

1. Configure your Search UI using the following endpoints: [<u>for Candidate Search</u>](https://docs.affinda.com/api-reference/search-&-match/update-the-config-for-the-logged-in-users-embeddable-resume-search-tool) and [<u>for Job Search</u>](https://docs.affinda.com/api-reference/search-&-match/update-the-config-for-the-logged-in-users-embeddable-job-description-search-tool)
2. Generate a URL using the following endpoints: [<u>for Candidate Search</u>](https://docs.affinda.com/api-reference/search-&-match/create-a-signed-url-for-the-embeddable-resume-search-tool) and [<u>for Job Search</u>](https://docs.affinda.com/api-reference/search-&-match/create-a-signed-url-for-the-embeddable-job-description-search-tool)

Embedded URLs expire after 60 minutes, and users can create an event to refresh the link to ensure it is active within your platform. They will use the config settings at the time when they are generated. That means if you change the config, you need to generate a new URL for the changes to be effective.

Optionally, you can override the config directly when generating a URL by including `configOverride` in the body:

```
{
  "configOverride": {...}
}
```

Further information about customising the Search UI can be found [here](/resumes/search-interface).

<Warning>
  The Search interface is available via the Affinda app for customer testing; however, it is not designed to be used in a production environment. Customers looking to use the UI should embed this within downstream platforms.
</Warning>

### **Option 2: Using the Search API**

For customers who have an existing interface or want to build their own, they can choose to use Search & Match via API. The same API that powers our UI is available to receive the results in JSON format. Customers can set their own query in the request and receive the results back, which can then be surfaced through their own platform.

The following endpoints are used for searching via API:

* [Candidate Search](https://docs.affinda.com/api-reference/search-&-match/search-through-parsed-resumes)
* [Job Search](https://docs.affinda.com/api-reference/search-&-match/search-through-parsed-job-descriptions)
* [Profile Scoring](https://docs.affinda.com/api-reference/search-&-match/match-a-single-resume-and-job-description)