RequestPdfUrls
RequestPdfUrls
This endpoint retrieves PDF copies of a Form ACA for a single recipient or multiple recipients. Request the PDF URLs by providing the RecordId associated with the returns.
Key points
- This endpoint does not generate new PDFs - it only retrieves links to PDFs that already exist in the system.
- PDF URLs are returned only if they've already been generated by TaxBandits. This endpoint will not work for in-progress returns.
GET acaformutility/requestpdfurls Request Body
| Field | Type | Description |
|---|---|---|
| TINMaskType | string | Optional Mention whether you want the TIN to be masked in the PDF. If masked, only the last digits of the SSN will be visible and the rest of the digits will be crossed (xxx-xx-1234). Allowed values"MASKED", "UNMASKED", "BOTH" |
| RecordId | Guid[] | A unique identifier generated by TaxBandits when a return is created. Mention the return's Record ID that you want to delete. |
Response Body
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | A unique identifier of a submission. |
| FormType | string | Denotes the type of the form. |
| Form1095BRecords | object | Pulls the Form records with Success and Error statuses; the successful records with PDF URLs if the forms are generated. |
| RecordId | Guid | A unique identifier of the return. |
| Status | string | Status of the PDF in TaxBandits. Success - The PDF is generated, and you can download it. |
| Unmasked | string | Link to download the Unmasked copy |
| UnmaskedPath | string | The storage path of the unmasked TIN |
| Masked | string | Link to download the Masked copy |
| MaskedPath | string | The storage path of the masked TIN |
| ErrorRecords | object[] | Contains the error records |
| RecordId | Guid | Unique identifier of the return. |
| Status | string | Status of the error record.PDF_Not_Generated - PDF is yet to be generated. You will have to wait and send a new API request to get the PDF. Not Transmitted - The return is not transmitted yet. Invalid RecordId - Given record id is invalid |
| Message | string | Description of each status. |
| Errors | object[] | Lists the errors in the API call |
| Id | string | Returns the error ID. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
Payload
Request Params
| Sample | Description | Action |
|---|---|---|
| Sample 1 | Request PDF URLs using RecordId. |
Sample 1
acaformutility/requestpdfurls?RecordId=53eb195d-4914-4a14-9348-251a55909c1d
Response JSON
| Response | Description | Action |
|---|---|---|
| 200 | Success Response - You'll get the below response when the request is processed successfully. | |
| 400 | Bad Request Response - You'll get the below response when your API requests contain any validation errors. |
Response: 200
{
"RecordId": "53eb195d-4914-4a14-9348-251a55909c1d",
"DraftPdfUrl": "https://expressirsforms.s3.us-east-1.amazonaws.com/ACAStichedDraftPDF/GilGilmartLLC/2025_GilGilmartLLC_19732_1787232769129.pdf",
"DraftPdfPath": "ACAStichedDraftPDF/GilGilmartLLC/2025_GilGilmartLLC_19732_1787232769129.pdf",
"Error": null
}