AI Matching
AI matching FitScore provides a concise assessment indicating how well a candidate aligns with a job based on their skills, experience, and qualifications.
post
copied!# You can also use wgetcurl -X POST https://api-qa.phenompro.com/ai-matching/v1/candidates/job-fitscore
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'POST /ai-matching/v1/candidates/job-fitscore
This API provides fitscore of a profile with respect to a job.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
Body Parameter
copied![
{
"type": "object",
"description": "Request object to get fitscore results.",
"properties": {
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"default": "external",
"description": "Persona Value - Example: Internal, External."
},
"userId": {
"type": "string",
"description": "User id of a job."
},
"userProfile": {
"UserProfileFitScore": {
"type": "object",
"description": "It contains user profile details.",
"properties": {
"skills": {
"type": "array",
"description": "User's skills.",
"items": {
"type": "string",
"description": "List of skills."
}
},
"title": {
"type": "string",
"description": "Title of a job."
},
"yearsOfExperience": {
"type": "string",
"description": "Users's years of experience.",
"example": "0-5"
},
"preferredLocations": {
"type": "array",
"description": "Users's preferred locations.",
"items": {
"PreferredLocations": {
"type": "object",
"description": "It has details of preferred location.",
"properties": {
"location": {
"type": "string",
"description": "Preferred location name."
},
"latlong": {
"type": "object",
"description": "Latitude and longitude of preferred location.",
"properties": {
"lon": {
"type": "number",
"format": "double",
"description": "Longitude of preferred location."
},
"lan": {
"type": "number",
"format": "double",
"description": "Latitude of preferred location."
}
}
}
}
}
}
}
}
}
},
"jobIds": {
"type": "array",
"description": "Job ids to check fitscore.",
"items": {
"type": "string",
"description": "List of Job IDs."
}
}
}
}
]Request Parameters
| Type | Name |
|---|---|
| application/json | FitScoreRequest |
Response
200 response
copied![
{
"type": "object",
"description": "Fitscore Response.",
"properties": {
"status": {
"type": "integer",
"description": "Status code of response.",
"default": "200"
},
"result": {
"type": "array",
"description": "Obtained results.",
"items": {
"type": "object",
"description": "Results of fitscore.",
"properties": {
"jobId": {
"type": "string",
"description": "Job Id for which fitscore is calculated."
},
"fitLevel": {
"type": "string",
"description": "Shows how well the user fits the job."
},
"titleFit": {
"type": "string",
"description": "Shows how well the user title fits the job."
},
"skillFit": {
"type": "string",
"description": "Shows how well the user skills fits the job."
},
"experienceFit": {
"type": "string",
"description": "Shows how well the user experience fits the job."
},
"locationFit": {
"type": "string",
"description": "Shows how well the user location fits the job."
},
"skillGap": {
"type": "object",
"description": "Evaluates user skills.",
"properties": {
"exactMatch": {
"type": "array",
"description": "Exact Matched Skills.",
"items": {
"type": "string",
"description": "List of skills which matched exactly."
}
},
"semanticMatch": {
"type": "array",
"description": "Semantically Matched Skills.",
"items": {
"type": "string",
"description": "List of skills which matched semantically."
}
},
"noMatch": {
"type": "array",
"description": "UnMatched Skills.",
"items": {
"type": "string",
"description": "List of skills which are unmatched."
}
}
}
}
}
}
}
}
}
]Bad Request
copied![
{
"type": "object",
"description": "Fitscore bad request details.",
"properties": {
"status": {
"type": "integer",
"description": "Status code of bad request."
},
"message": {
"type": "string",
"description": "Bad request message."
}
}
}
]Server Error
copied![
{
"type": "object",
"description": "Error Response.",
"properties": {
"status": {
"type": "integer",
"description": "Status code of encountered error."
},
"message": {
"type": "string",
"description": "Encountered error message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | 200 response | FitscoreResponse |
| 400 | Bad Request | FitscoreBadRequest |
| 500 | Server Error | ErrorResponse |
get
copied!# You can also use wgetcurl -X GET https://api-qa.phenompro.com/ai-matching/v1/candidates/{candidateId}/jobs/{jobId}/matching-skills
-H 'Content-type: application/json'
-H 'Accept: application/json'
-H 'Authorization: string'
-H 'x-ph-userId: string'GET /ai-matching/v1/candidates/{candidateId}/jobs/{jobId}/matching-skills
This API returns exact matching skills between job and candidate.
Headers
| Name | In | Type | Required |
|---|---|---|---|
| Authorization | header | string | true |
| x-ph-userId | header | string | true |
Parameters
| Name | In | Type | Required |
|---|---|---|---|
| candidateId | path | string | true |
| jobId | path | string | true |
Response
OK response.
copied![
{
"type": "object",
"description": "Response of the given request.",
"properties": {
"matchingSkills": {
"type": "array",
"description": "List of matched skills.",
"items": {
"type": "string"
}
},
"matchingSkillsCount": {
"type": "integer",
"description": "Count of matched skills."
},
"unmatchingSkills": {
"type": "array",
"description": "List of unmatched skills.",
"items": {
"type": "string"
}
},
"unmatchingSkillsCount": {
"type": "integer",
"description": "Count of unmatched skills."
},
"totalJobSkills": {
"type": "integer",
"description": "Count of total job skills."
},
"status": {
"type": "string",
"description": "Status of fitscore processing."
}
}
}
]Bad Request.
copied![
{
"type": "object",
"description": "Required Parameters are missing to process the request.",
"properties": {
"ErrorResponseMessage": {
"type": "string",
"description": "Error Response Message."
}
}
}
]Internal Server Error.
copied![
{
"type": "object",
"description": "Issue in processing the request.",
"properties": {
"ErrorResponseMessage": {
"type": "string",
"description": "Error Response Message."
}
}
}
]Responses
| Status | Description | Schema |
|---|---|---|
| 200 | OK response. | SkillMatchingResponse |
| 400 | Bad Request. | SkillMatchingBadRequest |
| 500 | Internal Server Error. | SkillMatchingErrorResponse |
Schemas
copied!{
"type": "object",
"description": "It contains user profile details.",
"properties": {
"skills": {
"type": "array",
"description": "User's skills.",
"items": {
"type": "string",
"description": "List of skills."
}
},
"title": {
"type": "string",
"description": "Title of a job."
},
"yearsOfExperience": {
"type": "string",
"description": "Users's years of experience.",
"example": "0-5"
},
"preferredLocations": {
"type": "array",
"description": "Users's preferred locations.",
"items": {
"PreferredLocations": {
"type": "object",
"description": "It has details of preferred location.",
"properties": {
"location": {
"type": "string",
"description": "Preferred location name."
},
"latlong": {
"type": "object",
"description": "Latitude and longitude of preferred location.",
"properties": {
"lon": {
"type": "number",
"format": "double",
"description": "Longitude of preferred location."
},
"lan": {
"type": "number",
"format": "double",
"description": "Latitude of preferred location."
}
}
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| skills | [string] | User's skills. |
| title | string | Title of a job. |
| yearsOfExperience | string | Users's years of experience. |
| preferredLocations | array | PreferredLocations |
copied!{
"type": "object",
"description": "Request object to get fitscore results.",
"properties": {
"locale": {
"type": "string",
"description": "Locale of the site (Language_Country) - Example: en_US."
},
"siteType": {
"type": "string",
"default": "external",
"description": "Persona Value - Example: Internal, External."
},
"userId": {
"type": "string",
"description": "User id of a job."
},
"userProfile": {
"UserProfileFitScore": {
"type": "object",
"description": "It contains user profile details.",
"properties": {
"skills": {
"type": "array",
"description": "User's skills.",
"items": {
"type": "string",
"description": "List of skills."
}
},
"title": {
"type": "string",
"description": "Title of a job."
},
"yearsOfExperience": {
"type": "string",
"description": "Users's years of experience.",
"example": "0-5"
},
"preferredLocations": {
"type": "array",
"description": "Users's preferred locations.",
"items": {
"PreferredLocations": {
"type": "object",
"description": "It has details of preferred location.",
"properties": {
"location": {
"type": "string",
"description": "Preferred location name."
},
"latlong": {
"type": "object",
"description": "Latitude and longitude of preferred location.",
"properties": {
"lon": {
"type": "number",
"format": "double",
"description": "Longitude of preferred location."
},
"lan": {
"type": "number",
"format": "double",
"description": "Latitude of preferred location."
}
}
}
}
}
}
}
}
}
},
"jobIds": {
"type": "array",
"description": "Job ids to check fitscore.",
"items": {
"type": "string",
"description": "List of Job IDs."
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| locale | string | Locale of the site (Language_Country) - Example: en_US. |
| siteType | string | Persona Value - Example: Internal, External. |
| userId | string | User id of a job. |
| userProfile | object | UserProfileFitScore |
| jobIds | [string] | Job ids to check fitscore. |
copied!{
"type": "object",
"description": "It has details of preferred location.",
"properties": {
"location": {
"type": "string",
"description": "Preferred location name."
},
"latlong": {
"type": "object",
"description": "Latitude and longitude of preferred location.",
"properties": {
"lon": {
"type": "number",
"format": "double",
"description": "Longitude of preferred location."
},
"lan": {
"type": "number",
"format": "double",
"description": "Latitude of preferred location."
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| location | string | Preferred location name. |
| latlong | object | Latitude and longitude of preferred location. |
| lon | number | Longitude of preferred location. |
| lan | number | Latitude of preferred location. |
copied!{
"type": "object",
"description": "Fitscore Response.",
"properties": {
"status": {
"type": "integer",
"description": "Status code of response.",
"default": "200"
},
"result": {
"type": "array",
"description": "Obtained results.",
"items": {
"type": "object",
"description": "Results of fitscore.",
"properties": {
"jobId": {
"type": "string",
"description": "Job Id for which fitscore is calculated."
},
"fitLevel": {
"type": "string",
"description": "Shows how well the user fits the job."
},
"titleFit": {
"type": "string",
"description": "Shows how well the user title fits the job."
},
"skillFit": {
"type": "string",
"description": "Shows how well the user skills fits the job."
},
"experienceFit": {
"type": "string",
"description": "Shows how well the user experience fits the job."
},
"locationFit": {
"type": "string",
"description": "Shows how well the user location fits the job."
},
"skillGap": {
"type": "object",
"description": "Evaluates user skills.",
"properties": {
"exactMatch": {
"type": "array",
"description": "Exact Matched Skills.",
"items": {
"type": "string",
"description": "List of skills which matched exactly."
}
},
"semanticMatch": {
"type": "array",
"description": "Semantically Matched Skills.",
"items": {
"type": "string",
"description": "List of skills which matched semantically."
}
},
"noMatch": {
"type": "array",
"description": "UnMatched Skills.",
"items": {
"type": "string",
"description": "List of skills which are unmatched."
}
}
}
}
}
}
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | integer | Status code of response. |
| result | [object] | Obtained results. |
| jobId | string | Job Id for which fitscore is calculated. |
| fitLevel | string | Shows how well the user fits the job. |
| titleFit | string | Shows how well the user title fits the job. |
| skillFit | string | Shows how well the user skills fits the job. |
| experienceFit | string | Shows how well the user experience fits the job. |
| locationFit | string | Shows how well the user location fits the job. |
| skillGap | object | Evaluates user skills. |
| exactMatch | [string] | Exact Matched Skills. |
| semanticMatch | [string] | Semantically Matched Skills. |
| noMatch | [string] | UnMatched Skills. |
copied!{
"type": "object",
"description": "Error Response.",
"properties": {
"status": {
"type": "integer",
"description": "Status code of encountered error."
},
"message": {
"type": "string",
"description": "Encountered error message."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | integer | Status code of encountered error. |
| message | string | Encountered error message. |
copied!{
"type": "object",
"description": "Fitscore bad request details.",
"properties": {
"status": {
"type": "integer",
"description": "Status code of bad request."
},
"message": {
"type": "string",
"description": "Bad request message."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| status | integer | Status code of bad request. |
| message | string | Bad request message. |
copied!{
"type": "object",
"description": "Response of the given request.",
"properties": {
"matchingSkills": {
"type": "array",
"description": "List of matched skills.",
"items": {
"type": "string"
}
},
"matchingSkillsCount": {
"type": "integer",
"description": "Count of matched skills."
},
"unmatchingSkills": {
"type": "array",
"description": "List of unmatched skills.",
"items": {
"type": "string"
}
},
"unmatchingSkillsCount": {
"type": "integer",
"description": "Count of unmatched skills."
},
"totalJobSkills": {
"type": "integer",
"description": "Count of total job skills."
},
"status": {
"type": "string",
"description": "Status of fitscore processing."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| matchingSkills | [string] | List of matched skills. |
| matchingSkillsCount | integer | Count of matched skills. |
| unmatchingSkills | [string] | List of unmatched skills. |
| unmatchingSkillsCount | integer | Count of unmatched skills. |
| totalJobSkills | integer | Count of total job skills. |
| status | string | Status of fitscore processing. |
copied!{
"type": "object",
"description": "Required Parameters are missing to process the request.",
"properties": {
"ErrorResponseMessage": {
"type": "string",
"description": "Error Response Message."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| ErrorResponseMessage | string | Error Response Message. |
copied!{
"type": "object",
"description": "Issue in processing the request.",
"properties": {
"ErrorResponseMessage": {
"type": "string",
"description": "Error Response Message."
}
}
}Properties
| Name | Type | Description |
|---|---|---|
| ErrorResponseMessage | string | Error Response Message. |