REST API›Enterprise›Tax

GET

Retrieves submitted tax documentation data for the specified enterprise. Note: This endpoint currently returns hardcoded mock responses for initial client integration.

Path Params

  • enterpriseId string required
    The enterprise ID to get a token for

    32 to 32 characters · matches ^[0-9a-zA-Z]{32}$

Query Params

  • unmask string enum
    Whether to unmask sensitive TIN information in the response (defaults to false)
    truefalse

Responses

200
200

Response Body

object

Response returned when retrieving submitted tax documentation for an enterprise.
  • data object required
    data object
    • wForm object
      Collected W-9, W-8BEN, or W-8BEN-E form data

      ONE OF

      • e_delivery_consent boolean required
        Required electronic delivery preference for tax documents (true = Confirm E-delivery, false = Continue with postal delivery). Clients can fetch the electronic delivery disclosure text via GET /api/identity-service/v1/agreements/taxEDeliveryConsent and must explicitly collect and pass the end user selection (do not default to true).
      • name string
        Legal name of the individual or entity
      • dba_name string
        Business name / disregarded entity name, if different from above
      • tax_classification string enum
        Federal tax classification of the person or entity
        INDIVIDUALC_CORPORATIONS_CORPORATIONPARTNERSHIPTRUST_ESTATELLC_CLLC_PLLC_SSOLE_PROPRIETOROTHER
      • other_tax_classification string
        Description when tax_classification is OTHER
      • address object
        Shared tax address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
        address object
        • first_line string
          First line of the address
        • second_line string
          Second line of the address
        • city string
          City
        • state_or_province string
          State or province (must be a 2-letter postal code when country is US or CA)
        • postal_code string
          Postal code
        • country string enum
          Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name).
          ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
      • tin string
        Masked or unmasked Taxpayer Identification Number
      • tin_type string enum
        Type of Taxpayer Identification Number
        SSNEINITINATIN
      • exempt_payee_code string enum
        Exempt payee code (if applicable)
        12345678910111213
      • exempt_fatca_code string enum
        Exemption from FATCA reporting code (if applicable)
        ABCDEFGHIJKLM
      • is_not_subject_backup_withholding boolean
        Certifies that the taxpayer is not subject to backup withholding
      • has_signed_and_certified boolean
        Indicates that the taxpayer has signed and certified the W-9 under penalties of perjury
      • signature_timestamp string
        ISO 8601 timestamp when the form was signed
      • completed_for string enum
        Whether the form was completed for the ACCOUNT_HOLDER or REGARDED_OWNER
        ACCOUNT_HOLDERREGARDED_OWNER
      • signature string
        Electronic signature of the person certifying the form
      • id string uuid
        Unique UUID for the collected W-9 documentation
      • created_at string
        ISO 8601 timestamp when the W-9 documentation was recorded
      • has_certified boolean
        Indicates whether the W-9 form has been certified
      • document_type string enum
        Document type (W-9)
        W-9
    • selfCertification object
      Collected DAC8/CARF Self-Certification data
      selfCertification object
      • e_delivery_consent boolean required
        Required electronic delivery preference for tax documents (true = Confirm E-delivery, false = Continue with postal delivery). Clients can fetch the electronic delivery disclosure text via GET /api/identity-service/v1/agreements/taxEDeliveryConsent and must explicitly collect and pass the end user selection (do not default to true).
      • name string
        Legal name of the individual or entity
      • permanent_address object
        Shared tax address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
        permanent_address object
        • Same shape as TaxAddress.
      • mailing_address object
        Shared tax address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
        mailing_address object
        • Same shape as TaxAddress.
      • tax_residences array of objects
        List of tax residency jurisdictions and TINs
        tax_residences object
        • country string enum
          Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name).
          ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
        • tin string
          Tax Identification Number (TIN) for the jurisdiction
        • tin_not_required boolean
          Indicates if a TIN is not required or not issued
        • tin_not_required_reason string enum
          Reason why a TIN was not provided
          NOT_ISSUEDNOT_REQUIREDOTHER
        • tin_not_required_reason_other string
          Free-text explanation when tin_not_required_reason is OTHER
        • hashed_tin string
          SHA-256 hash of the TIN
      • classification string enum
        CRS/CARF classification of the account owner
        INDIVIDUALFINANCIAL_INSTITUTION_DEPOSITORY_INSTITUTIONFINANCIAL_INSTITUTION_CUSTODIAL_INSTITUTIONFINANCIAL_INSTITUTION_INSURANCE_COMPANYFINANCIAL_INSTITUTION_NON_REPORTINGFINANCIAL_INSTITUTION_INVESTMENT_ENTITY_MANAGEDFINANCIAL_INSTITUTION_INVESTMENT_ENTITY_OTHERACTIVE_NFE_GOVERNMENT_ENTITYACTIVE_NFE_CENTRAL_BANKACTIVE_NFE_INTERNATIONAL_ORGANIZATIONACTIVE_NFE_PUBLIC_CORPORATIONACTIVE_NFE_OTHERPASSIVE_NFE
      • signature_date string
        Date the self-certification was signed (YYYY-MM-DD or ISO 8601)
      • has_signed_and_certified boolean
        Indicates that the account owner has signed and certified the self-certification
      • date_of_birth string
        Date of birth for individual account owners (YYYY-MM-DD)
      • city_of_birth string
        City of birth for individual account owners
      • country_of_birth string enum
        Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name).
        ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
      • country_of_citizenship string enum
        Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name).
        ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
      • entity_type string enum
        Entity type when classification is PASSIVE_NFE
        TRUSTSIMILAR_TO_TRUSTOTHER
      • securities_market string
        Established securities market when classification is ACTIVE_NFE_PUBLIC_CORPORATION
      • related_corporation string
        Name of related corporation if affiliated with a publicly traded corporation
      • controlling_persons array of objects
        Controlling persons for Passive NFE or managed investment entity
        controlling_persons object
        • name string
          Full name of the controlling person
        • address object
          Shared tax address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
          address object
          • Same shape as TaxAddress.
        • mailing_address object
          Shared tax address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
          mailing_address object
          • Same shape as TaxAddress.
        • mailing_address_is_different boolean
          Indicates if the mailing address differs from the permanent address
        • date_of_birth string
          Date of birth of the controlling person (YYYY-MM-DD)
        • city_of_birth string
          City of birth of the controlling person
        • country_of_birth string enum
          Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name).
          ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
        • country_of_citizenship string enum
          Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name).
          ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
        • ownership_percentage number
          Percentage of ownership or control
        • residence_by_investment_confirmed boolean
          Confirms whether tax residency includes any CBI/RBI program
        • role string enum
          Role of the controlling person in controlling the entity
          SETTLORTRUSTEEPROTECTORBENEFICIARYOTHERSETTLOR_EQUIVALENTTRUSTEE_EQUIVALENTPROTECTOR_EQUIVALENTBENEFICIARY_EQUIVALENTOTHER_EQUIVALENTOWNEROTHER_MEANSSENIOR_MANAGING_OFFICIAL
        • role_other string
          Description when role is OTHER
        • role_other_equivalent string
          Description when role is OTHER_EQUIVALENT
        • tax_residences array of objects
          Tax residences of the controlling person
          tax_residences object
          • Same shape as SelfCertificationTaxResidence.
      • signature_capacity string enum
        Capacity in which the representative is signing
        OFFICEREXECUTOROTHER_CAPACITY
      • signature_capacity_other string
        Description when signature_capacity is OTHER_CAPACITY
      • giin string
        Global Intermediary Identification Number (GIIN)
      • residence_by_investment_confirmed boolean
        Confirms whether tax residency information includes any CBI/RBI program
      • signature string
        Electronic signature of the signer
      • active_non_financial_entity_type string enum
        Derived active NFE subtype
        OTHERINTERNATIONAL_ORGANIZATIONGOVERNMENT_ENTITYCENTRAL_BANKPUBLIC_CORPORATION
      • financial_institution_type string enum
        Derived financial institution subtype
        DEPOSITORY_INSTITUTIONCUSTODIAL_INSTITUTIONINVESTMENT_ENTITYINSURANCE_COMPANYNON_REPORTING_FINANCIAL_INSTITUTION
      • investment_entity_managed boolean
        Indicates whether the investment entity is professionally managed
      • is_individual boolean
        Indicates whether the account owner is an individual
      • self_certification_account_type string enum
        Derived entity account category
        FINANCIAL_INSTITUTIONPASSIVE_NON_FINANCIAL_ENTITYACTIVE_NON_FINANCIAL_ENTITY
      • id string uuid required
        Unique UUID for the collected Self-Certification
      • document_type string enum required
        Document type (SELF_CERTIFICATION)
        SELF_CERTIFICATION
      • address object
        Shared tax address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
        address object
        • Same shape as TaxAddress.
      • has_certified boolean
        Indicates whether the self-certification has been certified
      • mailing_address_is_different boolean
        Indicates if the mailing address is different from the permanent address
      • created_at string
        ISO 8601 timestamp when the Self-Certification documentation was recorded
      • submission_id string uuid
        Submission UUID for the Self-Certification
      • revision number
        Revision number of the Self-Certification submission
      • is_derived_signature boolean
        Indicates whether the signature was derived
      • tax_id_format_validation_results object
        TIN format validation results
        tax_id_format_validation_results object
        • results array of objects
          results object
          • country_code string
          • masked_value string
          • type string
          • validation_result string
    • dps object
      Collected Digital Platform Seller (DPS) data
      dps object
      • id string uuid required
        Unique UUID for the collected DPS documentation
      • name string required
        Legal name of the enterprise
      • document_type string enum required
        Document type (DPS)
        DPS
      • is_individual boolean required
        Indicates if the taxpayer is an individual
      • is_confirmed_correct_complete boolean required
        Indicates if the taxpayer confirmed accuracy of the information
      • address object
        Shared tax address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.
        address object
        • Same shape as TaxAddress.
      • business_registration_country string enum
        Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name).
        ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
      • business_registration_number string
      • city_of_birth string
      • country_of_birth string enum
        Country identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name).
        ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
      • date_of_birth string
      • financial_account_identifier string
      • financial_account_name string
      • tax_residences array of objects
        tax_residences object
        • country string
        • tin string
        • tin_not_required boolean
      • vatin string
      • vatin_country string
      • vatin_not_required boolean
400
400

Response Body

object

  • error string required
    Error message describing the validation failure
  • message string required
    Details of why the request was rejected
  • issues array of objects
    Per-field validation failures when the request body fails schema validation
    issues object
    • <key> object
401
401

Response Body

object

  • error string
    Error name for the rejected request
  • message string required
    Reason the request was rejected
403
403

Response Body

object

  • error string
    Error message when the caller lacks permission on the enterprise
  • message string
    Explicit deny message
404
404

Response Body

object

  • error string required
    Error message indicating the resource was not found
  • message string required
    Which resource could not be found
429
429

Response Body

object

  • error string required
    Error code emitted when the caller exceeds the rate limit
  • message string required
    How long to wait before retrying
500
500

Response Body

object

  • error string required