Validate
Executes business and data validation checks for the 1099-DIV returns already created in API. Use the Submission ID and Record IDs of the return to validate.
GET Form1099DIV/Validate
Request Body
Field | Type | Description |
---|---|---|
SubmissionId | Guid | Unique identifier of a submission |
RecordIds | Guid[] | unique identifier generated by TaxBandits when a 1099-DIV return is created. Mention the 1099-DIV 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 1099-DIV 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. |
  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 JSON
Form1099DIV/Validate?SubmissionId=4d77ce45-1584-45a9-a775-75513f9d3ea5&RecordIds=d03e1ebb-4f86-4767-b980-723559369e24
Response JSON
{ "StatusCode": 200, "StatusName": "Ok", "StatusMessage": "Successful API call", "SubmissionId": "4d77ce45-1584-45a9-a775-75513f9d3ea5", "Form1099Records": { "SuccessRecords": [ { "SequenceId": "1", "RecordId": "d03e1ebb-4f86-4767-b980-723559369e24", "Status": "CREATED", "StatusTs": "2021-11-25 05:26:27 -05:00", "StateReturns": null } ], "ErrorRecords": null }, "Errors": null}