Create
Create
Use this endpoint to apply your own branding to the secure URL (form page) sent to recipients for W-9/W-8 form completion or to clients for e-signing Form 8453-EMP.
In your request JSON, include branding elements like your business logo, favicon, and color theme. For W-8/W-9 forms, you can also specify your preferred form entry method (e.g., Interview flow).
For each customization you create, you'll receive a unique CustomizationId. You can create multiple customizations if needed.
POST PortalCustomization/Create Request Body
| Field | Type | Description |
|---|---|---|
| BusinessLogoUrl | String | Optional If given, the business logo will be displayed in the Iframe page Size Range: ..150 |
| FavIconUrl | String | OptionalIf given, the favicon will be shown in the Iframe page Size Range: ..150 |
| LogoPosition | String | Optional The position where your business logo will be placed on the pageAllowed values“LEFT”, “CENTER”, “RIGHT” |
| PrimaryColor | String | The color theme of the iframe page will be customized with this primary color |
| SecondaryColor | String | The color theme of the iframe page will be customized with this secondary color |
| InterviewFlow | Boolean | Optional As an alternative to direct form entry, you can offer recipients an interview-style method to complete the W-9 or W-8 form |
| ShowDownloadPage | Boolean | Optional If set to TRUE, recipients will be given the option to download their completed form |
Response Body
| Field | Type | Description |
|---|---|---|
| CustomizationId | Guid | A unique customization identifier generated by TaxBandits. You can use this ID in your RequestByEmail, RequestByBusinessUrl, or RequestByURL methods |
| CustomizationNm | string | A unique customization name generated by TaxBandits |
| Errors | object[] | Details about any errors occurred |
| Id | string | The unique error ID assigned by TaxBandits for each error |
| Name | string | Name of the node where the error occurred |
| Message | string | Displays the error message |
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": "#00FF00",
"SecondaryColor": "#FF00FF",
"InterviewFlow": true,
"ShowDownloadPage": true
}
Response JSON
{
"CustomizationId": "94fd3f4e-69f5-40a9-bc27-a31d2364a1c4",
"CustomizationNm": "Customization 01",
"Errors": null
}