Skip to main content
Version: 1.7.3

RequestDraftPdfUrl

The response of the API request will return the Draft PDF for review purpose. This method can be used to retrieve PDF for a single record/form.

The PDF will be returned in the response for the Forms that are not yet Transmitted in TaxBandits.

This method will only provide the Copy A of the Form 1099 and it will have a watermark "For Review only" on it.

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 Form1099NECCorrection/Create to create a return in TaxBandits. Store the RecordId of the 1099 form that is generated by TaxBandits and returned in the Response

  3. Next, call the [POST] Form1099NECCorrection/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 Form1099NecCorrection/RequestDraftPdfUrl 
Run in Postman

Request Body

FieldTypeDescription
TaxYearGuidOptional Tax year of Form 1099 NEC Correction to be filed.
Allowed values: "2023"
RecordIdGuidOptional Specify the RecordId of the return
BusinessobjectOptional Collects the Business identifier TIN or TBS Business Id or PayerRef. This object information is required only if you do not have the RecordId
    BusinessIdGuidOptional Unique identifier of a Business.
    PayerRefstringOptional 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: 50
    TINTypestringOptional Recipient's TIN Type
    TINstringOptional Recipient's TIN
RecipientobjectOptional Collects the recipient's unique identifier. This object information is required only if you do not have the RecordId
    PayeeRefstringOptional An unique identifier for each recipient set by the client.
Size Range: 1 to 50
    RecipientIdGuidOptional Unique identifier of the Recipient.
    TINTypestringOptional TIN type of the Recipient’s TIN. Use this as an alternative for RecipientId or PayeeRef.
Allowed values: "SSN,EIN"
    TINstrinOptional Taxpayer Identification Number. Use this as an alternative for RecipientId or PayeeRef.

Request JSON

{
"TaxYear": "2023",
"RecordId": null,
"TINMaskType": "MASKED",
"Business": {
"BusinessId": "fab793ee-4c45-48b1-b895-47d73c066f7c",
"PayerRef": null,
"TINType": null,
"TIN": null
},
"Recipient": {
"RecipientId": "421c1d2c-cb3c-448d-bd88-ac6a7f0aadd0",
"PayeeRef": null,
"TINType": null,
"TIN": null
}
}

Response Body

FieldTypeDescription
RecordIdGuidUnique identifier of the record
RecipientIdGuidUnique Recipient Identifier generated by TaxBandits
PayeeRefstringAn unique identifier for each recipient set by the client.
DraftPdfUrlstringURL of the Draft PDF
DraftPdfPathstringStorage path of the draft PDF
Errorsobject[]Shows detailed error information
    IdstringReturns the validation error code
    NamestringName of the validation error
    MessagestringDescription of the validation error

Response JSON

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

 {
"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.