RequestDraftPdfUrl

RequestDraftPdfUrl

This endpoint can be used to retrieve the Draft PDF of a Form W-2G corrections for review purposes. This method supports retrieving the PDF for a single record/form.

Key points

• The PDF is returned only for forms that have not yet been transmitted in TaxBandits.
• This method provides Copy A of the form, which will include a watermark stating ‘For Review Only’.

How does it work?

1. The first step is to call the Auth method to get the access token. This access token must be supplied in the request header as the 'Bearer' token. Refer to OAuth 2.0 Authentication for more information on JWT authentication and how to integrate with the subsequent requests.
2. The second step is to call the Create endpoint FormW2GCorrection/Create to create a return in TaxBandits. Store the RecordId of the W-2G correction form that is generated by TaxBandits and returned in the response.
3. Next, call the [POST] FormW2GCorrection/RequestDraftPdfUrl endpoint. You will need to supply the following parameters:
   • Access Token in the header as Bearer Token (Generated using TaxBandits OAuth authentication API)
   • Form reference (RecordId): 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 for.

POST FormW2GCorrection/RequestDraftPdfUrl 

Run in Postman

Request Body

Field	Type	Description
TaxYear	string	Optional Tax year of Form W-2G Correction to be filed. Allowed values "2025"
RecordId	Guid	Optional Specify the RecordId of the return.
Business	object	Optional Collects Collects the Business identifier TIN, or Business Id, or PayerRef. This object information is required only if you do not have the RecordId
BusinessId	Guid	Optional Unique identifier of a Business.
PayerRef	string	Optional An unique identifier for each payer completing their information. This identifier can be used in future references of the payer in the API. Size Range: 1-50
TINType	string	Optional TIN type of the business
TIN	string	Optional payer’s TIN.
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 identifier of the Recipient.
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. Size Range: 9-11

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
DraftPdfPath	string	Storage path 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 Params

{
    "TaxYear": "2025",
    "RecordId": "97c9ba31-c244-4aeb-addc-f1b53be373fc",
    "TINMaskType": "MASKED",
    "Business": {
        "BusinessId": "794451d1-909a-4ffa-852a-fa567b391e15",
        "PayerRef": null,
        "TINType": null,
        "TIN": null
    },
    "Recipient": {
        "RecipientId": "815caa44-521e-48b4-a312-39ae5b15f148",
        "PayeeRef": null,
        "TINType": null,
        "TIN": null
    }
}

Response Json

Success Response - This is a sample response for successful API requests.

{
    "RecordId": "97c9ba31-c244-4aeb-addc-f1b53be373fc",
    "RecipientId": "815caa44-521e-48b4-a312-39ae5b15f148",
    "PayeeRef": null,
    "DraftPdfUrl": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/9f64ef0b-80f7-4c09-9d95-6f26109fa73e/794451d1-909a-4ffa-852a-fa567b391e15/w2gcorrection/3142166/d/Single_Draft.pdf",
    "DraftPdfPath": "pdfs/9f64ef0b-80f7-4c09-9d95-6f26109fa73e/794451d1-909a-4ffa-852a-fa567b391e15/w2gcorrection/3142166/d/Single_Draft.pdf",
    "Error": null
}