Validate

Validate

This endpoint can be used to perform business and data validation checks on the W-2G form corrections already created through the API. To validate, provide the corresponding SubmissionId and RecordIds of the specific return you want to verify.

GET FormW2GCorrection/Validate  

Run in Postman

Request Params

Field	Type	Description
SubmissionId	Guid	Unique identifier of a submission
RecordsIds	Guid[]	Unique identifier generated by TaxBandits when a W-2G return is created. Mention the W-2G correction 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
FormW2GRecords	object	Pulls the Form W-2G correction records with Success and Error statuses.
SuccessRecords	object[]	It will show the detailed information about the success status of Form W-2G correction Records
SequenceId	string	An 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 information
OnlineAccess	object	Returns the email address for whom the online access is to be given and the status of online access.
Status	string	Returns status of online access for Form W-2G return.
Email	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 W-2G correction Records.
SequenceId	string	An 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

"FormW2GCorrection/validate?SubmissionId=94677293-8ecf-443b-8a76-8b8d192b2cb1&RecordIds=97c9ba31-c244-4aeb-addc-f1b53be373fc"

Response Json

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

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "SubmissionId": "94677293-8ecf-443b-8a76-8b8d192b2cb1",
    "FormW2GRecords": {
        "SuccessRecords": [
            {
                "SequenceId": "001",
                "RecordId": "97c9ba31-c244-4aeb-addc-f1b53be373fc",
                "Status": "CREATED",
                "StatusTs": "2025-12-01 05:22:58 -05:00",
                "StateReturns": null,
                "OnlineAccess": null,
                "ScheduleFiling": null
            }
        ],
        "ErrorRecords": null
    },
    "Errors": null
}