RequestDraftPdfUrl

This API request will return the Draft PDF of the forms that are not transmitted yet for review purpose. The draft PDF will have copy A of the form with For Review Only watermark text.

Note: You can only retrieve PDF of a single record/form using this method.

How does it works?

1. Call the [POST] FormW2G/RequestDraftPdfUrl endpoint. You will need to supply the following parameters:

   • Access Token in the header as Bearer Token (Generated using TaxBandits OAuth authentication API)

   • Request Parameters: Specify the RecordId for the form you need the Draft PDF form. If you do not have the RecordId, then you request the PDF using the following parameters

     • Business Reference - Use the business reference PayerRef or BusinessId or TIN.
     • Recipient Reference - Use the recipient reference PayeeRef or RecipientId or TIN.
     • Tax Year - Tax year of the form you are requesting the PDF.

POST FormW2G/RequestDraftPdfUrl

Request Body

Field	Type	Description
RecordId	Guid	Optional Specify the RecordId of the return
TINMaskType	string	Optional TIN Mask type on the TIN printed on the PDF Allowed values: "MASKED", "UNMASKED"
TaxYear	string	Optional Tax Year of the return. Specify only if you do not have the RecordId
Business	object	Optional Collects the Business identifier TIN or TBS Business Id or PayerRef. This object information is required only if you do not have the RecordId
BusinessId	Guid	Optional TaxBandits Unique Business Identifier. This ID is generated by TaxBandits after you create a business in your account using the Business endpoint.
PayerRef	string	Optional Unique payer identifier assigned by the client. Size Range: 1 to 50
TINType	string	Optional TIN type of the Business TIN. Use this as an alternative for BusinessId or PayerRef. Allowed values: "SSN,EIN"
TIN	string	Optional Taxpayer Identification Number. Use this as an alternative for BusinessId or PayerRef. Size Range: 9 to 11
Recipient	object	Optional Collects the recipient's unique identifier. This object information is required only if you do not have the RecordId
PayeeRef	string	Optional An unique identifier for each recipient set by the client. Size Range: 1 to 50
RecipientId	Guid	Optional Unique Recipient Identifier generated by TaxBandits
TINType	string	Optional TIN type of the Recipient’s TIN. Use this as an alternative for RecipientId or PayeeRef. Allowed values: "SSN,EIN"
TIN	string	Optional Taxpayer Identification Number. Use this as an alternative for RecipientId or PayeeRef.

Response Body

Field	Type	Description
RecordId	Guid	Unique identifier of the record
RecipientId	Guid	Unique Recipient Identifier generated by TaxBandits
PayeeRef	string	An unique identifier for each recipient set by the client.
DraftPdfUrl	string	URL of the Draft PDF
Errors	object[]	Shows detailed error information
Id	string	Returns the validation error code
Name	string	Name of the validation error
Message	string	Description of the validation error

Request JSON 1: With just the RecordId

{
  "TaxYear": null,
  "RecordId": "15430b5d-056a-4989-8293-6ce2905874c5",
  "Business": null,
  "Recipient": null
}

Response JSON 1

{
   "RecordId": "15430b5d-056a-4989-8293-6ce2905874c5",
   "RecipientId": "48e386a9-7e24-4780-966e-dc5835d0f4b0",
   "PayeeRef": null,
   "DraftPdfUrl": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/w2g/898299/d/copy_draft_1up_7695918535.pdf",
   "Error": null
}

Request JSON 2: With No RecordId

{
 "TaxYear": "2021",
 "RecordId": null,
 "Business": {
   "BusinessId": "94B6214D-8DCA-490C-8FC3-602840B439B5",
   "PayerRef": null,
   "TINType": null,
   "TIN": null
 },
 "Recipient": {
   "RecipientId": "6DDFFB5A-565F-402D-8602-7ECD917CEC04",
   "PayeeRef": null,
   "TINType": null,
   "TIN": null
 }
}

Response JSON 2

{
  "RecordId": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
  "RecipientId": "6DDFFB5A-565F-402D-8602-7ECD917CEC04",
  "PayeeRef": null,
  "DraftPdfUrl":"https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/1e9ed204-870f-4b61-acac-6c3ecf11abf6/w2g/898299/d/copy_draft_1up_7695918535.pdf",
  "Error": null
}