RequestByEmail
RequestByEmail
Use this endpoint to send an e-sign request to the clients via email. Once they e-sign, the paid preparer will be prompted to e-sign it and proceed with the filing.
How it works:
-
Create Return - Use the 'Form94X/Create' endpoints to create the 94x forms.
-
Send Request - Use the 'Form8453EMP/RequestByEmail' endpoint to send an e-sign request to the respective client via email.
-
Get Notified - Receive a webhook notification once the client e-signs the return. (You must have configured the webhook for the event type 'Form8453-EMP Status Change' to receive this notification). You can also use the Status endpoint to retrieve the status.
-
Add Paid Preparer Signature - Once the client e-signs, an email will be sent to the paid preparer’s email address you’ve provided, prompting them to sign the 8453-EMP form. You will be notified via Webhooks once the signature process is complete.
POST Form8453EMP/RequestByEmailRequest Body
| Field | Type | Description |
|---|---|---|
| RecordId | Guid | A Unique Record Identifier generated by TaxBandits when a 94X return is created |
| TaxPayerEmail | string | Email Address of the taxpayer. Note: Taxpayer will be requested to E-sign Form 8453-EMP through this email address Size Range: ..100 |
| TaxPreparerEmail | string | Email Address of the tax preparer. Note: Signed 8453-EMP form will be sent to the tax preparer’s email after the taxpayer signs. Size Range: ..100 |
| CustomizationId | Guid | Optional A unique customization identifier generated by TaxBandits after you complete the customization in the console. Note: This service will be available soon. |
| Customization | object | Optional Collects the customizations like Business Logo, PrimaryColor, SecondaryColor, etc. |
| BusinessLogoUrl | string | Optional Business Logo that will be displayed on the Form completion page. Size Range: ..150 |
| LogoPosition | String | Optional Gets the position in which the logo should be displayed. Allowed values"LEFT", "CENTER", "RIGHT" |
| PrimaryColor | String | Optional Gets the primary color for the portal. You can use this to customize the color theme of the portal to match with your application color |
| SecondaryColor | String | Optional Gets the secondary color for the portal. You can use this to customize the color theme of the portal to match with your application color |
Response Body
| Field | Type | Description |
|---|---|---|
| RecordId | Guid | A Unique Record Identifier generated by TaxBandits when a 94X return is created |
| RecordStatus | String | Status of Form 8453-EMP |
| StatusMessage | String | Shows detailed Status message of Form 8453-EMP |
| Errors | object[] | Detailed error information. |
| Id | string | Error ID number. This ID is assigned by TaxBandits and it is unique for each error. |
| Name | string | Name of the errored node. |
| Message | string | Shows the error message. |
Request Json
{
"RecordId": "0a148914-1125-4cf3-a48a-5ce8b750693e",
"TaxPayerEmail": "shawn@sample.com",
"TaxPreparerEmail": "peter@sample.com",
"CustomizationId": null,
"Customization": {
"BusinessLogoUrl": "https://www.spanenterprises.com/Content/Images/span.png",
"LogoPosition": "LEFT",
"PrimaryColor": "#20DEE5",
"SecondaryColor": "#8C1FCB"
}
}
{
"RecordId": "0a148914-1125-4cf3-a48a-5ce8b750693e",
"RecordStatus": "E-Sign Requested",
"StatusMessage": "Sign Requested to the Payer",
"Errors": null
}