Status
Status
Use this endpoint to retrieve the filing status of your withholding forms that are submitted to the corresponding state agency. Your request JSON must include the submissionId and the RecordIds of the forms you want to retrieve the status for.
GET StateFilings/Status Request Body
| Field | Type | Description |
|---|---|---|
| TaxYear | string | Tax year of the withholding or UI to be filed. |
| State | string | State of the withholding or UI to be filed. |
| BusinessId | Guid | Unique Identifier of a business |
| EIN | string | Employer Identification Number of the payer |
| PayerRef | string | An unique identifier for the payer |
| SubmissionId | Guid | Unique identifier of a submission |
| RecordIds | Guid | An unique identifier generated by TaxBandits when a withholding or UI return is created. Mention the return's Record ID that you want to Get. |
Response Body
| Field | Type | Description |
|---|---|---|
| StateFilingRecords | Object | Pulls withholding or UI records with Success and Error statuses |
| SuccessRecords | object[] | It will show the detailed information about the success status of withholding or UI Records |
| State | string | Returns the State code of the Withholding or UI returns |
| FormType | string | Returns the Form type |
| BusinessId | Guid | Unique identifier of a Business. |
| PayerRef | string | Unique identifier of the payer. |
| SubmissionId | Guid | Unique identifier of a submission |
| RecordId | Guid | Unique identifier of a record |
| Status | string | Returns the record status. |
| StatusTs | string | Returns date and time of return created. |
| Info | string | Returns information about the state filing service. |
| Errors | object[] | Shows error information of withholding or UI returns |
| Id | string | Returns the validation error Id. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
| ErrorRecords | object[] | It will show the detailed information about the error status of withholding or UI Records. |
| State | string | Returns the State code of the withholding or UI Form |
| FormType | string | Returns the Form type |
| BusinessId | Guid | Unique identifier of a Business. |
| PayerRef | string | Unique identifier of the payer. |
| SubmissionId | Guid | Unique identifier of a submission |
| RecordId | Guid | Unique identifier of a record |
| Status | string | Returns the record status. |
| StatusTs | string | Returns date and time of return created. |
| Info | string | Returns information about the Federal Filing service. |
| Errors | object[] | Shows error information withholding or UI returns |
| Id | string | Returns the validation error Id. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
| Errors | object[] | Shows detailed error information |
| Id | string | Returns the validation error Id |
| Name | string | Name of the validation error |
| Message | string | Description of the validation error |
Request Params
"statefilings/Status?TaxYear=2025&State=SC&BusinessId=bbfe40ea-32ab-409a-87d5-d1b94a4202da&EIN=34-2444224&PayerRef=Payer123&SubmissionId=01993c45-e77e-7383-823a-d13273fd717c&RecordIds=0199371f-1a0f-70f8-8f68-040fc8553820"
Response JSON
- 200
- 400
- 401
Success Response - This is a sample response for successful API requests.
{
"StatusCode": "200",
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"StateFilingRecords": [
{
"SuccessRecords": [
{
"State": "SC",
"FormType": "SC1605",
"BusinessId": "d2100525-3a85-4b33-8fb4-3f7682944ee1",
"PayerRef": null,
"SubmissionId": "01993c45-e77e-7383-823a-d13273fd717c",
"RecordId": "01993c45-e804-75cc-b9ff-908f41dbe62f",
"Status": "REJECTED",
"StatusTs": "2025-09-12 00:59:34 -04:00",
"Info": null,
"Errors": null
},
{
"State": "SC",
"FormType": "SC1606",
"BusinessId": "01e8159f-dace-4f65-adaf-57d406be4e24",
"PayerRef": null,
"SubmissionId": "01993c45-e77e-7383-823a-d13273fd717c",
"RecordId": "01993c45-eb89-7084-a20f-4ec9acf05faf",
"Status": "REJECTED",
"StatusTs": "2025-09-12 01:00:41 -04:00",
"Info": null,
"Errors": null
}
],
"ErrorRecords": null
}
],
"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",
"StateFilingRecords": null,
"Errors": [
{
"Id": "S00-000098",
"Name": "SubmissionId",
"Message": "SubmissionId is invalid."
}
]
}
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-100018",
"Name": "Authorization",
"Message": "JWT EXPIRED"
}
]
}