RequestDraftPdfUrl
RequestDraftPdfUrl
This endpoint can be used to retrieve the Draft PDF URL and Draft PDF Path of a Form 1099-NEC 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’.
POST Form1099NEC/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"2023","2024","2025" |
| Business | object | Optional The business identifier, such as TIN, BusinessId, or PayerRef. This object information is required only if you do not have the RecordId |
| BusinessId | Guid | Optional TaxBandits A unique business identifier. This ID is generated by TaxBandits after you create a business in your account using the Business endpoint. |
| PayerRef | string | Optional A unique identifier for each recipient set by you. 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 A unique identifier for each recipient set by you. Size Range: 1 to 50 |
| RecipientId | Guid | Optional A 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. Size Range: 9 to 11 |
Response Body
| Field | Type | Description |
|---|---|---|
| RecordId | Guid | A unique identifier of the record |
| RecipientId | Guid | A unique recipient identifier generated by TaxBandits |
| PayeeRef | string | A unique identifier for each recipient set by you. |
| 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 |
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.
Payload
Node.js
Python
Java
.NET C#
Request Json
| Sample | Description | Action |
|---|---|---|
| Sample 1 | To generate Draft PdfUrl With just the RecordId | |
| Sample 2 | To generate Draft PdfUrl With No RecordId. |
Sample 1
{
"TaxYear": null,
"RecordId": "cf0a188b-6661-4b57-b04b-ba9ead52a16e",
"Business": null,
"Recipient": null
}
Response Json
| 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
}