Skip to main content
Version: 1.7.3

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

FieldTypeDescription
TaxYearstringTax year of the  withholding or UI to be filed.
StatestringState of the withholding or UI to be filed.
BusinessIdGuidUnique Identifier of a business
EINstringEmployer Identification Number of the payer
PayerRefstringAn unique identifier for the payer
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuidAn 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

FieldTypeDescription
StateFilingRecordsObjectPulls withholding or UI records with Success and Error statuses
SuccessRecordsobject[]It will show the detailed information about the success status of withholding or UI Records
StatestringReturns the State code of the Withholding or UI returns
FormTypestringReturns the Form type
BusinessIdGuidUnique identifier of a Business.
PayerRefstringUnique identifier of the payer.
SubmissionIdGuidUnique identifier of a submission
RecordIdGuidUnique identifier of a record
StatusstringReturns the record status.
StatusTsstringReturns date and time of return created.
InfostringReturns information about the state filing service.
Errorsobject[]Shows error information of withholding or UI returns
IdstringReturns the validation error Id.
NamestringName of the validation error.
MessagestringDescription of the validation error.
ErrorRecordsobject[]It will show the detailed information about the error status of withholding or UI Records.
StatestringReturns the State code of the withholding or UI Form
FormTypestringReturns the Form type
BusinessIdGuidUnique identifier of a Business.
PayerRefstringUnique identifier of the payer.
SubmissionIdGuidUnique identifier of a submission
RecordIdGuidUnique identifier of a record
StatusstringReturns the record status.
StatusTsstringReturns date and time of return created.
InfostringReturns information about the Federal Filing service.
Errorsobject[]Shows error information withholding or UI returns
IdstringReturns the validation error Id.
NamestringName of the validation error.
MessagestringDescription of the validation error.
Errorsobject[]Shows detailed error information
IdstringReturns the validation error Id
NamestringName of the validation error
MessagestringDescription 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

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
}