Skip to main content
Version: 2.0.0

tparequest

tparequest

POST statefilings/vtui/tparequest 

Request Body

FieldTypeDescription
BusinessesObject[]Object containing information about the business for which TPA authorization is to be requested.
BusinessIdGUIDOptional Use the unique Business ID (Generated by TaxBandits) that you received in the response of the Business CREATE Endpoint.
PayerRefstringYour unique identifier for the payer.
Size Range: 50
UIIdNumstringEmployer's Texas Unemployment Account Number. Sample Format: 9999999
Size Range: 7

Response Body

FieldTypeDescription
SuccessRecordsobject[]It will show the detailed information about the success status of the TPA request raised.
BusinessIdGuidA Unique identifier of a Business.
PayerRefstringA Unique identifier of the payer.
UIIdNumstringGets the Texas Employer ID number.
StatusCdstringStatus code representing the TPA request status.
StatusstringCurrent status of TPA request raised.
StatusMsgstringDetailed description of the online access status.
StatusTsstringDate and time when the online access status was last updated.
ErrorRecordsobject[]It will show the detailed information about the error status of the TPA request raised.
BusinessIdGuidA Unique identifier of a Business.
PayerRefstringA Unique identifier of the payer.
UIIdNumstringGets the Texas Employer ID number.
Errorsobject[]Displays detailed error information.
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 JSON​

{
"Businesses": [
{
"BusinessId": null,
"PayerRef": "ABC123",
"UIIdNum": "UI1563261"
}
]
}

Response JSON​

{
"SuccessRecords": [
{
"BusinessId": null,
"PayerRef": "ABC123",
"UIIdNum": "UI1563261",
"StatusCd": "TPA001",
"Status": "REQUESTED",
"StatusMsg": null,
"StatusTs": "2026-07-07 10:24:31 -04:00"
}
]
"ErrorRecords": null,
"Errors": null
}