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

# List an end user's background check affiliations

> Lists every business and person the deal's background check connects it to: the businesses each owner is recorded as affiliated with, the people associated with them, and the people and companies named as officers on the business's own filings. Each row carries the state of any report requested for it, and is absent until a background check has completed.




## OpenAPI

````yaml https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/background_check/affiliations
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:
    get:
      tags:
        - EndUsers
      summary: List an end user's background check affiliations
      description: >
        Lists every business and person the deal's background check connects it
        to: the businesses each owner is recorded as affiliated with, the people
        associated with them, and the people and companies named as officers on
        the business's own filings. Each row carries the state of any report
        requested for it, and is absent until a background check has completed.
      parameters:
        - description: The Heron ID of the end user
          in: path
          name: end_user_heron_id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BackgroundCheckAffiliationsViewSchema'
          description: OK
        '404':
          description: End user not found, or affiliations are not enabled for this account
      security:
        - ApiKeyAuth: []
components:
  schemas:
    BackgroundCheckAffiliationsViewSchema:
      properties:
        businesses:
          description: >-
            Businesses the owners are affiliated with, from their background
            check reports.
          items:
            $ref: '#/components/schemas/BackgroundCheckAffiliationRow'
          type: array
        persons:
          description: >-
            People associated with the owners, from their background check
            reports.
          items:
            $ref: '#/components/schemas/BackgroundCheckAffiliationPersonRow'
          type: array
        status:
          description: >-
            Run lifecycle of the underlying background check. Lists reflect the
            most recent succeeded run; while a newer run is processing or failed
            they keep the last completed data and pending report requests show
            as pending.
          enum:
            - never_run
            - processing
            - succeeded
            - failed
            - missing_input_data
          type: string
      required:
        - businesses
        - persons
        - status
      type: object
    BackgroundCheckAffiliationRow:
      properties:
        address:
          description: Address of the business; null when unavailable.
          nullable: true
          type: string
        address_state:
          description: State of the business address; null when unavailable.
          nullable: true
          type: string
        business_name:
          description: Business the owner is affiliated with.
          nullable: true
          type: string
        index:
          description: Position in that report's list; echo it when requesting a report.
          type: integer
        legal_business_name:
          description: Legal name of the business as filed; null when unavailable.
          nullable: true
          type: string
        organization_type:
          description: >-
            Source-provided organisation type, such as CORPORATION; null when
            unavailable.
          nullable: true
          type: string
        report:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckAffiliationReportState'
          description: >-
            State of the most recent report requested for this affiliation; null
            when never requested.
          nullable: true
        role:
          description: Role at the business, such as CEO, DIRECTOR, or Registered Agent.
          nullable: true
          type: string
        roles:
          description: >-
            All roles the owner holds at the business, such as Officer or
            Registered Agent.
          items:
            type: string
          type: array
        since_date:
          description: Date the affiliation began; null when unavailable.
          format: date
          nullable: true
          type: string
        status:
          description: Source-provided status of the affiliation.
          nullable: true
          type: string
        subject_key:
          description: >-
            The report that names this business: owner_1 or owner_2 for an
            owner's affiliation, or business for a company named as an officer
            on the business's own filings.
          enum:
            - owner_1
            - owner_2
            - business
          type: string
        year_established:
          description: >-
            Year the business was established as recorded on the source; null
            when unavailable.
          nullable: true
          type: string
      required:
        - index
        - subject_key
      type: object
    BackgroundCheckAffiliationPersonRow:
      properties:
        city_state:
          description: Reported city and state.
          nullable: true
          type: string
        date_of_birth:
          description: Date of birth; null when unavailable.
          format: date
          nullable: true
          type: string
        has_entity_id:
          description: >-
            Whether CLEAR identified this associate. When true a report pulls
            directly; when false a search runs first and may require confirming
            a candidate.
          type: boolean
        index:
          description: Position in that report's list.
          type: integer
        name:
          description: Name of the associate.
          nullable: true
          type: string
        relationship:
          description: Source-provided relationship to the owner.
          nullable: true
          type: string
        report:
          allOf:
            - $ref: '#/components/schemas/BackgroundCheckAffiliationReportState'
          description: >-
            State of the most recent report requested for this associate; null
            when never requested.
          nullable: true
        subject_key:
          description: >-
            The report that names this person: owner_1 or owner_2 for an owner's
            associate, or business for an unreported corporate officer.
          enum:
            - owner_1
            - owner_2
            - business
          type: string
      required:
        - has_entity_id
        - index
        - 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
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey

````