> ## 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

> One candidate in full: what was sent and when, every answer, and the result once they finish. The English transcript of a spoken answer is translated the first time it is read, so that read can be slower.

**Scope:** `enrichment:read` or `enrichment:write` or `enrichment:campaigns`



## OpenAPI

````yaml /enrichment-api/api-reference/openapi.json get /enrichments/{enrichment_id}/candidates/{candidate_id}
openapi: 3.1.0
info:
  title: Record Enrichment API
  version: 1.0.0
  description: >-
    Collect work, location, shift and salary details from your own candidate
    database. 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: Enrichment API
security: []
tags:
  - name: Enrichments
  - name: Enrichment campaigns
  - name: Enrichment candidates
  - name: Enrichment results
  - name: Enrichment credits
paths:
  /enrichments/{enrichment_id}/candidates/{candidate_id}:
    get:
      tags:
        - Enrichment candidates
      summary: Get a candidate
      description: >-
        One candidate in full: what was sent and when, every answer, and the
        result once they finish. The English transcript of a spoken answer is
        translated the first time it is read, so that read can be slower.


        **Scope:** `enrichment:read` or `enrichment:write` or
        `enrichment:campaigns`
      operationId: getEnrichmentCandidate
      parameters:
        - name: enrichment_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^WF_[A-Z]{2}_[A-Z0-9]{10,40}$
          example: WF_EN_261121094822026AEDRUB86TQVSML
        - name: candidate_id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 64
          example: 6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33
      responses:
        '200':
          description: The candidate
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    const: true
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      candidate_id:
                        type: string
                      external_id:
                        anyOf:
                          - type: string
                          - type: 'null'
                      name:
                        type: string
                      phone_number:
                        type: string
                      status:
                        type: string
                        enum:
                          - completed
                          - interested
                          - in_progress
                          - link_opened
                          - sent
                          - queued
                          - not_interested
                          - opted_out
                          - failed
                      language:
                        anyOf:
                          - type: string
                          - type: 'null'
                      campaign_id:
                        type: string
                      is_interested:
                        anyOf:
                          - type: boolean
                          - type: 'null'
                        description: Yes or No on the WhatsApp invite; null before a reply
                      is_completed:
                        type: boolean
                      completed_channel:
                        anyOf:
                          - type: string
                          - type: 'null'
                      completed_at:
                        anyOf:
                          - type: string
                          - type: 'null'
                      first_engagement_channel:
                        anyOf:
                          - type: string
                          - type: 'null'
                      delivery_error:
                        anyOf:
                          - type: string
                          - type: 'null'
                      journey:
                        type: object
                        properties:
                          invite_sent_at:
                            anyOf:
                              - type: string
                              - type: 'null'
                          follow_ups:
                            type: integer
                          sms_sent_at:
                            anyOf:
                              - type: string
                              - type: 'null'
                          call_attempts:
                            type: integer
                          call_answered_at:
                            anyOf:
                              - type: string
                              - type: 'null'
                          link_opened_at:
                            anyOf:
                              - type: string
                              - type: 'null'
                          opted_out_at:
                            anyOf:
                              - type: string
                              - type: 'null'
                      answers:
                        type: array
                        items:
                          type: object
                          properties:
                            question_id:
                              type: string
                            order:
                              type: integer
                            question_text:
                              type: string
                            type:
                              type: string
                            required:
                              type: boolean
                            answered:
                              type: boolean
                            text:
                              type: array
                              items:
                                type: string
                            channel:
                              anyOf:
                                - type: string
                                - type: 'null'
                            transcript_english:
                              anyOf:
                                - type: string
                                - type: 'null'
                            audio_url:
                              anyOf:
                                - type: string
                                - type: 'null'
                            qualified:
                              anyOf:
                                - type: boolean
                                - type: 'null'
                              description: >-
                                yes_no only: whether the answer matched the
                                preferred answer
                      result:
                        anyOf:
                          - type: object
                            properties:
                              result_id:
                                type: string
                              status:
                                type: string
                              completed_channel:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              completed_at:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                              summary:
                                type: object
                                additionalProperties: {}
                          - type: 'null'
              example:
                success: true
                data:
                  candidate_id: 6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33
                  external_id: cand-1001
                  name: Ravi Kumar
                  phone_number: '+919876543210'
                  status: completed
                  language: english
                  campaign_id: EC_261121095438377TFUX07WN2XT42V
                  is_interested: true
                  is_completed: true
                  completed_channel: whatsapp
                  completed_at: '2026-11-10T11:02:10.000Z'
                  first_engagement_channel: whatsapp
                  delivery_error: null
                  journey:
                    invite_sent_at: '2026-11-10T10:31:00.000Z'
                    follow_ups: 0
                    sms_sent_at: null
                    call_attempts: 0
                    call_answered_at: null
                    link_opened_at: '2026-11-10T10:58:00.000Z'
                    opted_out_at: null
                  answers:
                    - question_id: eqq_cc9800817588972e
                      order: 0
                      question_text: Are you open to a new job right now?
                      type: yes_no
                      required: true
                      answered: true
                      text:
                        - 'Yes'
                      channel: whatsapp
                      transcript_english: null
                      audio_url: null
                      qualified: true
                    - question_id: eqq_7a31f0c2d95b84e6
                      order: 1
                      question_text: >-
                        Tell us about the work you do and where you want to
                        work.
                      type: voice
                      required: true
                      answered: true
                      text:
                        - Forklift operator, 4 years, Chennai
                      channel: web
                      transcript_english: I drive a forklift, four years, in Chennai
                      audio_url: null
                      qualified: null
                  result:
                    result_id: ERS_261121100210123X5T9K2M7Q4R8WV
                    status: completed
                    completed_channel: whatsapp
                    completed_at: '2026-11-10T11:02:10.000Z'
                    summary:
                      answered_count: 2
                      required_count: 2
                      qualified_count: 1
        '404':
          description: '`NOT_FOUND`: No such enrichment or candidate.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKey: []
          SecretKey: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            pcall GET
            "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates/6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33"
        - lang: javascript
          label: JavaScript
          source: >-
            const res = await call("GET",
            "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates/6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33");

            const { data } = await res.json();
        - lang: python
          label: Python
          source: >-
            res = call("GET",
            "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates/6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33")

            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
                - 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.