Skip to main content
Version: 1.7.3

Create

POST PortalCustomization/Create 
Run in Postman

Request Body

FieldTypeDescription
BusinessLogoUrlStringOptional Gets the Business Logo. If given the business logo will be shown in the Iframe page.
Size Range: ..150
FavIconUrlStringOptional Gets the Fav Icon. If given the fav icon will be shown in the Iframe page.
Size Range: ..150
LogoPositionStringOptional The position where your business logo will be placed on the page.
Allowed values

“LEFT”, “CENTER”, “RIGHT”

PrimaryColorStringThe color theme of the iframe page will be customized with this primary color.
SecondaryColorStringThe color theme of the iframe page will be customized with this secondary color.
InterviewFlowBooleanOptional As an alternative to direct-form entry, provide your recipients with an interview-style W-9/W-8 completion.
ShowDownloadPageBooleanOptional If TRUE, will provide an option for your payees to download their form.

Request JSON

{
"BusinessLogoURL": "https://www.spanenterprises.com/Content/Images/span.png",
"FavIconURL": "https://expressirsforms.s3.amazonaws.com/UserFiles/FormW9Customisation/0b0b2cf6-5577-48f4-bb73-f3ae6d354257_2082_images5.png",
"LogoPosition": "RIGHT",
"PrimaryColor": "#1BE4BB",
"SecondaryColor": "#F04C10",
"InterviewFlow": true,
"ShowDownloadPage": true
}

Response Body

FieldTypeDescription
CustomizationIdGuidA unique customization identifier generated by TaxBandits.You can use this ID in your RequestByEmail or RequestByUrl methods to reflect the customizations on the W-9/W-8 completion secure URL
CustomizationNmNameA unique customization name generated by TaxBandits
Errorsobject[]Collection of errors
   IdstringError ID number. This ID is assigned by TaxBandits and it is unique for each error.
    NamestringName of the errored node.
    MessagestringShows the error message

Response JSON

{
"CustomizationId": "36dda233-4454-470c-a76c-acbb168524f2",
"CustomizationNm": "Customization 18",
"Errors": null
}