Get Screening for Job Submission

curl --request GET \
  --url https://api.example.com/api/screening/submission/{jobSubmissionId}

{
  "id": 789,
  "jobSubmissionId": 456,
  "candidateId": 123,
  "jobId": 789,
  "currentScore": 66.67,
  "potentialScore": 100,
  "disqualify": false,
  "submissionSummary": {
    "screeningSummary": "The candidate meets most critical requirements including ICU experience and certifications...",
    "followUpQuestions": [
      "Are you willing and able to work night shifts?"
    ],
    "missingInformation": [
      "Night shift availability"
    ],
    "strengths": [
      "Current ACLS and BLS certifications"
    ],
    "gaps": [
      "Experience level slightly below requirement"
    ]
  },
  "applicationReadiness": {
    "readinessScore": 75,
    "status": "NeedsInformation",
    "requiredDocuments": {
      "missing": [
        "PALS certification",
        "Professional references"
      ],
      "expiringSoon": [
        "RN License (expires in 60 days)"
      ]
    },
    "qualificationGaps": {
      "critical": [
        "Night shift availability confirmation",
        "PALS certification"
      ],
      "recommended": [
        "Additional year of ICU experience",
        "Pediatric care experience"
      ]
    },
    "workHistoryGaps": {
      "gaps": [
        {
          "startDate": "2022-06-01",
          "endDate": "2022-08-15",
          "duration": "2.5 months"
        },
        {
          "startDate": "2023-01-01",
          "endDate": "2023-03-01",
          "duration": "2 months"
        }
      ],
      "totalGapDuration": "4.5 months"
    },
    "nextSteps": [
      "Submit PALS certification",
      "Provide professional references",
      "Confirm night shift availability",
      "Renew RN license"
    ]
  },
  "criteria": [
    {
      "id": 1,
      "source": "job_criteria",
      "question": "How many years of ICU nursing experience do you have?",
      "criteria": "Minimum of 3 years ICU nursing experience required",
      "type": "YearsOfExperience",
      "status": "PartiallyMet",
      "reasoning": "The candidate has 2 years of ICU experience...",
      "textEvidence": "2 years of experience in Medical ICU"
    }
  ],
  "qualificationLevel": "Appropriate",
  "isRelevant": true,
  "candidate": {
    "id": 123,
    "name": "Jane Smith",
    "location": "San Francisco, CA",
    "yearsOfExperience": 2
  },
  "job": {
    "id": 789,
    "title": "ICU Nurse",
    "location": "San Francisco, CA",
    "department": "Nursing"
  },
  "createdAt": "2024-03-19T18:30:00Z"
}

GET

api

screening

submission

{jobSubmissionId}

Get Screening for Job Submission

curl --request GET \
  --url https://api.example.com/api/screening/submission/{jobSubmissionId}

{
  "id": 789,
  "jobSubmissionId": 456,
  "candidateId": 123,
  "jobId": 789,
  "currentScore": 66.67,
  "potentialScore": 100,
  "disqualify": false,
  "submissionSummary": {
    "screeningSummary": "The candidate meets most critical requirements including ICU experience and certifications...",
    "followUpQuestions": [
      "Are you willing and able to work night shifts?"
    ],
    "missingInformation": [
      "Night shift availability"
    ],
    "strengths": [
      "Current ACLS and BLS certifications"
    ],
    "gaps": [
      "Experience level slightly below requirement"
    ]
  },
  "applicationReadiness": {
    "readinessScore": 75,
    "status": "NeedsInformation",
    "requiredDocuments": {
      "missing": [
        "PALS certification",
        "Professional references"
      ],
      "expiringSoon": [
        "RN License (expires in 60 days)"
      ]
    },
    "qualificationGaps": {
      "critical": [
        "Night shift availability confirmation",
        "PALS certification"
      ],
      "recommended": [
        "Additional year of ICU experience",
        "Pediatric care experience"
      ]
    },
    "workHistoryGaps": {
      "gaps": [
        {
          "startDate": "2022-06-01",
          "endDate": "2022-08-15",
          "duration": "2.5 months"
        },
        {
          "startDate": "2023-01-01",
          "endDate": "2023-03-01",
          "duration": "2 months"
        }
      ],
      "totalGapDuration": "4.5 months"
    },
    "nextSteps": [
      "Submit PALS certification",
      "Provide professional references",
      "Confirm night shift availability",
      "Renew RN license"
    ]
  },
  "criteria": [
    {
      "id": 1,
      "source": "job_criteria",
      "question": "How many years of ICU nursing experience do you have?",
      "criteria": "Minimum of 3 years ICU nursing experience required",
      "type": "YearsOfExperience",
      "status": "PartiallyMet",
      "reasoning": "The candidate has 2 years of ICU experience...",
      "textEvidence": "2 years of experience in Medical ICU"
    }
  ],
  "qualificationLevel": "Appropriate",
  "isRelevant": true,
  "candidate": {
    "id": 123,
    "name": "Jane Smith",
    "location": "San Francisco, CA",
    "yearsOfExperience": 2
  },
  "job": {
    "id": 789,
    "title": "ICU Nurse",
    "location": "San Francisco, CA",
    "department": "Nursing"
  },
  "createdAt": "2024-03-19T18:30:00Z"
}

Retrieve the screening result for a specific job submission. This endpoint returns a single screening result rather than a list.

Path Parameters

jobSubmissionId

integer

required

ID of the job submission to get screening for

Response Fields

integer

Unique identifier for the screening

jobSubmissionId

integer

ID of the job submission being screened

candidateId

integer

ID of the candidate being screened

jobId

integer

ID of the job being screened against

currentScore

number

Current match percentage based on verified criteria (0-100)

potentialScore

number

Maximum possible match percentage if all unverified criteria are met (0-100)

disqualify

boolean

Whether the candidate should be disqualified from the job

submissionSummary

object

Detailed screening analysis and recommendations

Show Summary fields

screeningSummary

string

Overall assessment of the candidate’s fit for the position

followUpQuestions

array

Questions to ask the candidate about unverified or unclear criteria

missingInformation

array

List of criteria that couldn’t be verified from available information

strengths

array

List of criteria where the candidate shows strong matches

gaps

array

List of areas where the candidate doesn’t meet requirements

applicationReadiness

object

Analysis of application completeness and readiness to submit

Show Readiness fields

readinessScore

number

Overall readiness score (0-100) based on completeness and qualification

status

string

Current status: “Ready”, “NeedsInformation”, “NeedsQualification”, “NotQualified”

requiredDocuments

object

missing

array

Required documents that need to be provided

expiringSoon

array

Documents that will expire within 90 days

qualificationGaps

object

critical

array

Required qualifications that are missing

recommended

array

Preferred qualifications that would strengthen the application

workHistoryGaps

object

gaps

array

Time periods with no employment history

Show Gap Object

startDate

string

When the gap started (ISO 8601)

endDate

string

When the gap ended (ISO 8601)

duration

string

Human readable duration (e.g., “3 months”)

totalGapDuration

string

Total duration of all gaps (e.g., “8 months”)

nextSteps

array

Prioritized list of actions to improve application readiness

criteria

array

Detailed analysis of each criterion

Show Criterion fields

integer

Unique identifier for the criterion

source

string

Origin of the criterion (e.g., “job_criteria”)

question

string

The criterion formatted as a question

criteria

string

Original criterion text

type

string

Type of criterion (e.g., “YearsOfExperience”, “Required”, “Preferred”)

status

string

Match status: “FullyMet”, “PartiallyMet”, or “NotMet”

reasoning

string

Explanation of how the criterion was evaluated

textEvidence

string

Supporting text from resume/application, if found

qualificationLevel

string

Overall qualification assessment (e.g., “Appropriate”, “Overqualified”, “Underqualified”)

isRelevant

boolean

Indicates if the candidate’s background is relevant to the position

{
  "id": 789,
  "jobSubmissionId": 456,
  "candidateId": 123,
  "jobId": 789,
  "currentScore": 66.67,
  "potentialScore": 100,
  "disqualify": false,
  "submissionSummary": {
    "screeningSummary": "The candidate meets most critical requirements including ICU experience and certifications...",
    "followUpQuestions": [
      "Are you willing and able to work night shifts?"
    ],
    "missingInformation": [
      "Night shift availability"
    ],
    "strengths": [
      "Current ACLS and BLS certifications"
    ],
    "gaps": [
      "Experience level slightly below requirement"
    ]
  },
  "applicationReadiness": {
    "readinessScore": 75,
    "status": "NeedsInformation",
    "requiredDocuments": {
      "missing": [
        "PALS certification",
        "Professional references"
      ],
      "expiringSoon": [
        "RN License (expires in 60 days)"
      ]
    },
    "qualificationGaps": {
      "critical": [
        "Night shift availability confirmation",
        "PALS certification"
      ],
      "recommended": [
        "Additional year of ICU experience",
        "Pediatric care experience"
      ]
    },
    "workHistoryGaps": {
      "gaps": [
        {
          "startDate": "2022-06-01",
          "endDate": "2022-08-15",
          "duration": "2.5 months"
        },
        {
          "startDate": "2023-01-01",
          "endDate": "2023-03-01",
          "duration": "2 months"
        }
      ],
      "totalGapDuration": "4.5 months"
    },
    "nextSteps": [
      "Submit PALS certification",
      "Provide professional references",
      "Confirm night shift availability",
      "Renew RN license"
    ]
  },
  "criteria": [
    {
      "id": 1,
      "source": "job_criteria",
      "question": "How many years of ICU nursing experience do you have?",
      "criteria": "Minimum of 3 years ICU nursing experience required",
      "type": "YearsOfExperience",
      "status": "PartiallyMet",
      "reasoning": "The candidate has 2 years of ICU experience...",
      "textEvidence": "2 years of experience in Medical ICU"
    }
  ],
  "qualificationLevel": "Appropriate",
  "isRelevant": true,
  "candidate": {
    "id": 123,
    "name": "Jane Smith",
    "location": "San Francisco, CA",
    "yearsOfExperience": 2
  },
  "job": {
    "id": 789,
    "title": "ICU Nurse",
    "location": "San Francisco, CA",
    "department": "Nursing"
  },
  "createdAt": "2024-03-19T18:30:00Z"
}

Screen Many Candidates Get Screenings for Candidate

​Path Parameters

​Response Fields

Path Parameters

Response Fields