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

# Pin CLEAR candidate overrides for a background check

> Pins a CLEAR entity_id per subject (owner_1, owner_2, business) so the enricher fetches that candidate's report directly and skips its search. A null value clears that subject's pin; unpinned subjects still run the full search waterfall. Returns the current pins.



## OpenAPI

````yaml https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/background_check/override
openapi: 3.0.0
info:
  contact:
    email: support@herondata.io
    name: Support
  title: Heron Data API
  version: '2021-07-19'
servers:
  - description: Production
    url: https://app.herondata.io
security:
  - ApiKeyAuth:
      - key_XXX
externalDocs:
  description: Read Tutorial
  url: https://docs.herondata.io/
paths:
  /api/end_users/{end_user_heron_id}/background_check/override:
    post:
      tags:
        - EndUsers
      summary: Pin CLEAR candidate overrides for a background check
      description: >-
        Pins a CLEAR entity_id per subject (owner_1, owner_2, business) so the
        enricher fetches that candidate's report directly and skips its search.
        A null value clears that subject's pin; unpinned subjects still run the
        full search waterfall. Returns the current pins.
      parameters:
        - description: The Heron ID of the end user
          in: path
          name: end_user_heron_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackgroundCheckCandidateOverrideSchema'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundCheckCandidateOverrideSchema'
          description: OK
        '404':
          description: End user not found
        '409':
          description: Background-check overrides are not enabled for this submission
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BackgroundCheckCandidateOverrideSchema:
      properties:
        business:
          nullable: true
          type: string
        owner_1:
          nullable: true
          type: string
        owner_2:
          nullable: true
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey

````