Skip to main content
Version: 1.7.3

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 
Run in Postman

Request Params

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]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.

Request Params

"FormW2G/Validate?SubmissionId=05c4cfa0-aac5-491c-b5c3-95630933d3e7&RecordIds=1ece3ab0-381e-401d-81eb-93f500f9b493"

Response Body

FieldTypeDescription
StatusCodenumberReturns the HTTP status codes like 200,300 etc.
StatusNamestringName of the status code
StatusMessagestringDetailed status message
SubmissionIdGuidUnique identifier of a submission
Form1099RecordsobjectPulls the Form W2-G records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 1099 Records
        SequenceIdstringA 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.
        RecordIdGuidRecord ID of the returns that were successfully validated.
        StatusstringReturns the status of the records.
        StatusTsstringDate and time of return created.
        StateReturnsobject[]Returns the state code and return status.
            StateCodestringReturns the code of the state.
            RecordStatusstringReturns the status of the records.
        OnlineAccessobjectReturns the Email address for whom the online access to be given and Status of online access.
            StatusstringReturns status of online access for Form 1099-C return.
            EmailstringEmail address for whom the online access to be given.
            InfostringInformation about the online access service.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form 1099 Records.
        SequenceIdstringA 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.
        RecordIdGuidUnique identifier of a record
        Errorsobject[]Shows 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

Response JSON

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

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "05c4cfa0-aac5-491c-b5c3-95630933d3e7",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "1ece3ab0-381e-401d-81eb-93f500f9b493",
"Status": "CREATED",
"StatusTs": "2022-05-06 07:31:38 -04:00",
"StateReturns": null,
"OnlineAccess": null
}
],
"ErrorRecords": null
},
"Errors": null
}