RequestDraftPdfUrls
RequestDraftPdfUrls
This endpoint retrieves Draft PDF copies of a Form 1099/W-2 for a single recipient or multiple recipients. Request the Draft PDF URLs by providing the RecordId associated with the returns.
GET form1099w2/requestdraftpdfurls Request Body
| Field | Type | Description |
|---|---|---|
| RecordId | string | A unique identifier generated by TaxBandits when a return is created. Mention the return's RecordId that you want to request draft PDF. |
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 JSON
| Sample | Description | Action |
|---|---|---|
| Sample 1 | Request Draft PDF URLs for generated Form 1099/W-2 returns using RecordId. |
Sample 1
"v2/form1099w2/requestdraftpdfurl?recordid=9e47bb81-4fe0-4ef9-878a-a136c5cd0033"
Response JSON
| Sample | Description | Action |
|---|---|---|
| 200 | Success Response - This is a sample response for successful API requests. |
Response: 200
{
"RecordId": "9e47bb81-4fe0-4ef9-878a-a136c5cd0033",
"RecipientId": "bcf7a877-c6d3-41a4-a67b-65487b1a99c9",
"PayeeRef": "Pe7634",
"DraftPdfUrl": "https://expressirsforms.com.s3.us-east-1.amazonaws.com/pdfs/2f44c904-024f-4f82-80ac-224657826b35/8148f2d3-6cdd-449b-89bb-f357340e2523/1099/12564312/d/Single_Draft.pdf",
"DraftPdfPath": "pdfs/2f44c904-024f-4f82-80ac-224657826b35/8148f2d3-6cdd-449b-89bb-f357340e2523/1099/12564312/d/Single_Draft.pdf",
"Error": null
}