A candidate centric hiring platform for top-tier professionals

API Documentation

FIT API 2 - FIT Score

The Create FIT Score API calculates a FIT Score by analyzing a FIT Job and comparing it with candidate resumes. It uses the provided FIT Job ID and resume URLs to determine compatibility and relevance.

POST

https://apis.whitetable.ai/rank/fitScore

Authentication

Authentication token that must be included in the request headers for authentication purposes. The client must securely store and manage this token, which is required to access protected API endpoints. The token should be sent in the following format:

token: <your-token-here>

Security Requirements:

The client is responsible for securely storing the token, using secure mechanisms (e.g., encrypted storage)

Do not hardcode or expose the token in client-side code or publicly accessible files

The server will return a 401 Unauthorized error if

The token is missing, expired, or invalid

The token does not meet the required policy for the requested resource

Body

string

Required

The unique identifier for the FIT Job (from the Create FIT Job API 1)

resume

string

Required

URL to the candidate’s resume file (PDF, DOC, DOCX, or TXT formats)

{"id": "{FIT_JOB_ID}",
"resume": "{RESUME_URL}"
}

Sample Request

cURL

Copy

curl -X POST https://apis.whitetable.ai/rank/fitScore-H 'token: {AUTH_TOKEN}'
-H 'Content-Type: application/json'
-d {"id":"{FIT_JOB_ID}","resume":"{RESUME_URL}"}

Sample Response

CONTENT TYPE
application/json

Copy

{"score": 85,
"pros": ["Strong expertise in Python and Machine Learning.",
"Extensive experience with NLP models, aligning well with the JD."
]
,
"cons": ["Limited experience with cloud-based deployment, which is a key JD requirement."
]
,
"details": {"Python and Machine Learning": "Highlighted in work experience and projects section.",
"NLP models": "Mentioned in the skills and certifications section.",
"Cloud deployment": "Not found in resume, missing relevant experience."
}
}