Appearance
Parse a CV into a candidate
POST
/api/nova/candidates/parse
Uploads a CV file (pdf, doc, or docx) as multipart form data and parses it into a candidate record. After parsing, a duplicate check by email, name, and current employer is performed: if a match is found the existing candidate is returned with the duplicate flag set to true, otherwise a new candidate is created with the CV attached. The response contains the candidate ID, reference, full name, the duplicate flag, and the stored CV file's ID and name. Parsing is rate limited per minute based on the account's subscription plan, with additional hourly and daily request caps and plan-based daily and monthly parse allowances. Responds with 400 when no file is supplied, 401 for an invalid API key, and 429 when a limit is exceeded.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Request Body
multipart/form-data
Format
"binary"Responses
OK
application/json
JSON "data": { "candidateId": "string", "cvFileId": "string", "cvFileName": "string", "duplicate": true, "name": "string", "reference": "string" }, "error": "string", "message": "string", "requestId": "string", "success": true
{
}