Skip to content

Reference

Enumerations

This page consolidates the business enumerations used by tax information collection APIs so they can be referenced consistently in request parameters, response fields, and status notifications.

Shared DefinitionsTax Info Collection

taxType

ValueDescription
TAX1099NEC1099-NEC reporting

formType

ValueDescription
W9W-9
W8BENW-8BEN
W8BENEW-8BEN-E
W8ECIW-8ECI
W8EXPW-8EXP
W8IMYW-8IMY
UNKNOWNNo form type is specified when the link is created. After visiting the link, the payee chooses from the supported real form types
UNIONRestrict payee form options. Set the available form types via availableFormTypes when creating the link. The payee can only choose from those types.

availableFormTypes

FieldDescription
availableFormTypesUsed only when formType=UNION. The value is the list of form types the payee can choose from for this link

Constraints

  • Each item must be a real form type from the formType enumeration
  • UNKNOWN and UNION are not allowed in availableFormTypes

deliveryMode

ValueDescription
LINKReturn the collection link directly and let the merchant distribute it
EMAILThe platform sends the collection link to the specified email address

formStatus

ValueDescription
MISSINGThe payee has not submitted tax information yet
PENDING_VERIFICATIONThe form has been submitted and verification is in progress
READYTax information collection and verification are complete, and downstream business processing can continue, such as allowing withdrawals
FAILEDVerification failed
EXPIREDExpired