GetPdf
GetPdf
This endpoint is used to retrieve the PDF copy of a transmitted 15397 form for your records. Your request JSON must include the ‘SubmissionId’ corresponding to the extension form you want to download.
Before you use this endpoint, you must configure webhooks for the event type ‘PDF Complete’. Learn more
GET Form15397/GetPDF Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission |
Response Body
| Field | Type | Description |
|---|---|---|
| StatusCode | number | HTTP status code returned by the API (e.g., 200, 400, 500). |
| StatusName | string | Name of the HTTP status |
| StatusMessage | string | Detailed message describing the result of the PDF request. |
| SubmissionId | Guid | Unique identifier of the submission for which the PDF was requested. |
| Message | string | Additional information regarding the PDF delivery. |
| Errors | object[] | Array of error details, if any issues occurred while processing the PDF request. |
| Id | string | Unique identifier of the validation or processing error. |
| Name | string | Short name of the error. |
| Message | string | Detailed description of the error. |
Request Params
"Form15397/GetPDF?SubmissionId=e88e7f1d-7ae5-43b6-99f6-38d85664035a"
Response JSON
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "000e9b21-c0fd-421c-867e-93ef54d37b33",
"Message": "We've successfully received your request to generate PDF. You will be notified with the URL to download the PDF.",
"Errors": null
}