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

# Confirm a candidate for an affiliate report

> Chooses which of the parties a search found the affiliation's report should cover, either when the search settled on none of them or to correct an earlier choice. Only a party that affiliation's own search identified can be chosen. Its report is retrieved in the background, replacing any report already held for that affiliation; poll the affiliations endpoint for progress.




## OpenAPI

````yaml https://app.herondata.io/swagger post /api/end_users/{end_user_heron_id}/background_check/affiliations/reports/confirm
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/affiliations/reports/confirm:
    post:
      tags:
        - EndUsers
      summary: Confirm a candidate for an affiliate report
      description: >
        Chooses which of the parties a search found the affiliation's report
        should cover, either when the search settled on none of them or to
        correct an earlier choice. Only a party that affiliation's own search
        identified can be chosen. Its report is retrieved in the background,
        replacing any report already held for that affiliation; poll the
        affiliations endpoint for progress.
      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/BackgroundCheckAffiliateConfirmSchema'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundCheckAffiliationReportState'
          description: Report pull accepted
        '404':
          description: End user not found, or affiliations are not enabled for this account
        '409':
          description: >-
            No report has been requested for this affiliation, or no report can
            be ordered for the chosen party - it is not one this affiliation's
            search identified
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BackgroundCheckAffiliateConfirmSchema:
      properties:
        entity_id:
          description: >-
            The chosen candidate's entity identifier from the report's search
            trail.
          type: string
        ref:
          description: >-
            The affiliate report request reference, as returned when it was
            requested.
          type: string
      required:
        - entity_id
        - ref
      type: object
    BackgroundCheckAffiliationReportState:
      properties:
        kind:
          description: Whether the report is for an affiliated business or person.
          enum:
            - person
            - business
          type: string
        ref:
          description: >-
            Stable reference for this affiliate report request; echo it when
            confirming a candidate or removing the request.
          type: string
        status:
          description: >-
            Report lifecycle: pending until the next screening run pulls it,
            succeeded when the report is ready, not_found when no confident
            match was found (a candidate can be confirmed), or failed.
          enum:
            - pending
            - succeeded
            - not_found
            - failed
          type: string
      required:
        - kind
        - ref
        - status
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey

````