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] Form1099C/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 Form1099C/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 PDFAllowed 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": "1afc099e-2374-4fc7-834b-6a17ef721837", "Business": null, "Recipient": null}
Response JSON 1
{ "RecordId": "1afc099e-2374-4fc7-834b-6a17ef721837", "RecipientId": "4669d8f4-32ba-4c29-85b5-88bb453dcdf8", "PayeeRef": null, "DraftPdfUrl": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/d287dd64-5c11-4ba0-866e-e5f600a72296/1099/901294/d/copy_draft_1up_632139993.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": "4669d8f4-32ba-4c29-85b5-88bb453dcdf8", "PayeeRef": null, "TINType": null, "TIN": null }}
Response JSON 2
{ "RecordId": "1afc099e-2374-4fc7-834b-6a17ef721837", "RecipientId": "4669d8f4-32ba-4c29-85b5-88bb453dcdf8", "PayeeRef": null, "DraftPdfUrl": "https://expressirsforms.s3.us-east-1.amazonaws.com/pdfs/7dbfa93b-1b4e-4870-a875-b3636d875522/d287dd64-5c11-4ba0-866e-e5f600a72296/1099/901294/d/copy_draft_1up_632139993.pdf", "Error": null}