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 Params

Field	Type	Description
SubmissionId	Guid	Mention the W2 returns Submission ID that you want to validate.
RecordIds	Guid	Mention the W2 returns Record ID that you want to validate. Multiple RecordIds under the same Submission can be validated by sending the RecordIds comma separated.

Request Params

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

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
FormW2Records	object	Pulls the Form W-2 records with Success and Error statuses
SuccessRecords	object[]	It will show the detailed information about the success status of Form W2 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
Status	string	Returns the status of the records.
StatusTs	string	Date and time of return created.
StateReturns	object[]	Returns the state code and return status.
StateCode	string	Returns the code of the state.
RecordStatus	string	Returns the status of the records.
OnlineAccess	object	Returns the Email address for whom the online access to be given and Status of online access.
Status	string	Returns status of online access for Form 1099 MISC 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 W2 Records.
RecordId	Guid	Unique identifier of a record
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.
RejectedBy	string	Returns the information of who rejected the return.
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
Code	string	Returns the validation error Id
Name	string	Name of the validation error
Message	string	Description 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": "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"
         }
       ],
        "OnlineAccess": null
     },
     {
       "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"
         }
       ],
       "OnlineAccess": null
     }
   ],
   "ErrorRecords": null
 },
 "Errors": null
}