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
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier created by TaxBandits for each submission. Not required when you are creating a return |
| RecordId | Guid | A unique identifier generated by TaxBandits when a Form UI-3 return is created. |
Response Body
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier created by TaxBandits for each submission. |
| StateUIRecords | Object[] | Object to identify the records. |
| SequenceId | String | A unique identifier for this record. |
| ReturnHeader | Object | Contains business information. |
| TaxYear | String | The tax year for which the Form UI-3 is to be filed. |
| Qtr | String | The quarter for which the Form UI-3 is to be filed. |
| Business | object | Object to identify the Business Details. |
| BusinessId | Guid | The unique Business ID (Generated by TaxBandits) that you received in the response of the Business CREATE Endpoint. |
| PayerRef | string | The unique identifier for the payer. Can replace BusinessId in future requests. |
| IsDefaultBusiness | Boolean | When set to TRUE, this business will be set as the default across requests that do not specify a business. |
| TINDetails | object | TIN information for the business. |
| Format | string | Specifies how the TIN is passed. |
| TINType | string | Specify the TIN type of the business. |
| TIN | string | The TIN value according to the Format selected. |
| BusinessNm | string | Legal name of the business. |
| NameCtrl | string | Name control of the business as registered with the IRS. |
| DBADetails | object | DBA (Doing Business As) information. |
| DBANm | string | Name of the DBA. |
| DBARef | string | Unique identifier for the DBA. |
| DBAId | Guid | TaxBandits-generated DBA identifier. |
| Address | object | Address information of the DBA. |
| Address1 | string | Street address or PO Box. |
| Address2 | string | Suite or apartment number. |
| City | string | DBA's city. |
| ProvinceOrState | string | DBA's province or state name. |
| Zipcd | string | DBA's ZIP code. |
| Country | string | DBA's 2-character country code. |
| Address | object | Primary address of the business. |
| Address1 | string | Street address or PO Box of the business. |
| Address2 | string | Suite or apartment number of the business. |
| City | string | City of the business. |
| ProvinceOrState | string | Province or state name of the business. |
| ZipCd | string | ZIP code of the business. |
| Country | string | 2-character country code of the business. |
| ContactDetails | object | Details of the person the IRS can contact regarding the given business. |
| FirstNm | string | First name of the contact person. |
| MiddleNm | string | Middle name of the contact person. |
| LastNm | string | Last name of the contact person. |
| Suffix | string | The suffix of the contact person. |
| Phone | string | Phone number of the contact person. |
| PhoneExtn | string | Phone extension number. |
| string | Email address of the contact person. | |
| Fax | string | Fax number of the contact person. |
| BusinessType | String | Legal structure of the business. |
| SigningAuthority | Object | Details of the person authorized to sign the return. |
| FirstNm | String | First name of the signatory. |
| MiddleNm | String | Middle name of the signatory. |
| LastNm | String | Last name of the signatory. |
| Suffix | String | The suffix of the signatory. |
| Phone | String | Phone number of the signatory |
| PhoneExtn | String | Phone extension number of the signatory. |
| BusinessMemberType | String | Title or role of the signatory. |
| ReturnData | Object | Contains the return information. |
| FormUI3 | Object | Identifies the Form UI3 data. |
| UIIdNumber | String | Employer's Kentucky Unemployment Account Number. |
| IsNoWageReported | Boolean | When true, indicates that no wage is reported in this quarter. |
| UITaxRate | Number | Tax rate for the quarter. |
| SCUFRate | Number | SCUF rate for the quarter. |
| SCUFDue | Number | SCUF tax due for the reported taxable wages. |
| TotalGrossWages | Number | Total gross wages reported for all employees for the quarter. |
| TotalExcessWages | Number | Total excess wages reported for all employees for the quarter. |
| TotalTaxableWages | Number | Total taxable wages reported for all employees for the quarter. |
| UITaxDue | Number | Unemployment insurance tax due for the reported taxable wages. |
| Interest | Number | Interest for the quarter. |
| Penalty | Number | Penalty for the quarter. |
| PreviousQuarterAdjustments | Number | Previous quarter adjustments |
| BalanceDue | Number | Balance due for the quarter |
| NumberOfEmployees | Object | Identifies the total number of employees for the quarter. |
| TotalMonth1Employees | string | Total number of employees in month 1 of the quarter. |
| TotalMonth2Employees | string | Total number of employees in month 2 of the quarter. |
| TotalMonth3Employees | string | Total number of employees in month 3 of the quarter. |
| EmployeeDetails | Object[] | Object to identify the employee details. |
| EmployeeSequenceId | string | A unique number to identify this record. |
| EmployeeId | Guid | A unique ID generated by TaxBandits after the return is created and returned in the response. |
| SSN | string | Employee's Social Security Number (SSN). |
| FirstNm | string | The first name of the individual. |
| MiddleNm | string | Employee's middle name. |
| LastNm | string | Employee's last name. |
| Suffix | string | Employee's suffix. |
| GrossWages | Number | Total gross wages paid to the employee during the reporting quarter. |
| ExcessWages | Number | Portion of wages exceeding the applicable unemployment insurance taxable wage base. |
| Errors | Object | Shows detailed error information. |
| Id | string | Total amount due. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
Request JSON
statefilings/KYUI/Get?RecordId=f5c0b155-7261-4f9d-b0bc-cad7a0f69d2e&SubmissionId=01993c45-e77e-7383-823a-d13273fd717c
Response JSON
- 200
- 400
- 401
Success Response - This is a sample response for successful API requests.
{
"SubmissionId": "01a0ccd5-8919-71bd-a0aa-498ac67481e1",
"StateUIRecords": [
{
"SequenceId": "002",
"RecordId": "01a0ccd5-8dd2-7247-9fae-c0b7990605cf",
"ReturnHeader": {
"Qtr": "Q3",
"TaxYear": "2026",
"Business": {
"BusinessId": "3c7fa7d8-2379-4cea-861e-3adc75790756",
"PayerRef": "Snow122345",
"IsDefaultBusiness": true,
"TINDetails": {
"Format": "PLAIN_TIN",
"TINType": "EIN",
"TIN": "45-9874941"
},
"BusinessNm": "Horizon LLC",
"DBADetails": {
"DBANm": "Iceberg Icecreams",
"DBARef": "DBA1001",
"DBAId": "55C2871A-3BE6-4CFB-9B81-8D18A9A79693",
"Address": {
"Address1": "395 CENTRAL AVE W.",
"Address2": "Suite 1001",
"City": "Saint Paul",
"ProvinceOrState": "KY",
"ZipCd": "40601",
"Country": "US"
}
},
"Address": {
"Address1": "395 CENTRAL AVE W.",
"Address2": "Suite 1001",
"City": "Saint Paul",
"ProvinceOrState": "KY",
"ZipCd": "40601",
"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": "SLGOV",
"SigningAuthority": {
"FirstNm": "Michael",
"MiddleNm": "A",
"LastNm": "Carter",
"Suffix": "Jr",
"Phone": "(972) 555-0100",
"PhoneExtn": "23456",
"BusinessMemberType": "ADMINISTRATOR"
},
"KindOfEmployer": null,
"KindOfPayer": null
}
},
"ReturnData": {
"FormUI3": {
"UIIdNumber": "11-343568-A",
"IsNoWageReported": false,
"UITaxRate": 100,
"SCUFRate": 0,
"SCUFDue": 0,
"NumberOfEmployees": {
"TotalMonth1Employees": 1,
"TotalMonth2Employees": 1,
"TotalMonth3Employees": 1
},
"TotalGrossWages": 999999999999.99,
"TotalExcessWages": 999999999999.99,
"TotalTaxableWages": 0,
"UITaxDue": 0,
"Interest": 10,
"Penalty": 10,
"PreviousQuarterAdjustments": 10,
"BalanceDue": 30,
"EmployeeDetails": [
{
"EmployeeSequenceId": "1233333333333333333333333",
"EmployeeId": "e4adcc99-02aa-42ba-b8a0-ab7572ed5159",
"EmployeeRef": null,
"SSN": "001-45-6724",
"FirstNm": "Michael",
"MiddleNm": "A",
"LastNm": "Smith",
"Suffix": "Sr",
"GrossWages": 999999999999.99,
"ExcessWages": 999999999999.99,
"Address": {
"Address1": "395 CENTRAL AVE W.",
"Address2": "Suite 1001",
"City": "Saint Paul",
"ProvinceOrState": "KY",
"ZipCd": "40601",
"Country": "US"
}
}
]
}
}
}
],
"Errors": null
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"SubmissionId": null,
"StateUIRecords": [],
"Errors": [
{
"Id": "S00-000097",
"Name": "SubmissionId",
"Message": "SubmissionId is required."
}
]
}
Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.
{
"Errors": [
{
"Id": "AUTH-100018",
"Name": "Authorization",
"Message": "JWT EXPIRED"
}
]
}