RequestByUrlPayer

RequestByUrlPayer

Use this endpoint to obtain a secure URL that can be embedded in your software or portal. Your clients can e-sign the 8453-EMP form upon clicking the URL.

This secure URL can be customized according to your preferences to elevate your own branding in the e-sign page. For more information, click here.

POST Form8453emp/RequestByURLPayer 

Run in Postman

Request Body

Field	Type	Description
RecordId	Guid	A Unique Record Identifier generated by TaxBandits when a 94X return is created.
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 Gets the Business Logo. If given the business logo will be shown in the Iframe 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
RedirectUrls	object	Optional Collects the Redirect Urls as ReturnUrl and CancelUrl
ReturnUrl	String	Optional Return Redirection URL. Set the callback URL redirection once the tax-payer completes Form 8453-EMP. Size Range: ..150
CancelUrl	String	Optional Cancel Redirection URL. Set the callback URL when the taxPayer clicks the cancel button on the Form 8453-EMP. Note: If you do not provide the Cancel Callback Redirection URL, the cancel button will not be shown to the Taxpayer. Size Range: ..150

Response Body

Field	Type	Description
RecordId	Guid	A Unique Record Identifier generated by TaxBandits when a 94X return is created.
Form8453EMPUrlPayer	String	URL that can be accessed on its own or embedded on the client's website using Iframe or other means.
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

Sample 1

{
"RecordId": "babf0c22-f13b-4d2a-ae6e-8022f4def4a2",
"CustomizationId": null,
"Customization": {
     "BusinessLogoUrl": "https://www.spanenterprises.com/Content/Images/span.png",
     "LogoPosition": "LEFT",
     "PrimaryColor": "#E61A1A",
     "SecondaryColor": "#18F244"
 },
"RedirectUrls": {
     "ReturnUrl": "https://example1.com",
     "CancelUrl": "https://example2.com"
}
}

Sample 2

{
"RecordId": "babf0c22-f13b-4d2a-ae6e-8022f4def4a2",
"CustomizationId": null,
"Customization": {
     "BusinessLogoUrl": "https://www.spanenterprises.com/Content/Images/span.png",
     "LogoPosition": "LEFT",
     "PrimaryColor": "#E61A1A",
     "SecondaryColor": "#18F244"
 },
"RedirectUrls": {
     "ReturnUrl": "https://example1.com",
     "CancelUrl": "https://example2.com"
}
}

Response JSON

Response 1

{
  "RecordId": "babf0c22-f13b-4d2a-ae6e-8022f4def4a2",
  "Form8453EMPUrlPayer": "https://tbs-links.stssprint.com/Form8453EMP/Form8453?tpatkn=64a7c02f-4866-4740-b0bb-06f5a89ad5dd",
  "Errors": null
}

Response 2

{
  "RecordId": "babf0c22-f13b-4d2a-ae6e-8022f4def4a2",
  "Errors": [
      {
          "Id": "F88-100014",
          "Name": "Payer Signed",
          "Message": "Cannot Request a new Form8453EMP since payer already signed"
      }
  ]
}