Skip to main content
Version: 2.0.0

Update

Update

Use this endpoint to update the information on existing UCE-101 forms that are already created for the business.

PUT StateFilings/SCUI/Update 

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier created by TaxBandits for each submission. Not required when you are creating a return.
StateUIRecordsObject[]Object to identify the records.
SequenceIdStringA unique identifier for this record. Size Range: ..50
ReturnHeaderObjectContains business information.
TaxYearStringThe tax year for which the Form UCE101 is to be filed.
Allowed values

2025,2026

QtrStringThe quarter for which the Form UCE101 is to be filed.
Allowed values

"Q1", "Q2", "Q3", "Q4"

BusinessobjectObject to identify the Business Details.
BusinessIdGuidOptional Use the unique Business ID (Generated by TaxBandits) that you received in the response of the Business CREATE Endpoint. If you do not have a Business ID, ignore the field. By giving the Business ID, you do not have to provide all the business information again.
PayerRefstringOptional Your unique identifier for the payer. Can replace BusinessId in future requests. Size Range: 50
IsDefaultBusinessBooleanWhen set to TRUE, this business will be set as the default across requests that do not specify a business.
TINDetailsobjectTIN information for the business.
FormatstringSpecifies how the TIN is passed.
Allowed values

"PLAIN_TIN" — Pass TIN directly. "TOKENIZED_TIN" — Pass tokenized TIN.

TINTypestringSpecify the TIN type of the business.
Allowed values

"EIN", "SSN", "QI-EIN", "ITIN", "WP-EIN", "WT-EIN", "NQI-EIN", "IRSN"

TINstringThe TIN value according to the Format selected.
IndividualNmobjectRequired when TINType is SSN. Provide individual name fields instead of BusinessNm.
FirstNmstringThe first name of the individual. Size Range: 20
MiddleNmstringOptional Middle name of the individual. Size Range: 20
LastNmstringThe last name of the individual. Size Range: 20
SuffixstringOptional Suffix of the individual's name.
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

BusinessNmstringLegal name of the business. Required when TINType is EIN. Size Range: 75
NameCtrlstringName control of the business as registered with the IRS. Size Range: 3..4
DBADetailsobject[]Optional DBA (Doing Business As) information.
DBANmstringName of the DBA. Size Range: 75
DBARefstringUnique identifier for the DBA. Size Range: 1-50
DBAIdGuidTaxBandits-generated DBA identifier.
Addressobject[]Address information of the DBA.
Address1stringStreet address or PO Box. Size Range: 46
Address2stringOptional Suite or apartment number. Size Range: 46
CitystringDBA's city. Size Range: 50
ProvinceOrStatestringDBA's province or state name.
When the country code is US:
Allowed values

"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"

When the country code is CA:
Allowed values

"AB", "BC", "MB", "NB", "NL", "NT", "NS", "NU", "ON", "PE", "QC", "SK", "YT"

Note: The size range is set to 50 for all countries except the United States and Canada.
ZipcdstringDBA's ZIP code. Size Range: 5-16
CountrystringDBA's 2-character country code.
Allowed values

"US","AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

EmailstringOptional Email address of the Business. Size Range: ..100
AddressobjectPrimary address of the business.
Address1stringStreet address or PO Box of the business. Size Range: 46
Address2stringOptional Suite or apartment number of the business. Size Range: 46
CitystringCity of the business. Size Range: 50
ProvinceOrStatestringProvince or state name of the business.
When the country code is US:
Allowed values

"AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "AS", "FM", "GU", "MH", "MP", "PW", "PR", "VI", "AA", "AE", "AP"

When the country code is CA:
Allowed values

"AB", "BC", "MB", "NB", "NL", "NT", "NS", "NU", "ON", "PE", "QC", "SK", "YT"

Note: The size range is set to 50 for all countries except the United States and Canada.
ZipCdstringZIP code of the business. Size Range: 5-16
Countrystring2-character country code of the business.
Allowed values

"US","AF", "AX", "AL", "AG", "AQ", "AN", "AO", "AV", "AY", "AC", "AR", "AM", "AA", "AT", "AS", "AU", "AJ", "BF", "BA", "FQ", "BG", "BB", "BO", "BE", "BH", "BN", "BD", "BT", "BL", "BK", "BC", "BV", "BR", "IO", "VI", "BX", "BU", "UV", "BM", "BY", "CB", "CM", "CA", "CV", "CJ", "CT", "CD", "CI", "CH", "KT", "IP", "CK", "CO", "CN", "CF", "CG", "CW", "CR", "CS", "IV", "HR", "CU", "UC", "CY", "EZ", "DA", "DX", "DJ", "DO", "DR", "TT", "EC", "EG", "ES", "EK", "ER", "EN", "ET", "FK", "FO", "FM", "FJ", "FI", "FR", "FP", "FS", "GB", "GA", "GG", "GM", "GH", "GI", "GR", "GL", "GJ", "GQ", "GT", "GK", "GV", "PU", "GY", "HA", "HM", "VT", "HO", "HK", "HQ", "HU", "IC", "IN", "ID", "IR", "IZ", "EI", "IS", "IT", "JM", "JN", "JA", "DQ", "JE", "JQ", "JO", "KZ", "KE", "KQ", "KR", "KN", "KS", "KV", "KU", "KG", "LA", "LG", "LE", "LT", "LI", "LY", "LS", "LH", "LU", "MC", "MK", "MA", "MI", "MY", "MV", "ML", "MT", "IM", "RM", "MR", "MP", "MX", "MQ", "MD", "MN", "MG", "MJ", "MH", "MO", "MZ", "WA", "NR", "BQ", "NP", "NL", "NC", "NZ", "NU", "NG", "NI", "NE", "NF", "CQ", "NO", "MU", "OC", "PK", "PS", "LQ", "PM", "PP", "PF", "PA", "PE", "RP", "PC", "PL", "PO", "RQ", "QA", "RO", "RS", "RW", "TB", "RN", "WS", "SM", "TP", "SA", "SG", "RI", "SE", "SL", "SN", "NN", "LO", "SI", "BP", "SO", "SF", "SX", "OD", "SP", "PG", "CE", "SH", "SC", "ST", "SB", "VC", "SU", "NS", "SV", "WZ", "SW", "SZ", "SY", "TW", "TI", "TZ", "TH", "TO", "TL", "TN", "TD", "TS", "TU", "TX", "TK", "TV", "UG", "UP", "AE", "UK", "UY", "UZ", "NH", "VE", "VM", "VQ", "WQ", "WF", "WI", "YM", "ZA", "ZI"

ContactDetailsobject[]Details of the person the IRS can contact regarding the given business.
FirstNmstringFirst name of the contact person. Size Range: 20
MiddleNmstringOptional Middle name of the contact person. Size Range: 20
LastNmstringLast name of the contact person. Size Range: 20
SuffixstringOptional The suffix of the contact person.
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

PhonestringOptional Phone number of the contact person. Size Range: 10 digits
PhoneExtnstringOptional Phone extension number. Size Range: 5
EmailstringOptional Email address of the contact person. Size Range: ..100
FaxstringOptional Fax number of the contact person. Size Range: 10 digits
ReturnDataObjectContains the return information.
FormUCE101ObjectIdentifies the Form UC101 data.
UIIdNumstringEmployer ID number. Sample format: XXXXXXX
IsNoWageRptdBooleanWhen true, indicates that no wage has been reported.
TotGrossWagesNumberTotal wages reported for the quarter. Size Range: ..99999999999.99
TotExcessWagesNumberExcess wages calculated for the quarter. Size Range: ..99999999999.99
TotTaxableWagesNumberTaxable wages calculated for the quarter. Size Range: ..99999999999.99
UITaxRateNumberTax rate for the quarter. Size Range: 1-100
UITaxDueNumberUI tax calculated for the quarter. Size Range: 0-99999999999999999.99
PenaltyNumberOptional Penalty for the quarter. Size Range: 0-999999999.99
InterestNumberOptional Interest for the quarter. Size Range: 0-999999999.99
TotUIDueNumberAmount due. Size Range: 0-999999999.99
OverpaymentNumberReimbursable charges. Size Range: 0-999999999.99
NumOfEmpObjectIdentifies the total number of employees for the quarter.
TotMonth1EmpstringTotal number of employees in month 1 of the quarter. Size Range: 0-9999999
TotMonth2EmpstringTotal number of employees in month 2 of the quarter. Size Range: 0-9999999
TotMonth3EmpstringTotal number of employees in month 3 of the quarter. Size Range: 0-9999999
EmpDetailsObjectObject to identify the employee details.
EmployeeSequenceIdstringA unique number to identify this record. Size Range: ..10
EmpIdGuidOptional A unique ID generated by TaxBandits after the return is created and returned in the response.
EmployeeRefstringA unique identifier of the employee.
SSNstringEmployee's Social Security Number (SSN). Size Range: 9-11
FirstNmstringEmployee's first name. Size Range: 15
MiddleNmstringOptional Employee's middle name. Size Range: 15
LastNmstringEmployee's last name. Size Range: 20
SuffixstringOptional Employee's suffix.
Allowed values

"Jr", "Sr", "I", "II", "III", "IV", "V", "VI", "VII"

SocCodestringSOC code of the employee. Sample format: 11-0000
JoinedDtstringEnter the date the employee was first employed. Format: MM/DD/YYYY or MM-DD-YYYY
TerminatedDtstringEnter the date of separation. Format: MM/DD/YYYY or MM-DD-YYYY
IsOfficerBooleanWhen true, indicates that the employee is an officer.
IsMonth1BooleanWhen true, indicates the employee was employed in month 1 of the quarter.
IsMonth2BooleanWhen true, indicates the employee was employed in month 2 of the quarter.
IsMonth3BooleanWhen true, indicates the employee was employed in month 3 of the quarter.
NumOfHrsWrkdNumberNumber of hours worked by the employee. Size Range: ..999
GrossWagesNumberGross wages of the employee. Size Range: ..99999999999.99
OutOfStateWagesNumberOther-State wages of the employee. Size Range: ..99999999999.99

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier for a submission.
SuccessRecordsobject[]Provides detailed information about the success status of Form W2 records.
SequenceIdstringA unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the response for your reference.
BusinessIdGuidUnique identifier for the business (payer) generated by TaxBandits.
PayerRefstringUnique identifier for the business (payer) provided by you..
RecordIdGuidA unique identifier generated by TaxBandits when a Form UC101 return is created.
FormTypestringType of form.
EmployeeDataobject[]Object to identify the employee details
EmployeeIdGuidReturns the unique identifier of the employee generated by TaxBandits.
StatusstringReturns the employee status.
StatusTsstringReturns the date and time when the employee was removed from the return
InfostringProvides additional information about the employee status
Errorsobject[]Displays error information related to the state returns of Form UC101.
IdstringReturns the validation error ID.
NamestringName of the validation error.
ErrorRecordsobject[]Provides detailed information about the error status of Form UC101 records.
SequenceIdstringA unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the response for your reference.
RecordIdGuidUnique identifier for the record.
Errorsobject[]Displays detailed error information.
IdstringReturns the validation error ID.
NamestringName of the validation error.
MessagestringDescription of the validation error.

Request JSON​

{
"SubmissionId": "01a0e7c2-a3cb-767b-8a6c-07c2cb64e430",
"StateUIRecords": [
{
"SequenceId": "001",
"RecordId": "01a0e7c2-a8cd-75cc-82dd-0c3c9f6c4c50",
"ReturnHeader": {
"TaxYear": "2026",
"Qtr": "Q3",
"Business": {
// "PayerRef": "aws123"
// "BusinessId": "22d30c56-5a25-4457-a29e-7b2841881c4a",
"IsDefaultBusiness": true,
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "EIN",
"TIN": "459099227"
},
"IndividualNm": {
"FirstNm": "James",
"MiddleNm": "A",
"LastNm": "Anderson",
"Suffix": "Jr"
},
"BusinessNm": "Snowdaze LLC",
"NameCtrl": "FIRE",
"DBADetails": {
"DBANm": "Iceberg Icecreams",
"DBARef": "DBA1001",
"DBAId": null,
"Address": {
"Address1": "123 Main St",
"Address2": "Suite 1001",
"City": "Rock Hill",
"ProvinceOrState": "SC",
"ZipCd": "29730",
"Country": "US"
}
},
"Address": {
"Address1": "123 Main St",
"Address2": "Suite 1001",
"City": "Rock Hill",
"ProvinceOrState": "SC",
"ZipCd": "29730",
"Country": "US"
},
"ContactDetails": {
"FirstNm": "James",
"MiddleNm": "A",
"LastNm": "Anderson",
"Suffix": "Jr",
"Phone": "8035551234",
"PhoneExtn": "101",
"Email": "contact@snowdaze.com",
"Fax": "8035555678"
},
"BusinessType": "ESTE",
"SigningAuthority": {
"FirstNm": "Ambrane",
"MiddleNm": "A",
"LastNm": "Cavil",
"Suffix": "Jr",
"Phone": "8035551000",
"PhoneExtn": "111",
"BusinessMemberType": "ADMINISTRATOR"
}
}
},
"ReturnData": {
"FormUCE101": {
"UIIdNum": 8934997,
"IsNoWageRptd": false,
"TotGrossWages": 1000,
"TotExcessWages": 600,
"TotTaxableWages": 400,
"UITaxRate": "10",
"UITaxDue": 40,
"Penalty": 100,
"Interest": 100,
"TotUIDue": 240,
"Overpayment": null,
"NumOfEmp": {
"TotMonth1Emp": 1,
"TotMonth2Emp": 1,
"TotMonth3Emp": 1
},
"EmpDetails": [
{
"EmployeeSequenceId": "01",
"EmployeeId": null,
"EmployeeRef": null,
"SSN": "231456924",
"FirstNm": "John",
"MiddleNm": "A",
"LastNm": "Smith",
"Suffix": "Sr",
"Address": {
"Address1": "12 Main st",
"Address2": "CC avenue",
"City": "Rock Hill",
"ProvinceOrState": "SC",
"ZipCd": "29730",
"Country": "US"
},
"SocCode": "12-1232",
"JoinedDt": "07/18/2024",
"TerminatedDt": "07/18/2024",
"IsOfficer": null,
"NumOfHrsWrkd": 240,
"GrossWages": 1000,
"OutOfStateWages": 540
}
]
}
}
}
]
}

Response JSON​

Success Response - This is a sample response for successful API requests.

{
"SubmissionId": "01a0e7c2-a3cb-767b-8a6c-07c2cb64e430",
"SuccessRecords": [
{
"SequenceId": "001",
"BusinessId": "eadc30eb-eb56-4783-90f9-cc5a1c2968ce",
"PayerRef": null,
"RecordId": "01a0e7c2-a8cd-75cc-82dd-0c3c9f6c4c50",
"FormType": "UCE101",
"EmployeeData": [
{
"EmployeeId": "6069d83e-d2ea-4626-a781-d69d3c6b343a",
"EmployeeRef": null
}
],
"RemoveEmployeeData": null,
"Status": "CREATED",
"StatusTs": "2026-09-28 07:25:48 -04:00",
"Info": null,
"Errors": null
}
],
"ErrorRecords": null,
"Errors": null
}