> ## Documentation Index > Fetch the complete documentation index at: https://docs.userecord.io/llms.txt > Use this file to discover all available pages before exploring further. # Get a candidate verdict > Verdict, score, a rating per skill and a report link. Add `include=answers` to also get what they said. **Scope:** `results:read` ## OpenAPI ````yaml /blue-collar-api/api-reference/openapi.json get /candidates/{candidate_id}/result openapi: 3.1.0 info: title: Record Blue Collar API version: 1.0.0 description: >- Run Record candidate verification from your own system. You need two things: your **key id** and your **secret**. Everything else is generated. See Authentication for how. servers: - url: https://api-bc.userecord.io/api/v1/partner description: Blue Collar API security: [] tags: - name: Skills description: The skill taxonomy, read live a page at a time - name: Skill requests description: Ask Record to add a missing skill - name: Lookups description: >- Lookups for filling in a job mandate: places in India, the countries an abroad job can be in, and the employment types and shifts the playground offers - name: Workflows description: >- Your organisation's blue-collar workflows (read all; change and soft-delete only the ones you created) - name: Job mandates description: >- Your organisation's job mandates, addressed by Record's mandate_id (read all; change only the ones you created) - name: Campaigns description: Contact candidates for one of your jobs and verify them. Spends credits - name: Results description: >- What Record collected from each candidate: status (pending, completed, declined, failed) and an output of answers and verdicts - name: Events description: >- Pull your result events and acknowledge them: the safety net behind the webhook, and a way to receive results without exposing a URL - name: Webhooks description: >- Endpoints that Record POSTs result events to: signed, retried until you acknowledge, replayable - name: Analytics description: >- The workflow Overview analytics of the Record playground: funnel, channels, follow-ups, calls, drop-offs, languages (read-only, scope analytics:read) paths: /candidates/{candidate_id}/result: get: tags: - Results summary: Get a candidate verdict description: >- Verdict, score, a rating per skill and a report link. Add `include=answers` to also get what they said. **Scope:** `results:read` operationId: getCandidateResult parameters: - name: candidate_id in: path required: true schema: type: string pattern: ^[A-Za-z0-9-]{8,64}$ example: a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01 - name: include in: query required: false schema: const: answers type: string example: answers responses: '200': description: The result content: application/json: schema: type: object properties: success: const: true type: boolean message: type: string data: type: object properties: candidate: type: object properties: candidate_id: type: string external_id: anyOf: - type: string - type: 'null' name: type: string campaign_id: type: string mandate_id: type: string description: >- Record's mandate id: the job mandate the campaign ran under job_id: anyOf: - type: string - type: 'null' description: Your job id; null for a mandate created without one status: type: string enum: - interested - not_interested - no_answer_yet - unreachable progress: anyOf: - type: string enum: - not_yet_started - in_progress - completed - type: 'null' methods: type: object properties: data_enrichment: type: object properties: status: type: string enum: - completed - in_progress - not_started qualified: anyOf: - type: boolean - type: 'null' answers: type: array items: type: object properties: key: anyOf: - type: string - type: 'null' question: type: string type: type: string answer: anyOf: - type: string - type: 'null' answer_native: anyOf: - type: string - type: 'null' description: >- Only with ?include=answers (scope results:answers) skill_verification: type: object properties: status: type: string enum: - completed - in_progress - not_started verdict: anyOf: - type: string - type: 'null' total_score: anyOf: - type: number - type: 'null' is_partial: type: boolean answered: anyOf: - type: number - type: 'null' total: anyOf: - type: number - type: 'null' skills: type: array items: type: object properties: name: type: string rating: type: string interest_collection: type: object properties: status: type: string enum: - completed - not_started current_role: anyOf: - type: string - type: 'null' open_to_other_roles: type: array items: type: object properties: role: type: string years: anyOf: - type: string - type: 'null' answers: type: array items: type: object properties: role: type: string summary: anyOf: - type: string - type: 'null' transcripts: type: array items: type: object properties: label: type: string text: type: string description: >- Only with ?include=answers (scope results:answers) ready_to_hire: type: boolean completed_at: anyOf: - type: string - type: 'null' report_url: type: string example: success: true data: candidate: candidate_id: a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01 external_id: cand-88231 name: Ravi Kumar campaign_id: asmnt_9f2c41d7a8b3e65f mandate_id: JM_261009101612456H3N8W2L5C9V1Z4 job_id: job-10452 status: interested progress: completed methods: data_enrichment: status: completed qualified: true answers: - key: has_licence question: Do you hold a valid forklift licence? type: yes_no answer: 'yes' answer_native: ஆம் skill_verification: status: completed verdict: Good Fit total_score: 78 is_partial: false answered: 3 total: 3 skills: - name: Forklift Basic Operation rating: Strong - name: Pallet Jack Safety Check rating: Medium ready_to_hire: true completed_at: '2026-10-05T12:41:10.000Z' report_url: https://example.com/r/7Hk2p9 '403': description: >- `SCOPE_MISSING`: `include=answers` also needs the `results:answers` scope. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: '`NOT_FOUND`: No such `candidate_id`.' content: application/json: schema: $ref: '#/components/schemas/Error' security: - ApiKey: [] SecretKey: [] x-codeSamples: - lang: bash label: cURL source: >- pcall GET "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/result?include=answers" - lang: javascript label: JavaScript source: >- const res = await call("GET", "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/result?include=answers"); const { data } = await res.json(); - lang: python label: Python source: >- res = call("GET", "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/result?include=answers") data = res.json()["data"] components: schemas: Error: type: object properties: success: const: false type: boolean error: type: object properties: code: type: string enum: - VALIDATION_FAILED - LIMIT_EXCEEDED - UNAUTHORIZED - SCOPE_MISSING - FORBIDDEN - HTTPS_REQUIRED - NOT_FOUND - CONFLICT - WORKFLOW_IN_USE - INSUFFICIENT_CREDITS - IDEMPOTENCY_KEY_REQUIRED - IDEMPOTENCY_KEY_REUSED - IDEMPOTENCY_IN_PROGRESS - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - COOLDOWN - DAILY_CAP - SERVICE_DISABLED - SERVER_ERROR message: type: string details: type: array items: type: object properties: path: type: string message: type: string request_id: type: string description: Quote it to Record support securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: Your key id, `VFN_TEST_…` or `VFN_LIVE_…`. Sent on every request. SecretKey: type: apiKey in: header name: x-secret-key description: >- Your secret, `VFN_SK_…`. **Not a real header, and never sent to the API.** It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send `x-api-key`, `x-timestamp` and `x-signature` (see Authentication). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.