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

# Get the business and owner details of an end user

> Returns the applicant's business, its owners and the funding it applied for, with one value per field. `_sources` gives the source of each value.

`custom_entities` holds your custom fields.




## OpenAPI

````yaml https://app.herondata.io/swagger get /api/end_users/{end_user_heron_id}/details
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}/details:
    get:
      tags:
        - EndUsers
      summary: Get the business and owner details of an end user
      description: >
        Returns the applicant's business, its owners and the funding it applied
        for, with one value per field. `_sources` gives the source of each
        value.


        `custom_entities` holds your custom fields.
      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/EndUserDetailsResponseSchema'
          description: OK
        '404':
          description: End user not found
      security:
        - ApiKeyAuth: []
components:
  schemas:
    EndUserDetailsResponseSchema:
      description: >-
        The business, its owners and the funding it applied for, with one value
        per field.
      properties:
        business:
          allOf:
            - $ref: '#/components/schemas/ResolvedBusiness'
          description: The applicant's business.
          nullable: true
        custom_entities:
          additionalProperties: {}
          description: >-
            Your custom fields, grouped by entity name. Each entity has its
            values and a `_sources` object with the source of each value.
          type: object
        funding_applications:
          description: >-
            The funding the business applied for, newest `received_at` first and
            those with none last. Each uploaded application form is one entry,
            and so is each set of values you or your broker sent.
          items:
            $ref: '#/components/schemas/ResolvedFundingApplication'
          type: array
        owners:
          description: >-
            The business owners. Owners named by more sources come first, then
            the largest ownership percentage, then the order on the application.
          items:
            $ref: '#/components/schemas/ResolvedOwner'
          type: array
      required:
        - business
        - custom_entities
        - funding_applications
        - owners
      type: object
    ResolvedBusiness:
      description: The applicant's business.
      properties:
        _sources:
          additionalProperties:
            type: string
          description: The source of each field, keyed by field name.
          type: object
        annual_revenue:
          description: Annual revenue of the business.
          nullable: true
          type: number
        billing_address:
          allOf:
            - $ref: '#/components/schemas/ResolvedAddress'
          description: Billing address of the business.
          nullable: true
        dba:
          description: Trading name (DBA) of the business.
          nullable: true
          type: string
        emails:
          description: Email addresses of the business.
          items:
            $ref: '#/components/schemas/SourcedEmail'
          type: array
        entity_type:
          description: Legal structure of the business, for example `llc` or `corp`.
          enum:
            - llc
            - inc
            - corp
            - lp
            - llp
            - partnership
            - sole_proprietor
            - ltd
            - plc
            - co
            - pc
            - pllc
            - unknown
            - null
          nullable: true
        heron_id:
          description: >-
            The Heron ID of this entity. Send it in `PATCH
            /end_users/{id}/details` to update the entity.
          nullable: true
          type: string
        identifiers:
          description: Business identifiers, such as the EIN.
          items:
            $ref: '#/components/schemas/SourcedCompanyId'
          type: array
        industry:
          allOf:
            - $ref: '#/components/schemas/ResolvedIndustry'
          description: Main industry of the business.
          nullable: true
        legal_name:
          description: Legal name of the business.
          nullable: true
          type: string
        other_addresses:
          description: Other addresses found for the business.
          items:
            $ref: '#/components/schemas/ResolvedAddress'
          type: array
        phone_number:
          allOf:
            - $ref: '#/components/schemas/ResolvedPhone'
          description: Phone number of the business.
          nullable: true
        physical_address:
          allOf:
            - $ref: '#/components/schemas/ResolvedAddress'
          description: Physical address of the business.
          nullable: true
        social_media:
          allOf:
            - $ref: '#/components/schemas/BusinessSocialMedia'
          description: Social media profiles of the business.
        standing:
          description: >-
            How the winning filing reads on filings and fees, null when that
            filing states none.
          enum:
            - good
            - not_stated
            - not_good
            - pending_end
            - null
          nullable: true
          type: string
        started_on:
          allOf:
            - $ref: '#/components/schemas/PartialDate'
          description: Date the business started. The month or day can be missing.
          nullable: true
        state_of_incorporation:
          description: >-
            State where the business is incorporated. A US state is its
            two-letter code.
          nullable: true
          type: string
        status:
          description: >-
            The company's status across its filings: `active` or `inactive`,
            null when no source states one.
          enum:
            - active
            - inactive
            - null
          nullable: true
          type: string
        status_raw:
          description: >-
            The winning filing's status in the registry's own words, null when
            none was stated.
          nullable: true
          type: string
        website:
          description: Website of the business.
          nullable: true
          type: string
      type: object
    ResolvedFundingApplication:
      description: >-
        The funding the business applied for, and who sent the deal. A deal that
        names only who sent it has one row with just the source.
      properties:
        _sources:
          additionalProperties:
            type: string
          description: The source of each field, keyed by field name.
          type: object
        amount_requested:
          description: The amount the business asked for.
          nullable: true
          type: number
        heron_id:
          description: >-
            The Heron ID of this entity. Send it in `PATCH
            /end_users/{id}/details` to update the entity.
          nullable: true
          type: string
        loan_purpose:
          description: What the business will use the funds for.
          nullable: true
          type: string
        received_at:
          description: When Heron received the application. Null if we do not know.
          format: date-time
          nullable: true
          type: string
        source_email_address:
          description: >-
            The email address of whoever sent the deal, as the customer gave it
            or the email was sent from.
          nullable: true
          type: string
        source_name:
          description: >-
            Who sent the deal, as the customer named them or as the email that
            created the deal shows.
          nullable: true
          type: string
        source_notes:
          description: >-
            What whoever sent the deal said about it, as the customer gave it or
            the email's body.
          nullable: true
          type: string
      type: object
    ResolvedOwner:
      description: An owner of the business.
      properties:
        _sources:
          additionalProperties:
            type: string
          description: The source of each field, keyed by field name.
          type: object
        aliases:
          description: Other names or spellings found for the owner.
          items:
            $ref: '#/components/schemas/PersonName'
          type: array
        country_of_residence:
          description: Country where the owner lives.
          nullable: true
          type: string
        credit_scores:
          description: The latest credit score for each scoring model.
          items:
            $ref: '#/components/schemas/ResolvedCreditScore'
          type: array
        date_of_birth:
          allOf:
            - $ref: '#/components/schemas/PartialDate'
          description: Date of birth. The day can be missing.
          nullable: true
        deceased_on:
          description: Date of death, if a source provides one.
          format: date
          nullable: true
          type: string
        emails:
          description: Email addresses of the owner.
          items:
            $ref: '#/components/schemas/SourcedEmail'
          type: array
        has_signed:
          description: >-
            Whether the owner signed the application. True if they signed any of
            the application forms. False if the forms say they did not sign.
            Null if the forms do not say.
          nullable: true
          type: boolean
        heron_id:
          description: >-
            The Heron ID of this entity. Send it in `PATCH
            /end_users/{id}/details` to update the entity.
          nullable: true
          type: string
        home_address:
          allOf:
            - $ref: '#/components/schemas/ResolvedAddress'
          description: Home address of the owner.
          nullable: true
        home_phone_number:
          allOf:
            - $ref: '#/components/schemas/ResolvedPhone'
          description: Home phone number of the owner.
          nullable: true
        is_deceased:
          description: Whether the owner is recorded as deceased.
          nullable: true
          type: boolean
        mobile_phone_number:
          allOf:
            - $ref: '#/components/schemas/ResolvedPhone'
          description: Mobile phone number of the owner.
          nullable: true
        name:
          allOf:
            - $ref: '#/components/schemas/PersonName'
          description: Name of the owner, split into its parts.
          nullable: true
        national_ids:
          description: National identifiers, such as the SSN.
          items:
            $ref: '#/components/schemas/SourcedNationalId'
          type: array
        other_addresses:
          description: Other addresses found for the owner.
          items:
            $ref: '#/components/schemas/ResolvedAddress'
          type: array
        ownership_percentage:
          description: Percentage of the business the owner owns, from 0 to 100.
          nullable: true
          type: number
        signed_date:
          description: >-
            The date the owner signed the application. If they signed more than
            one form, this is the most recent date. A date on a form that says
            they did not sign is ignored. Null if there is no date.
          format: date
          nullable: true
          type: string
        social_media:
          allOf:
            - $ref: '#/components/schemas/OwnerSocialMedia'
          description: Social media profiles of the owner.
      type: object
    ResolvedAddress:
      description: An address.
      properties:
        _sources:
          additionalProperties:
            type: string
          description: The source of each field, keyed by field name.
          type: object
        city:
          description: City or town.
          nullable: true
          type: string
        country:
          description: Country.
          nullable: true
          type: string
        heron_id:
          description: >-
            The Heron ID of this entity. Send it in `PATCH
            /end_users/{id}/details` to update the entity.
          nullable: true
          type: string
        is_po_box:
          description: Whether the address is a PO box.
          type: boolean
        line_1:
          description: Street and building number.
          nullable: true
          type: string
        line_2:
          description: Apartment, unit or suite.
          nullable: true
          type: string
        postal_code:
          description: ZIP or postal code.
          nullable: true
          type: string
        raw:
          description: The full address in one line.
          type: string
        state_province:
          description: State, province or county. A US state is its two-letter code.
          nullable: true
          type: string
      type: object
    SourcedEmail:
      description: An email address.
      properties:
        _source:
          description: Where this value came from.
          nullable: true
          type: string
        email_address:
          description: The email address.
          type: string
      type: object
    SourcedCompanyId:
      description: A business identifier.
      properties:
        _source:
          description: Where this value came from.
          nullable: true
          type: string
        country:
          description: Issuing country, as a two-letter code.
          nullable: true
          type: string
        type:
          description: >-
            Type of business identifier. The prefix is the issuing country:
            `us_ein` (US Employer Identification Number), `us_taxpayer_number`
            (US state taxpayer number), `uk_company_number` (UK Companies House
            number), `duns` (D-U-N-S number, worldwide) or `vat` (VAT number).
          enum:
            - us_ein
            - us_taxpayer_number
            - duns
            - uk_company_number
            - vat
        value:
          description: The identifier.
          type: string
      type: object
    ResolvedIndustry:
      description: Main industry of the business.
      properties:
        _sources:
          additionalProperties:
            type: string
          description: The source of each field, keyed by field name.
          type: object
        code:
          description: Industry code, for example `722511`.
          nullable: true
          type: string
        description:
          description: Industry name, for example `Full-Service Restaurants`.
          nullable: true
          type: string
        heron_id:
          description: >-
            The Heron ID of this entity. Send it in `PATCH
            /end_users/{id}/details` to update the entity.
          nullable: true
          type: string
        scheme:
          description: 'Classification system: `naics`, `sic` or `free_text`.'
          enum:
            - naics
            - sic
            - free_text
      type: object
    ResolvedPhone:
      description: A phone number.
      properties:
        _sources:
          additionalProperties:
            type: string
          description: The source of each field, keyed by field name.
          type: object
        country_code:
          description: Country calling code, without the `+`.
          nullable: true
          type: string
        heron_id:
          description: >-
            The Heron ID of this entity. Send it in `PATCH
            /end_users/{id}/details` to update the entity.
          nullable: true
          type: string
        is_valid:
          description: Whether the number is valid.
          type: boolean
        line_type:
          description: Type of line, for example `mobile` or `fixed_line`.
          enum:
            - fixed_line
            - mobile
            - fixed_line_or_mobile
            - toll_free
            - premium_rate
            - shared_cost
            - voip
            - personal_number
            - pager
            - universal_access_number
            - voicemail
            - unknown
        national_destination_code:
          description: Area code.
          nullable: true
          type: string
        normalized:
          description: The number in international format, for example `+17635550143`.
          nullable: true
          type: string
        raw:
          description: The phone number as provided.
          type: string
        subscriber_number:
          description: The number without the country and area codes.
          nullable: true
          type: string
      type: object
    BusinessSocialMedia:
      description: Social media profiles of the business.
      properties:
        facebook:
          allOf:
            - $ref: '#/components/schemas/ResolvedSocialProfile'
          description: The company's Facebook page.
          nullable: true
        instagram:
          allOf:
            - $ref: '#/components/schemas/ResolvedSocialProfile'
          description: The company's Instagram profile.
          nullable: true
        linkedin:
          allOf:
            - $ref: '#/components/schemas/ResolvedSocialProfile'
          description: The company's LinkedIn page.
          nullable: true
      type: object
    PartialDate:
      properties:
        day:
          description: Day (1-31).
          nullable: true
          type: integer
        month:
          description: Month (1-12).
          nullable: true
          type: integer
        year:
          description: Year.
          nullable: true
          type: integer
      type: object
    PersonName:
      properties:
        given:
          description: First name.
          nullable: true
          type: string
        middle:
          description: Middle name or initial.
          nullable: true
          type: string
        prefix:
          description: Title, for example `Dr`.
          nullable: true
          type: string
        raw:
          description: The full name.
          type: string
        suffix:
          description: Suffix, for example `Jr` or `III`.
          nullable: true
          type: string
        surname:
          description: Last name.
          nullable: true
          type: string
        type:
          description: Type of name, for example `legal` or `aka`.
          enum:
            - legal
            - aka
            - maiden
            - former
      type: object
    ResolvedCreditScore:
      description: A credit score of the owner.
      properties:
        _sources:
          additionalProperties:
            type: string
          description: The source of each field, keyed by field name.
          type: object
        bureau:
          description: Credit bureau that produced the score, or `unknown`.
          enum:
            - equifax
            - experian
            - transunion
            - unknown
        heron_id:
          description: >-
            The Heron ID of this entity. Send it in `PATCH
            /end_users/{id}/details` to update the entity.
          nullable: true
          type: string
        score:
          description: The score.
          type: integer
        score_model:
          description: Scoring model, for example `fico`, or `unknown`.
          enum:
            - fico
            - vantagescore
            - unknown
        score_model_raw:
          description: Scoring model name as provided.
          nullable: true
          type: string
        score_version_raw:
          description: Scoring model version, for example `8`.
          nullable: true
          type: string
        scored_on:
          description: Date of the score.
          format: date
          nullable: true
          type: string
      required:
        - score
      type: object
    SourcedNationalId:
      description: A national identifier of the owner.
      properties:
        _source:
          description: Where this value came from.
          nullable: true
          type: string
        country:
          description: Issuing country.
          type: string
        expires_on:
          description: Expiry date.
          format: date
          nullable: true
          type: string
        state:
          description: Issuing state, for a driving licence.
          nullable: true
          type: string
        type:
          description: >-
            Type of personal identifier. The prefix is the issuing country:
            `us_ssn` (US Social Security Number), `ca_sin` (Canadian Social
            Insurance Number), `uk_nino` (UK National Insurance number),
            `driving_licence` or `passport`.
          enum:
            - us_ssn
            - ca_sin
            - uk_nino
            - driving_licence
            - passport
        value:
          description: The identifier.
          type: string
      type: object
    OwnerSocialMedia:
      description: Social media profiles of the owner.
      properties:
        facebook:
          allOf:
            - $ref: '#/components/schemas/ResolvedSocialProfile'
          description: The owner's Facebook page.
          nullable: true
        instagram:
          allOf:
            - $ref: '#/components/schemas/ResolvedSocialProfile'
          description: The owner's Instagram profile.
          nullable: true
        linkedin:
          allOf:
            - $ref: '#/components/schemas/ResolvedSocialProfile'
          description: The owner's LinkedIn profile.
          nullable: true
      type: object
    ResolvedSocialProfile:
      description: A social media profile.
      properties:
        _sources:
          additionalProperties:
            type: string
          description: The source of each field, keyed by field name.
          type: object
        heron_id:
          description: >-
            The Heron ID of this entity. Send it in `PATCH
            /end_users/{id}/details` to update the entity.
          nullable: true
          type: string
        url:
          description: Link to the profile.
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.