Skip to main content
Version: 2.0.0

RequestDraftPdfUrl

RequestDraftPdfUrl

This endpoint retrieves Draft PDF copies of a Form ACA for a single recipient or multiple recipients. Request the Draft PDF URLs by providing the RecordId associated with the returns.

GET acaform/RequestDraftPdfUrl 

Request Body

FieldTypeDescription
RecordIdGuid[]A unique identifier generated by TaxBandits when a return is created. Mention the return's Record ID that you want to delete.

Response Body

FieldTypeDescription
RecordIdGuidA unique identifier of the record
EmployeeIdGuidA unique identifier for each recipient set by you.
EmployeeRefstringA unique identifier for each recipient.
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
Errorsobject[]Shows detailed error information
IdstringReturns the validation error code
NamestringName of the validation error
MessagestringDescription of the validation error
Request Params
SampleDescriptionAction
Sample 1
Request a Draft PDF URL using RecordId.
Sample 1
acaform/requestpdfurls?RecordId=53eb195d-4914-4a14-9348-251a55909c1d&TINMaskType=MASKED
Response JSON
ResponseDescriptionAction
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
{
"SubmissionId": "4fc3dc91-64fe-4877-9193-7c520c21896a",
"FormType": "Form1095B",
"Form1095BRecords": {
"RecordId": "53eb195d-4914-4a14-9348-251a55909c1d",
"Status": "SUCCESS",
"RecipientCopy": {
"Unmasked": null,
"UnmaskedPath": null,
"Masked": "pdfs/407a6aae-6769-41ad-bd53-3e1fecb19e05/3c8c2ecf-5104-4482-9631-c96928ccae09/ACA/19831/m/copyb_1up_19831.pdf",
"MaskedPath": "pdfs/407a6aae-6769-41ad-bd53-3e1fecb19e05/3c8c2ecf-5104-4482-9631-c96928ccae09/ACA/19831/m/copyb_1up_19831.pdf"
},
"ErrorRecords": []
},
"Errors": null
}