About this endpoint
What it does
Screens a resume against a job title and returns a structured assessment of the candidate fit and review signals. The request body must include jobTitle and resumeContent; the response returns scoring, verdict, strengths, gaps, integrity notes, and a nested security report.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| jobTitle | String | Yes | The job title to screen the resume against. |
| resumeContent | String | Yes | The resume text to evaluate. |
Response
Returns a JSON object with six top-level fields: score as an integer, verdict as a string, strengths as a string array, integrityNotes as a string, securityReport as an object, and gaps as a string array.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| score | Integer | Yes | The screening score. |
| verdict | String | Yes | The overall screening verdict. |
| strengths | String Array | Yes | A list of strengths identified in the resume. |
| integrityNotes | String | Yes | Notes related to resume integrity. |
| securityReport | Object | Yes | Security-related review output with flags and riskLevel. |
| securityReport.flags | String Array | Yes | A list of security flags. |
| securityReport.riskLevel | String | Yes | The security risk level. |
| gaps | String Array | Yes | A list of gaps identified in the resume. |