Extend your software with TaxBandits IRS E-file API Integration

Skip to main content
Version: 1.6.1

Validate

VALIDATE being an optional endpoint, can be used prior transmitting the returns to validate those returns against the business rules. This endpoint requires the Submission ID & Record ID(s) to be sent in the request.

GET FormW2/Validate

Request Body

FieldTypeDescription
SubmissionIdGuidUnique identifier of a submission
RecordIdsGuid[]An unique identifier generated by TaxBandits when a W2 return is created. Mention the W2 return's Record ID that you want to Validate.

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
FormW2RecordsobjectPulls the Form W-2 records with Success and Error statuses
    SuccessRecordsobject[]It will show the detailed information about the success status of Form W2 Records
        SequenceIdstringAn 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
        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.
    ErrorRecordsobject[]It will show the detailed information about the error status of Form W2 Records.
        RecordIdGuidUnique identifier of a record
        SequenceIdstringAn 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.
        RejectedBystringReturns the information of who rejected the return.
        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
    CodestringReturns the validation error Id
    NamestringName of the validation error
    MessagestringDescription of the validation error

Request JSON

FormW2/Validate?SubmissionId=d1f9cb0a-912f-4105-8bcf-059af43d2b31&RecordIds=a4718eab-e144-4c54-b502-3c00c3dd61b9,8e0db3cb-965e-4618-a36d-75684501d38f

Response JSON

{
"StatusCode": 200,
"StatusName": "Ok",
"StatusMessage": "Successful API call",
"SubmissionId": "f6683d71-448c-4a69-aa17-e58c6ef085ab",
"FormW2Records": {
"SuccessRecords": [
{
"SequenceId": "1",
"RecordId": "a4718eab-e144-4c54-b502-3c00c3dd61b9",
"Status": "Created",
"StatusTs": "2021-08-05 09:10:45 -04:00",
"StateReturns": [
{
"StateCode": "SC",
"RecordStatus": "Created"
},
{
"StateCode": "DE",
"RecordStatus": "Created"
}
]
},
{
"SequenceId": "1",
"RecordId": "8e0db3cb-965e-4618-a36d-75684501d38f",
"Status": "Created",
"StatusTs": "2021-08-05 09:10:45 -04:00",
"StateReturns": [
{
"StateCode": "SC",
"RecordStatus": "Created"
},
{
"StateCode": "DE",
"RecordStatus": "Created"
}
]
}
],
"ErrorRecords": null
},
"Errors": null
}