tpaapproval
tpaapproval
POST statefilings/nmui/tpaapproval Request Body
| Field | Type | Description |
|---|---|---|
| Businesses | Object[] | Object containing information about the business for which a TPA authorization request is raised. |
| BusinessId | GUID | Optional Use the unique Business ID (Generated by TaxBandits) that you received in the response of the Business CREATE Endpoint. |
| PayerRef | string | Your unique identifier for the payer. Size Range: 50 |
| UIIdNum | string | Employer's Texas Unemployment Account Number. Sample Format: 99999999 Size Range: 8 |
Response Body
| Field | Type | Description |
|---|---|---|
| SuccessRecords | object[] | It will show the detailed information about the success status of the TPA request raised. |
| BusinessId | Guid | A Unique identifier of a Business. |
| PayerRef | string | A Unique identifier of the payer. |
| UIIdNum | string | Gets the Texas Employer ID number. |
| StatusCd | string | Status code representing the TPA request status. |
| Status | string | Current status of TPA request raised. |
| StatusMsg | string | Detailed description of the online access status. |
| StatusTs | string | Date and time when the online access status was last updated. |
| ErrorRecords | object[] | It will show the detailed information about the error status of the TPA request raised. |
| BusinessId | Guid | A Unique identifier of a Business. |
| PayerRef | string | A Unique identifier of the payer. |
| UIIdNum | string | Gets the Texas Employer ID number. |
| Errors | object[] | Displays detailed error information. |
| Id | string | Returns the validation error ID. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
| Errors | object[] | Shows detailed error information. |
| Id | string | Returns the validation error ID. |
| Name | string | Name of the validation error. |
| Message | string | Description of the validation error. |
Request JSON
- Sample 1
{
"Businesses": [
{
"BusinessId": "c930ad79-8f56-40ce-8f1d-1dfc05ca91c9",
"PayerRef": "Payer001",
"UIIdNum": "458969878"
}
]
}
Response JSON
- 200
{
"SuccessRecords": [
{
"BusinessId": null,
"PayerRef": "ABC123",
"UIIdNum": "UI1563261",
"StatusCd": "TPA002",
"Status": "REQUEST_APPROVED",
"StatusMsg": null,
"StatusTs": "2026-07-07 10:24:31 -04:00"
}
]
"ErrorRecords": null,
"Errors": null
}