REST API›Enterprise›Tax

POST

Submits IRS Form W-9 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}$

Body Params

object

Form W-9 submission payload.
  • 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 required
    Legal name of the individual or entity (Box 1)

    at least 1 characters

  • dba_name string
    Business name / disregarded entity name, if different from above (Box 2)
  • tax_classification string enum required
    Federal tax classification of the person or entity (Box 3a)
    INDIVIDUALC_CORPORATIONS_CORPORATIONPARTNERSHIPTRUST_ESTATELLC_CLLC_PLLC_SSOLE_PROPRIETOROTHER
  • other_tax_classification string
    Description required when tax_classification is OTHER

    at least 1 characters

  • address object required
    Required physical address for IRS tax form submissions (first_line, city, postal_code, and country required; 2-letter state_or_province required for US and CA).
    address object
    • first_line string required
      First line of the address

      at least 1 characters

    • second_line string
      Second line of the address
    • city string required
      City

      at least 1 characters

    • state_or_province string
      State or province (required 2-letter postal code when country is US or CA, e.g. WA or ON)

      at least 1 characters

    • postal_code string required
      Postal code

      at least 1 characters

    • country string enum required
      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 required
    Taxpayer Identification Number (SSN, EIN, ITIN, or ATIN) (Part I)

    at least 1 characters

  • tin_type string enum required
    Type of Taxpayer Identification Number (SSN, EIN, ITIN, or ATIN)
    SSNEINITINATIN
  • exempt_payee_code string enum
    Exempt payee code (Box 4, if applicable)
    12345678910111213
  • exempt_fatca_code string enum
    Exemption from FATCA reporting code (Box 4, if applicable)
    ABCDEFGHIJKLM
  • is_not_subject_backup_withholding boolean
    Certifies that the taxpayer is not subject to backup withholding
  • has_signed_and_certified boolean enum required
    Must be true to certify that the taxpayer has signed and certified the W-9 under penalties of perjury (Part II)
    true
  • signature_timestamp string date-time required
    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 required
    Electronic signature of the person certifying the form

    at least 1 characters

Responses

201
201

Response Body

object

Response returned upon successful Form W-9 submission.
  • data object required
    Form W-9 data returned in submission and retrieval responses.
    data 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
    • 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
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
409
409

Response Body

object

  • error string required
    Error message indicating a tax form was already submitted for the current tax year
  • message string required
    Details of the existing submission conflict
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