POST
Submit Form W-9 Tax Documentation
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
-
enterpriseIdstring requiredThe enterprise ID to get a token for
Body Params
object
Form W-9 submission payload.
-
e_delivery_consentboolean requiredRequired 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). -
namestring requiredLegal name of the individual or entity (Box 1) -
dba_namestringBusiness name / disregarded entity name, if different from above (Box 2) -
tax_classificationstring enum requiredFederal tax classification of the person or entity (Box 3a)INDIVIDUALC_CORPORATIONS_CORPORATIONPARTNERSHIPTRUST_ESTATELLC_CLLC_PLLC_SSOLE_PROPRIETOROTHER -
other_tax_classificationstringDescription required when tax_classification is OTHER -
addressobject requiredRequired 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_linestring requiredFirst line of the address -
second_linestringSecond line of the address -
citystring requiredCity -
state_or_provincestringState or province (required 2-letter postal code when country is US or CA, e.g. WA or ON) -
postal_codestring requiredPostal code -
countrystring enum requiredCountry identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name).ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
-
-
tinstring requiredTaxpayer Identification Number (SSN, EIN, ITIN, or ATIN) (Part I) -
tin_typestring enum requiredType of Taxpayer Identification Number (SSN, EIN, ITIN, or ATIN)SSNEINITINATIN -
exempt_payee_codestring enumExempt payee code (Box 4, if applicable)12345678910111213 -
exempt_fatca_codestring enumExemption from FATCA reporting code (Box 4, if applicable)ABCDEFGHIJKLM -
is_not_subject_backup_withholdingbooleanCertifies that the taxpayer is not subject to backup withholding -
has_signed_and_certifiedboolean enum requiredMust be true to certify that the taxpayer has signed and certified the W-9 under penalties of perjury (Part II)true -
signature_timestampstring date-time requiredISO 8601 timestamp when the form was signed -
completed_forstring enumWhether the form was completed for the ACCOUNT_HOLDER or REGARDED_OWNERACCOUNT_HOLDERREGARDED_OWNER -
signaturestring requiredElectronic signature of the person certifying the form
Responses
201
201
Response Body
object
Response returned upon successful Form W-9 submission.
-
dataobject requiredForm W-9 data returned in submission and retrieval responses.data object
-
e_delivery_consentboolean requiredRequired 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). -
namestringLegal name of the individual or entity -
dba_namestringBusiness name / disregarded entity name, if different from above -
tax_classificationstring enumFederal tax classification of the person or entityINDIVIDUALC_CORPORATIONS_CORPORATIONPARTNERSHIPTRUST_ESTATELLC_CLLC_PLLC_SSOLE_PROPRIETOROTHER -
other_tax_classificationstringDescription when tax_classification is OTHER -
addressobjectShared tax address object used across W-9, W-8BEN, W-8BEN-E, and Self-Certification.address object
-
first_linestringFirst line of the address -
second_linestringSecond line of the address -
citystringCity -
state_or_provincestringState or province (must be a 2-letter postal code when country is US or CA) -
postal_codestringPostal code -
countrystring enumCountry identifier (ISO 3166-1 alpha-2 code, IRS-only code, or territory name).ADAEAFAGAIALAMANAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZWXKFQIPDXHQDQJQKQOCLQWQWZAKROTIRIASHMORE AND CARTIER ISLANDSBURMACORAL SEA ISLANDSEAST TIMORMIDWAY ISLANDSNAVASSA ISLANDPARACEL ISLANDSSPRATLY ISLANDSSVALBARD
-
-
tinstringMasked or unmasked Taxpayer Identification Number -
tin_typestring enumType of Taxpayer Identification NumberSSNEINITINATIN -
exempt_payee_codestring enumExempt payee code (if applicable)12345678910111213 -
exempt_fatca_codestring enumExemption from FATCA reporting code (if applicable)ABCDEFGHIJKLM -
is_not_subject_backup_withholdingbooleanCertifies that the taxpayer is not subject to backup withholding -
has_signed_and_certifiedbooleanIndicates that the taxpayer has signed and certified the W-9 under penalties of perjury -
signature_timestampstringISO 8601 timestamp when the form was signed -
completed_forstring enumWhether the form was completed for the ACCOUNT_HOLDER or REGARDED_OWNERACCOUNT_HOLDERREGARDED_OWNER -
signaturestringElectronic signature of the person certifying the form
-
400
400
Response Body
object
-
errorstring requiredError message describing the validation failure -
messagestring requiredDetails of why the request was rejected -
issuesarray of objectsPer-field validation failures when the request body fails schema validationissues object
-
<key>object
-
401
401
Response Body
object
-
errorstringError name for the rejected request -
messagestring requiredReason the request was rejected
403
403
Response Body
object
-
errorstringError message when the caller lacks permission on the enterprise -
messagestringExplicit deny message
404
404
Response Body
object
-
errorstring requiredError message indicating the resource was not found -
messagestring requiredWhich resource could not be found
409
409
Response Body
object
-
errorstring requiredError message indicating a tax form was already submitted for the current tax year -
messagestring requiredDetails of the existing submission conflict
429
429
Response Body
object
-
errorstring requiredError code emitted when the caller exceeds the rate limit -
messagestring requiredHow long to wait before retrying
500
500
Response Body
object
-
errorstring required