Skip to main content
Version: 1.7.3

Validate

GET Form1099SCorrection/Validate  
Run in Postman

Request Params

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

Request Params

Form1099SCorrection/validate?SubmissionId=386548ab-5f72-44cc-80ff-58f344a403fa&RecordId=4b6111d5-e592-4b50-ae3b-ee1cccf01c89

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 1099 S correction records with Success and Error statuses.
    SuccessRecordsobject[]It will show the detailed information about the success status of Form 1099 S correction 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 collection of state returns information.
        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 S 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 S correction 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": "386548ab-5f72-44cc-80ff-58f344a403fa",
"Form1099Records": {
"SuccessRecords": [
{
"SequenceId": "001",
"RecordId": "4b6111d5-e592-4b50-ae3b-ee1cccf01c89",
"Status": "CREATED",
"StatusTs": "2024-01-11 07:13:27 -05:00",
"OnlineAccess": null
}
],
"ErrorRecords": null
},
"Errors": null
}