GetPDF
GetPDF
This endpoint can be used to generate the PDF copies of the completed Form 1099-NEC. You can request the PDFs using any of the following:
- SubmissionId only – To generate PDFs for all records under the submission.
- SubmissionId with RecordIds – To generate PDFs for specific recipient records.
How it works
- Once the request is processed successfully, a webhook will be triggered containing the download link(s).
- A separate ZIP file will be generated for each record. Each ZIP file will include copies of the recipient’s form.
- The files are not encrypted and can be downloaded directly. For security, the download link will expire in 24 hours after Webhook delivery.
- You can also choose the TIN masking option, allowing the recipient’s TIN to be either masked or unmasked based on your preference.
GET Form1099NEC/GetPDF Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | A unique identifier of a submission |
| RecordIds | Guid[] | Optional A unique identifier of a record. |
| TINMaskType | string | Optional Choose the masking type of your Recipient's TIN on the 1099-NEC PDF. MASKED - The recipient's TIN will be masked in the PDF. Only the last 4 digits of the TIN will be visible. UNMASKED - The recipient's TIN will not be masked in the PDF. To protect the PII information of the Recipient, the PDF is password-protected. Use the Recipient's TIN (password) to open the protected file. BOTH - Two PDFs will be delivered for each recipient. One with Masked TIN and the other with Unmasked TIN. The PDF with unmasked TIN will be password-protected. Use the Recipient's TIN (password) to open the protected file. Allowed valuesAllowed values: "MASKED", "UNMASKED", "BOTH" |
Response Body
| Field | Type | Description |
|---|---|---|
| StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
| StatusName | string | Name of the status code |
| StatusMessage | string | Detailed status message |
| SubmissionId | Guid | A unique identifier of a submission |
| Form1099NecRecords | object[] | Collection of Form 1099-NEC records for which the PDF will be successfully delivered |
| RecordId | Guid | A unique identifier of a record |
| Message | string | Provides additional information regarding the PDF delivery. |
| 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 Params
"Form1099NEC/GetPdf?SubmissionId=9d71ae45-df5f-49f7-86f8-e88f54132fa1&RecordIds=01132f6d-ef4a-4014-817e-94a5a19bd52b,eb39714e-f653-4c4d-a53c-07f24f9a9dj5&TINMaskType=UNMASKED"
Response JSON
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "9d71ae45-df5f-49f7-86f8-e88f54132fa1",
"Form1099NecRecords": [
{
"RecordId": "01132f6d-ef4a-4014-817e-94a5a19bd52b",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
},
{
"RecordId": "eb39714e-f653-4c4d-a53c-07f24f9a9dj5",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF."
}
],
"Errors": null
}