Customization Options

You can customize the following components of the W8BEN page using Drop-in UI.

Requester

Field	Description
PayerRef (String)	Optional A unique payer identifier you assigned to the payer (business) while creating them. Size Range: 1-50
BusinessId (Guid)	Optional TaxBandits unique business identifier. This ID is generated by TaxBandits after you create a payer (business) in your account using the Business endpoint. If you do not provide the BusinessId in the request, then the URL will be generated against the default business, i.e., the first business created in your account.
TIN (String)	Optional Taxpayer Identification Number. Use this as an alternative for BusinessId or PayerRef. Size Range: 9-11
DBAId (String)	Optional A unique Identifier for the DBA.
DBARef (String)	Optional A unique identifier for each DBA. This identifier can be used in future references for the DBA. Size Range: 1 - 50

Recipient

Field	Description
PayeeRef (String)	A unique identifier for each recipient completing the Form W8BEN, which can be used for future reference. Size Range: 1-50
Name (String)	Optional Recipient Name. This will be pre-filled on the Form. Size Range: ..40
Address (Object)	Address of the recipient.
Address1 (String)	Optional Recipient's foreign address (street address or post office box of that locality). This will be pre-filled on the Form. Size Range: ..50
Address2 (String)	Optional Recipient's suite or apartment. This will be pre-filled on the Form. Size Range: ..50
City (String)	Optional Recipient US City. This will be pre-filled on the Form. Size Range: ..50
ProvinceOrStateNm (String)	Optional Recipient's Province or State Name. This will be pre-filled on the Form. Size Range: 50
Country (String)	Optional Recipient's country code. Refer Static values. This will be pre-filled on the Form. Size Range: 2 Allowed values "AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"
PostalCd (String)	Optional Recipient's Postal Code. This will be pre-filled on the Form. Size Range: 16

Customization

Textbox dropdown

All style variables in this section are nested under “TextboxDropdown”.

Field	Description
FontColor (string, Default: #212529)	The color of the input text
Border (string, Default: #0000008a)	The border color of the textbox and dropdown
BorderFocus (string, Default: #86b7fe)	Color of the textbox and dropdown when in focus
BorderRadius (string, Default: 0.375rem)	Shape of the textbox and dropdown

Button

All style variables in this section are nested under “Button”.

Field	Description
Primarycolor (string, Default : #f26d21)	The color of the primary buttons, such as Continue, Download, etc.
Secondarycolor (string, Default : #3097f3)	The color of secondary buttons is such as Cancel.
Fontcolor (string, Default : #000)	The color of the button text

Label

All style variables in this section are nested under the “Label”.

Field	Description
Color (string, Default : #949494)	Color of the label text

Hyperlink Color

All style variables in this section are nested under the “Link”.

Field	Description
Color (string, Default : #3097f3)	Color of the hyperlink

Text

All style variables in this section are nested under the “Text”.

Field	Description
Heading (string, Default : #212529)	Color of the primary heading
SubHeading (string, Default : #000000de)	Color of the secondary heading
Para (string, Default : #000000de)	Color of the para and text color
HelpText (string, Default : #9e9e9e)	Color of the help text

RedirectUrls

Field	Description
ReturnUrl             (String)	Optional Return Redirection URL. Set the callback URL redirection once the recipient completes filling the Form W8BEN. Size Range: ..150
CancelUrl             (String)	Optional Cancel Redirection URL. Set the callback URL when the recipient clicks the cancel button on the Form W8BEN. Note: If you do not provide this URL, the cancel button will not be shown to the recipient. Size Range: ..150