ViewAttachment
ViewAttachment
This endpoint is used to view attachments uploaded for a particular 1099 form.
In your API request, you must include the RecordId of the specific form for which you want to view attachments. The response will have the file path to access the attachments.
GET Attachment/ViewAttachment Request Params
| Field | Type | Description |
|---|---|---|
| RecordID | Guid | Unique identifier of the records given by TaxBandits |
Response Body
| Field | Type | Description |
|---|---|---|
| RecordID | Guid | Unique identifier of the records given by TaxBandits |
| FilePath | string | File path of the attachment document |
| 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
"Attachment/ViewAttachment?RecordId=04ec74ea-9099-42a0-9a64-710a4d7eec37"
Response JSON
- 200
- 400
- 401
Success Response - You'll get the below response when the request is processed successfully.
{
"RecordID": "04ec74ea-9099-42a0-9a64-710a4d7eec37",
"FilePath": "https://amazonaws.com/pdfs/a570efbd-740f-4ae2-bfe7-26356cd85148.pdf",
"Errors": null
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"StatusCode": 400,
"StatusName": "BadRequest",
"StatusMessage": "Validation error has occurred",
"RecordId": null,
"FilePath": null,
"Errors": [
{
"Id": "F00-100192",
"Name": "RecordId",
"Message": "Invalid RecordId"
}
]
}
Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.
{
"StatusCode": 401,
"StatusName": "Unauthorized",
"StatusMessage": "Invalid authorization credentials",
"Errors": [
{
"Id": "AUTH-100001",
"Name": "Authorization",
"Message": "JWT EXPIRED"
}
]
}