> ## Documentation Index
> Fetch the complete documentation index at: https://developer.karmacheck.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Canada Disclosure

> Retrieves a Canada Disclosure document to present to the candidate so that the candidate can acknowledge and continue the onboarding process. If the candidate has already acknowledged the disclosure, the response will indicate this and provide a valid `caseDataId` so that the details of the previous acknowledgement can be retrieved. This can also be used to determine whether the candidate can skip this specific disclosure step if they leave and then continue their onboarding later or on another device, for example.



## OpenAPI

````yaml /background-check-api/api-reference/openapi.json get /case/id/{caseId}/canadadisclosure/{language}
openapi: 3.1.0
info:
  title: KarmaCheck API
  description: >-
    All requests to the KarmaCheck API require a JSON Web Token (JWT) in the
    Authorization header. For an overview of the API and its authentication
    method, refer to the following topics:


    - [API basics](docs/overview/apis/api-overview.md)

    - [Authentication](docs/overview/apis/authentication.md)

    - [Environments](docs/overview/apis/environments.md)

    - [Status codes and errors](docs/overview/apis/errors.md)
  version: '1.0'
  contact:
    name: KarmaCheck
    email: customersuccess@karmacheck.com
servers:
  - description: Stage
    url: https://api-stage.karmacheck.io
  - description: Prod
    url: https://api.karmacheck.io
security:
  - JWT: []
tags:
  - name: Authentication
  - name: Cases
  - name: Candidate onboarding
  - name: Secure documents
  - name: Packages
  - name: Services
  - name: Users
  - name: Companies
  - name: Partner integrations
paths:
  /case/id/{caseId}/canadadisclosure/{language}:
    parameters:
      - schema:
          type: string
        name: caseId
        in: path
        required: true
        description: The ID of a case.
      - $ref: '#/components/parameters/language'
    get:
      tags:
        - Candidate onboarding
      summary: Get Canada Disclosure
      description: >-
        Retrieves a Canada Disclosure document to present to the candidate so
        that the candidate can acknowledge and continue the onboarding process.
        If the candidate has already acknowledged the disclosure, the response
        will indicate this and provide a valid `caseDataId` so that the details
        of the previous acknowledgement can be retrieved. This can also be used
        to determine whether the candidate can skip this specific disclosure
        step if they leave and then continue their onboarding later or on
        another device, for example.
      operationId: get-case-id-caseId-canadadisclosure-language
      parameters:
        - name: language
          in: path
          required: true
          schema:
            type: string
          description: The language code (e.g. en-US)
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                  - alreadyAck
                  - title
                  - body
                  - authorizationStatement
                  - authorizationObject
                properties:
                  alreadyAck:
                    type: boolean
                    description: >-
                      True if the candidate already acknowledged the disclosure;
                      false otherwise.
                  title:
                    type: string
                    description: Escaped HTML.
                  header:
                    type: string
                    description: Escaped HTML.
                  body:
                    type: string
                    description: Escaped HTML.
                  authorizationStatement:
                    type: string
                    description: Escaped HTML.
                  authorizationObject:
                    type: object
                    required:
                      - sections
                    properties:
                      header:
                        type: string
                      selectionType:
                        type: string
                        enum:
                          - single
                          - multi
                      sections:
                        type: array
                        items:
                          type: object
                          required:
                            - selectionValue
                          properties:
                            title:
                              type: string
                            selectionValue:
                              type: string
                              description: >-
                                The postback value when calling the
                                corresponding acknowledge endpoint.
                              example: signature
                            body:
                              type: string
                  caseDataId:
                    type: string
                    description: Returned only if `alreadyAck` is true.
                    format: uuid
                  signature:
                    type: string
                    description: >-
                      Returned only if `alreadyAck` is true. For candidates who
                      onboarded using KarmaCheck's onboarding experience, this
                      is the value that the candidate entered into the signature
                      input field on the legal step, which might not be exactly
                      the same as the name that the case was ordered under.
              examples:
                Example 1:
                  value:
                    alreadyAck: false
                    title: >-
                      <div>Canada Disclosure Acknowledgment and Authorization
                      for Background Check</div>
                    header: >-
                      <div>Disclosure regarding background investigation and
                      investigative consumer reports, a summary of your rights
                      under the Fair Credit Reporting Act</div>
                    body: >-
                      <div><p><span>I acknowledge receipt of the separate
                      documents entitled DISCLOSURE REGARDING BACKGROUND
                      INVESTIGATION, A SUMMARY OF YOUR RIGHTS UNDER THE FAIR
                      CREDIT REPORTING ACT and the DISCLOSURE FOR INVESTIGATIVE
                      CONSUMER REPORT and certify that I have read and
                      understand those documents. </span></p><p><span>In
                      connection with your employment application with Example
                      Company (the “Company”), this notice is intended to inform
                      you that a consumer report(s) (also known as “a background
                      check”) may be obtained on you from a consumer reporting
                      agency for employment purposes. The reports may contain
                      information about you relating to your criminal
                      information or history, driving and/or motor vehicle
                      records, education and/or employment history, social
                      media, or other background checks, inclusive of but not
                      necessarily limited to records and information from
                      </span><span>any law enforcement agency, administrator,
                      state or federal agency, institution, school or university
                      (public or private), information service bureau, employer,
                      or insurance company</span><span>. </span><span>I agree
                      that a facsimile (&quot;fax&quot;), electronic or
                      photographic copy of this Authorization shall be as valid
                      as the original.</span></p><p><span>The report(s) is being
                      prepared by our background screening vendor, KarmaCheck,
                      Inc. and its associated partners or
                      vendors.</span></p><p><span>The scope of this notice and
                      below authorization is not limited to the present and, if
                      you are hired, will continue throughout the course of your
                      employment and allow the Company to conduct future
                      screenings for retention, promotion or reassignment, as
                      permitted by law and unless revoked by you in
                      writing.</span></p></div>
                    authorizationStatement: >-
                      <div><p><b><u><span>AUTHORIZATION</span></u></b></p><p>By
                      signing below, you authorize the obtaining of a consumer
                      report by the Company at any time after receipt of this
                      authorization and throughout the course of your
                      employment, as described above.</p><form><p><input
                      type='checkbox' readonly='' ##SEND_REPORT##
                      style='-fs-checkbox-style: check;' /><label>Check the box
                      if you would like to receive a copyÏ of the investigative
                      consumer report, free of charge, if one is obtained by the
                      Company.</label></p><p>Signature</p><p><input type='text'
                      readonly='' value=''/></p></form></div>
                    authorizationObject:
                      sections:
                        - title: AUTHORIZATION
                          selectionValue: signature
                          body: >-
                            By signing below, you authorize the obtaining of a
                            consumer report by the Company at any time after
                            receipt of this authorization and throughout the
                            course of your employment, as described above.
        '403':
          description: Forbidden
        '404':
          description: The case was not found.
        '422':
          description: The case does not have the specified disclosure as a requirement.
        '500':
          description: Internal Server Error
components:
  parameters:
    language:
      name: language
      in: path
      required: true
      schema:
        type: string
        enum:
          - en
      description: >-
        The desired language for the legal document. Must be an [ISO
        639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)
        code. Currently, the only supported value is `en` (English). If an
        unsupported language is requested, the call still succeeds but returns
        an English version of the document.
  securitySchemes:
    JWT:
      type: http
      scheme: bearer

````