Validate
Validate
Executes business and data validation checks for the W2-G returns already created in API. Use the Submission ID and Record IDs of the return to validate.
GET FormW2G/Validate Request Params
| Field | Type | Description |
|---|---|---|
| SubmissionId | Guid | Unique identifier of a submission |
| RecordIds | Guid[] | A unique identifier generated by TaxBandits when a W2G-G return is created. Mention the W2-G return's Record ID that you want to Validate. |
Response Body
| Field | Type | Description |
|---|---|---|
| StatusCode | number | Returns the HTTP status codes like 200,300 etc. |
| StatusName | string | Name of the status code |
| StatusMessage | string | Detailed status message |
| SubmissionId | Guid | Unique identifier of a submission |
| Form1099Records | object | Pulls the Form W2-G records with Success and Error statuses |
| SuccessRecords | object[] | It will show the detailed information about the success status of Form 1099 Records |
| SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
| RecordId | Guid | Record ID of the returns that were successfully validated. |
| Status | string | Returns the status of the records. |
| StatusTs | string | Date and time of return created. |
| StateReturns | object[] | Returns the state code and return status. |
| StateCode | string | Returns the code of the state. |
| RecordStatus | string | Returns the status of the records. |
| OnlineAccess | object | Returns the Email address for whom the online access to be given and Status of online access. |
| Status | string | Returns status of online access for Form 1099-C return. |
| string | Email address for whom the online access to be given. | |
| Info | string | Information about the online access service. |
| ErrorRecords | object[] | It will show the detailed information about the error status of Form 1099 Records. |
| SequenceId | string | A unique reference ID for the submission that can be used to identify a particular record. The Sequence ID will be returned in the Response for your reference. |
| RecordId | Guid | Unique identifier of a record |
| 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 |
| 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 Params
"FormW2G/Validate?RecordIds=6dbc5de2-1a19-4143-9a2e-1709a5610342&SubmissionId=37b19766-0a00-4031-a1ac-471bdcaadcd"
Response JSON
Success Response - This is a sample response for successful API requests.
Response JSON
- 200
- 400
- 401
Success Response - This is a sample response for successful API requests.
{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "0562f158-def1-45cb-973e-c3109605375f",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "8da3046e-3270-491e-ae2d-674ad277fec4",
"Status": "CREATED",
"StatusTs": "2025-10-23 08:36:10 -04:00",
"StateReturns": null,
"OnlineAccess": null,
"ScheduleFiling": null
}
],
"ErrorRecords": null
},
"Errors": null
}
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"StatusCode": 400,
"StatusName": "BadRequest",
"StatusMessage": "Validation error has occurred",
"SubmissionId": null,
"Form1099Records": null,
"Errors": [
{
"Id": "F00-100146",
"Name": "Submission Id",
"Message": "Submission Id is invalid"
}
]
}
Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.
{
"StatusCode": 401,
"StatusName": "Unauthorized",
"StatusMessage": "Invalid authorization credentials",
"Errors": [
{
"Id": "AUTH-100018",
"Name": "Authorization",
"Message": "JWT EXPIRED"
}
]
}