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?
-
Call the [POST] Form1099PATR/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 Form1099PATR/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 . Allowed values: "2022","2023","2024" |
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. |
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 |
- Payload
- Node.js
- Python
- Java
- .NET C#
Sample | Description | Action |
---|---|---|
Sample 1 | With just the RecordId | |
Sample 2 | To generate Draft PdfUrl With No RecordId. |
Sample 1
{
"TaxYear": null,
"RecordId": "7dc8bea4-97b1-42fd-adf4-ac8537abbeb1",
"Business": null,
"Recipient": null
}
Response | Description | Action |
---|---|---|
Response 1 | Draft PdfUrl will be generated for the given RecipientId. | |
Response 2 | Draft PdfUrl will be generated for the given BusinessID and RecipientId. |
Response 1
{
"RecordId": "5ce0a501-ddcd-4b23-af7c-c836bc434bda",
"RecipientId": "ba15c63a-e191-4dbc-9156-457f0980052e",
"PayeeRef": null,
"DraftPdfUrl": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/c2d66a8c-3cf3-4dbc-9095-38b92fc58866/0927361d-25ec-47d5-9c37-7a239ec6a2fa/1099/19455581/d/copy_tbs_wm_1up_9455960000.pdf",
"DraftPdfPath": "pdfs/c2d66a8c-3cf3-4dbc-9095-38b92fc58866/0927361d-25ec-47d5-9c37-7a239ec6a2fa/1099/19455581/d/copy_tbs_wm_1up_9455960000.pdf",
"Error": null
}
PDF Security
The PDFs contain PII (Personally Identifiable Information) data of the recipients. To make sure that the PII data involved is completely secured, TaxBandits has added additional security to the form PDFs.
The PDF links you get in the Response are encrypted, and you will have to decrypt them before downloading.
Refer to this link for the steps to decrypt PDF with Sample codes.