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

# Request background check reports for affiliations

> Requests a background check report for each affiliation selected, business or person. Where the source records already identify the party, its report is retrieved for that party directly; otherwise a search runs first, and a search that settles on no single party returns `not_found` along with the parties it did find, so one can be confirmed. 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
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:
    post:
      tags:
        - EndUsers
      summary: Request background check reports for affiliations
      description: >
        Requests a background check report for each affiliation selected,
        business or person. Where the source records already identify the party,
        its report is retrieved for that party directly; otherwise a search runs
        first, and a search that settles on no single party returns `not_found`
        along with the parties it did find, so one can be confirmed. 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/BackgroundCheckAffiliateReportRequestSchema'
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BackgroundCheckAffiliateRequestAcceptedSchema
          description: Report requests accepted
        '404':
          description: End user not found, or affiliations are not enabled for this account
        '409':
          description: >-
            The affiliation list has changed, this affiliation cannot have a
            report requested for it, or no completed background check exists
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BackgroundCheckAffiliateReportRequestSchema:
      properties:
        affiliates:
          description: >-
            The affiliations to request CLEAR reports for, at most 25 per
            request.
          items:
            $ref: '#/components/schemas/BackgroundCheckAffiliateSelection'
          maxItems: 25
          minItems: 1
          type: array
      required:
        - affiliates
      type: object
    BackgroundCheckAffiliateRequestAcceptedSchema:
      properties:
        requests:
          description: >-
            One entry per selection: the report request accepted for processing,
            or the in-flight request it was deduplicated against.
          items:
            $ref: '#/components/schemas/BackgroundCheckAffiliationReportState'
          type: array
      required:
        - requests
      type: object
    BackgroundCheckAffiliateSelection:
      properties:
        index:
          description: >-
            Position of the affiliation in that owner's list, as returned by the
            affiliations endpoint.
          minimum: 0
          type: integer
        kind:
          description: Whether the selection is an affiliated business or person.
          enum:
            - person
            - business
          type: string
        name:
          description: >-
            Name shown for the affiliation; the request is rejected if the list
            has changed.
          type: string
        search_inputs:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckAffiliateSearchInputs'
          description: >-
            Details to search a corporate officer on, whose filing carries only
            a name. Optional, and ignored for selections whose source already
            holds search details.
          nullable: true
        subject_key:
          description: >-
            The report whose list the selection refers to: an owner's
            affiliations, or the people and companies named as officers on the
            business's own filings.
          enum:
            - owner_1
            - owner_2
            - business
          type: string
      required:
        - index
        - kind
        - name
        - subject_key
      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
    BackgroundCheckAffiliateSearchInputs:
      properties:
        city:
          description: City of the address to search on.
          nullable: true
          type: string
        date_of_birth:
          description: The person's date of birth; ignored for a business.
          format: date
          nullable: true
          type: string
        phone:
          description: Phone number on file; ignored for a person.
          nullable: true
          type: string
        state:
          description: State of the address to search on.
          nullable: true
          type: string
        street:
          description: Street of the address to search on.
          nullable: true
          type: string
        zip_code:
          description: ZIP code of the address to search on.
          nullable: true
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey

````