Skip to main content
Version: 2.0.0

Get

Get

Use this endpoint to retrieve the information of a previously created NC UI101 form for the corresponding employer (payer). Your request JSON must include the corresponding SubmissionId and the RecordId (optional) for the forms.

GET StateFilings/NCUI/Get 

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission.
RecordIdGuidOptional A unique identifier generated by TaxBandits when a NCUI101 return is created. Mention the return's Record ID that you want to get.

Response Body

FieldTypeDescription
SubmissionIdGuidUnique identifier created by TaxBandits for each submission.
StateUIRecordsObject[]Object to identify the records.
SequenceIdStringA unique identifier for this record.
ReturnHeaderObjectContains business information.
TaxYearStringThe tax year for which the Form NCUI101 is to be filed.
QtrStringThe quarter for which the Form NCUI101 is to be filed.
BusinessobjectObject to identify the Business Details.
BusinessIdGuidThe unique Business ID (Generated by TaxBandits) that is received in the response of the Business CREATE Endpoint.
PayerRefstringThe unique identifier for the payer. Can replace BusinessId in future requests.
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.
TINTypestringSpecify the TIN type of the business.
TINstringThe TIN value according to the Format selected.
IndividualNmobjectObject to identify Individual name.
FirstNmstringThe first name of the individual.
MiddleNmstringMiddle name of the individual.
LastNmstringThe last name of the individual.
SuffixstringSuffix of the individual's name.
BusinessNmstringLegal name of the business.
NameCtrlstringName control of the business as registered with the IRS.
DBADetailsobject[]DBA (Doing Business As) information.
DBANmstringName of the DBA.
DBARefstringUnique identifier for the DBA.
DBAIdGuidTaxBandits-generated DBA identifier.
Addressobject[]Address information of the DBA.
Address1stringStreet address or PO Box.
Address2stringSuite or apartment number of the business.
CitystringDBA's city.
ProvinceOrStatestringDBA's province or state name.
ZipcdstringDBA's ZIP code.
CountrystringDBA's 2-character country code.
EmailstringEmail address of the Business.
AddressobjectPrimary address of the business.
Address1stringStreet address or PO Box of the business.
Address2stringSuite or apartment number of the business.
CitystringCity of the business.
ProvinceOrStatestringProvince or state name of the business.
ZipCdstringZIP code of the business.
Countrystring2-character country code of the business.
ContactDetailsobject[]Details of the person the IRS can contact regarding the given business.
FirstNmstringFirst name of the contact person.
MiddleNmstringMiddle name of the contact person.
LastNmstringLast name of the contact person.
SuffixstringThe suffix of the contact person.
PhonestringPhone number of the contact person.
PhoneExtnstringPhone extension number.
EmailstringEmail address of the contact person.
FaxstringFax number of the contact person.
ReturnDataObjectContains the return information.
BusinessTypeStringLegal structure of the business.
SigningAuthorityObjectDetails of the person authorized to sign the return. Mandatory for 94x forms.
FirstNmStringFirst name of the signatory.
MiddleNmStringMiddle name of the signatory.
LastNmStringLast name of the signatory.
SuffixStringThe suffix of the signatory.
PhoneStringPhone number of the signatory.
PhoneExtnStringPhone extension number of the signatory.
BusinessMemberTypeStringTitle or role of the signatory.
ReturnDataObjectContains the return information.
NCUI101ObjectIdentifies the Form NCUI101 data.
IsChangeOfAddrBooleanWhen true, identifies the business has changed the address.
IsDiffMailAddrBooleanWhen true, identifies the business has a different mailing address.
MailAddressObjectIf IsDiffMailAddr is true, pass the mailing address of the business.
Address1stringEmployer/Payer's US address (street or post office box of that locality).
Address2stringEmployer/Payer's suite or apartment.
CitystringEmployer/Payer's city.
StatestringEmployer/Payer's state code. Refer Static values.
ZipCdstringEmployer/Payer's zip code.
UIIdNumstringEmployer ID number.
IsNoWageReportedBooleanWhen true, indicates that no wage is reported in this quarter.
UITaxRateNumberTax rate for the quarter.
UITaxDueNumberTax due for the quarter.
InterestNumberInterest for the quarter.
LateFilingPenaltyNumberLate filing penalty for the quarter.
LatePaymentPenaltyNumberLate payment penalty for the quarter.
TotUIDueNumberTotal Remittance due for the quarter.
NumOfEmpObjectIdentifies the total number of employees for the quarter.
TotMonth1EmpstringTotal number of employees in month 1 of the quarter.
TotMonth2EmpstringTotal number of employees in month 2 of the quarter.
TotMonth3EmpstringTotal number of employees in month 3 of the quarter.
EmpDetailsObjectObject to identify the Employee details.
EmployeeSequenceIdstringA unique number to identify this record.
EmpIdGuidA 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).
FirstNmstringEmployee's first name.
MiddleNmstringEmployee's middle name.
LastNmstringEmployee's last name.
SuffixstringEmployee's suffix.
GrossWagesNumberGross wages of the employee.
TaxableWages
ExcessWages
OutOfStateTaxableWagesNumberOut of state taxable wages of the employee.
OutOfStateCdStringOut of state code.
NumOfHrsWorkedNumberNumber of hours worked in the quarter by the employee.
IsEmployeeBooleanWhen true, indicates that the employment type is employee.
IsOfficerBooleanWhen true, indicates that the employment type is Officer.
IsSeasonalBooleanWhen true, indicates the employee as seasonal.
LocationSummarystringIndicates whether the location is the primary location.
SOCCodestringStandard Occupational Classification of the employee.
IsMonth1BooleanWhen true, indicates the employee was employed during the month 1 of the quarter.
IsMonth2BooleanWhen true, indicates the employee was employed during the month 2 of the quarter.
IsMonth3BooleanWhen true, indicates the employee was employed during the month 3 of the quarter.
TotGrossWagesNumberTotal gross wages reported for the quarter.
TotOOSTaxableWagesNumberTotal out-of-state taxable wages reported for the quarter.
TotExcessWagesNumberTotal Excess wages for the quarter.
TotTaxableWagesNumberTotal Taxable wages for the quarter.
ErrorsObject[]Shows detailed error information.
IdstringReturns the validation error ID.
NamestringName of the validation error.
MessagestringDescription of the validation error.

Request JSON​

"statefilings/ncui/get?SubmissionId=01a0e797-9629-704c-861a-4ff1e3138be2&RecordId=01a0e797-9e9d-725e-87f2-1cbbfe147d3c"

Response JSON​

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

{
"SubmissionId": "01a0e797-9629-704c-861a-4ff1e3138be2",
"StateUIRecords": [
{
"SequenceId": "002",
"RecordId": "01a0e797-9e9d-725e-87f2-1cbbfe147d3c",
"ReturnHeader": {
"Qtr": "Q3",
"TaxYear": "2026",
"Business": {
"BusinessId": "b3ede465-204a-4205-9641-d6ff0a40c635",
"PayerRef": null,
"IsDefaultBusiness": true,
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "EIN",
"TIN": "45-9099203"
},
"BusinessNm": "Snowdaze LLC",
"DBADetails": {
"DBANm": "Iceberg Icecreams",
"DBARef": "",
"DBAId": "773AED27-8831-454F-9F39-D464D31E375E",
"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": "(803) 555-1234",
"PhoneExtn": "101",
"Email": "contact@snowdaze.com",
"Fax": "(803) 555-5678"
},
"BusinessType": "ESTE",
"SigningAuthority": {
"FirstNm": "Ambrane",
"MiddleNm": "A",
"LastNm": "Cavil",
"Suffix": "Jr",
"Phone": "(803) 555-1000",
"PhoneExtn": "111",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": null,
"KindOfPayer": null
}
},
"ReturnData": {
"FormNCUI101": {
"IsChangeOfAddr": false,
"UIIdNum": "3801264739",
"IsDiffMailAddr": true,
"MailAddr": {
"Address1": "150 Fayetteville St",
"Address2": "Suite 200",
"City": "Raleigh",
"ProvinceOrState": "NC",
"ZipCd": "27604",
"Country": "US"
},
"IsNoWageRptd": false,
"UITaxRate": 1,
"UITaxDue": 45,
"Interest": 155,
"LateFilingPenalty": 60,
"LatePaymentPenalty": 40,
"TotUIDue": 300,
"NumOfEmp": {
"TotMonth1Emp": 1,
"TotMonth2Emp": 1,
"TotMonth3Emp": 1
},
"EmpDetails": [
{
"EmployeeSequenceId": "01",
"EmployeeId": "5d52556d-def9-46ae-b9e3-87ab57f96bad",
"EmployeeRef": "Empref50",
"SSN": "761-45-9778",
"FirstNm": "John",
"MiddleNm": "Joe",
"LastNm": "Smith",
"Suffix": "Jr",
"Address": {
"Address1": "400 Bellemeade St",
"Address2": "Apt 101",
"City": "Greensboro",
"ProvinceOrState": "NC",
"ZipCd": "27401",
"Country": "US"
},
"GrossWages": 6000,
"OutOfStateTaxableWages": 0,
"OutOfStateCd": "",
"NumOfHrsWrkd": 28,
"IsEmployee": true,
"IsOfficer": false,
"IsSeasonal": true,
"LocationSummary": "Other",
"SOCCode": "123132"
}
],
"TotGrossWages": 6000,
"TotOutOfStateTaxableWages": 0,
"TotExcessWages": 1500,
"TotTaxableWages": 4500
}
}
}
],
"Errors": null
}