Required Match Fields

The entities specified within the requiredMatchFields parameter of the Search and Match API request are considered as mandatory criteria for searching and matching, with an 'AND' condition applied between the entities.

The API returns only those documents that matches the entities mentioned in the requiredMatchFields parameter. The entities other than those specified in the requiredMatchFields parameter are considered as optional, and an 'OR' condition is applied in the others entities. The weightage for the entities are calculated as per dynamic weightage defined for the userkey.

Note: See below sample requests for the entities that can be passed within the requiredMatchFields parameter.

The requiredMatchFields is an optional parameter (query) that can be passed in the API request of Simple Search, Match, Match with ID, Match with Multiple Sub-User Ids, and One To One Match.

Sample Request for Matching

Below is the sample API request for Match, Match with ID, Match with Multiple Sub-User Ids, and One To One Match.

For Doc type JD or matchType JD to Resume:

"requiredMatchFields": [
        "JobProfile",
        "Organization",
        "Skill",
        "Degree",
        "TotalExperienceRange",
        "JobLocationCity",
        "JobLocationState",
        "JobLocationCountry",
        "IndustryType",
        "Domains"
    ],

For Doc type Resume or matchType Resume to JD:

"requiredMatchFields": [
        "JobProfile",
        "Employer",
        "Skill",
        "Degree",
        "City",
        "State",
        "Country",
        "TotalExperienceInYear",
        "Category",
        "SubCategory"
    ],

Sample Request for Searching

Below is the sample API request for Simple Search.

Note: In the SimpleSearch the indexType is used for this feature. In the SimpleSearch:

For indexType Resume -> Category and SubCategory entities are not available.
For indexType JD -> Domains and IndustryType entities are not available.
If a query contains multiple values of one entity type (for example Java, Python, and PHP are skill type entity), then at least one value in the query must be matched with the required entity within requiredMatchFields parameter.

For indexType Resume:

"requiredMatchFields": [
        "JobProfile",
        "Employer",
        "Skill",
        "Degree",
        "City",
        "State",
        "Country",
        "TotalExperienceInYear"
    ],

For indexType JD:

"requiredMatchFields": [
        "JobProfile",
        "Organization",
        "Skill",
        "Degree",
        "TotalExperienceRange",
        "JobLocationCity",
        "JobLocationState",
        "JobLocationCountry"
    ],

Error Code


Error Code	Error Message
2119	Message: requiredMatchFields must be an array of string values
2120	Message: required match fields {field name} not available