Skip to main content
Version: 2.0.0

Get

Get

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

POST StateFilings/KYUI/Get 

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier created by TaxBandits for each submission. Not required when you are creating a return
RecordIdGuidA unique identifier generated by TaxBandits when a Form UI-3 return is created.

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 UI-3 is to be filed.
QtrStringThe quarter for which the Form UI-3 is to be filed.
BusinessobjectObject to identify the Business Details.
BusinessIdGuidThe unique Business ID (Generated by TaxBandits) that you 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.
BusinessNmstringLegal name of the business.
NameCtrlstringName control of the business as registered with the IRS.
DBADetailsobjectDBA (Doing Business As) information.
DBANmstringName of the DBA.
DBARefstringUnique identifier for the DBA.
DBAIdGuidTaxBandits-generated DBA identifier.
AddressobjectAddress information of the DBA.
Address1stringStreet address or PO Box.
Address2stringSuite or apartment number.
CitystringDBA's city.
ProvinceOrStatestringDBA's province or state name.
ZipcdstringDBA's ZIP code.
CountrystringDBA's 2-character country code.
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.
ContactDetailsobjectDetails 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.
BusinessTypeStringLegal structure of the business.
SigningAuthorityObjectDetails of the person authorized to sign the return.
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.
FormUI3ObjectIdentifies the Form UI3 data.
UIIdNumberStringEmployer's Kentucky Unemployment Account Number.
IsNoWageReportedBooleanWhen true, indicates that no wage is reported in this quarter.
UITaxRateNumberTax rate for the quarter.
SCUFRateNumberSCUF rate for the quarter.
SCUFDueNumberSCUF tax due for the reported taxable wages.
TotalGrossWagesNumberTotal gross wages reported for all employees for the quarter.
TotalExcessWagesNumberTotal excess wages reported for all employees for the quarter.
TotalTaxableWagesNumberTotal taxable wages reported for all employees for the quarter.
UITaxDueNumberUnemployment insurance tax due for the reported taxable wages.
InterestNumberInterest for the quarter.
PenaltyNumberPenalty for the quarter.
PreviousQuarterAdjustmentsNumberPrevious quarter adjustments
BalanceDueNumberBalance due for the quarter
NumberOfEmployeesObjectIdentifies the total number of employees for the quarter.
TotalMonth1EmployeestringTotal number of employees in month 1 of the quarter.
TotalMonth2EmployeestringTotal number of employees in month 2 of the quarter.
TotalMonth3EmployeestringTotal number of employees in month 3 of the quarter.
EmployeeDetailsObject[]Object to identify the employee details.
EmployeeSequenceIdstringA unique number to identify this record.
EmployeeIdGuidA unique ID generated by TaxBandits after the return is created and returned in the response.
SSNstringEmployee's Social Security Number (SSN).
FirstNmstringThe first name of the individual.
MiddleNmstringEmployee's middle name.
LastNmstringEmployee's last name.
SuffixstringEmployee's suffix.
GrossWagesNumberTotal gross wages paid to the employee during the reporting quarter.
ExcessWagesNumberPortion of wages exceeding the applicable unemployment insurance taxable wage base.
ErrorsObjectShows detailed error information.
IdstringTotal amount due.
NamestringName of the validation error.
MessagestringDescription of the validation error.

Request JSON

statefilings/KYUI/Get?RecordId=f5c0b155-7261-4f9d-b0bc-cad7a0f69d2e&SubmissionId=01993c45-e77e-7383-823a-d13273fd717c

Response JSON

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


{
"SubmissionId": "01a01ee5-e2f6-7258-86c9-6a907d0fc35e",

"StateUIRecords": [
{
"SequenceId": "001",
"RecordId": "01a01ee6-07c1-750b-9da0-30af43d4d6f9",

"ReturnHeader": {
"TaxYear": "2026",
"Qtr": "Q2",
"Business": {
"BusinessId": "ff1f5813-acc4-490f-9664-552774af37d3",
"PayerRef": null,
"IsDefaultBusiness": true,
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "EIN",
"TIN": "13-0000000"
},
"BusinessNm": "Snowdaze LLC",
"NameCtrl": "SNOW",
"DBADetails": {
"DBANm": "Iceberg Icecreams",
"DBARef": "DBA1001",
"DBAId": null,
"IsDefaultDBA": true,
"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": null,
"Phone": "8035551234",
"PhoneExtn": "101",
"Email": "contact@snowdaze.com",
"Fax": "8035555678"
},
"BusinessType": "ESTE",
"SigningAuthority": {
"FirstNm": "Ambrane",
"MiddleNm": "A",
"LastNm": "Cavil",
"Suffix": null,
"Phone": "8035551000",
"PhoneExtn": null,
"BusinessMemberType": "ADMINISTRATOR"
}
}
},
"ReturnData": {
"FormUI3": {
"UIIdNumber": "12345678-A",
"IsNoWageReported": false,
"UITaxRate": 10,
"SCUFRate": 0.075,
"SCUFDue": "0.00",
"TotalGrossWages": "0.00",
"TotalExcessWages": "0.00",
"TotalTaxableWages": "0.00",
"UITaxDue": "0.00",
"Interest": "0.00",
"Penalty": "0.00",
"PreviousQuarterAdjustments": "0.00",
"BalanceDue": "0.00",
"NumberOfEmployees": {
"TotalMonth1Employees": 2,
"TotalMonth2Employees": 2,
"TotalMonth3Employees": 2
},
"EmployeeDetails": [
{
"EmployeeSequenceId": 1,
"EmployeeId": null,
"SSN": "001-45-6924",
"FirstNm": "John",
"MiddleNm": "A",
"LastNm": "Smith",
"Suffix": "Sr",
"GrossWages": "0.00",
"ExcessWages": "0.00"
}
]
}
}
}
],
"Errors": null
}