Enable

If you haven't opted for online access service for any of the forms you've transmitted, you can use this endpoint to do so.

By providing the SubmissionId, you can enable online access for all the recipients/forms under that submission. If you wish to enable online access only for specific recipients under the submission, provide their RecordIds.

POST OnlineAccess/Enable

Request Body

Field	Type	Description
SubmissionId	GUID	Unique identifier of a submission
RecordIds	Object[]	Collection of Record IDs and email
RecordId	GUID	Unique identifier of a record
Email	String	Email address of the recipient Size Range: ..100

Request Body

{
  "SubmissioinId": "c59ed08e-5330-4a1a-b3ea-37879516bbdf",
  "RecordIds": [
    {
      "RecordId": "b33c2768-87d3-4954-a4db-61fa4b5cd883",
      "Email": "shawn1@sample.com"
    },
    {
      "RecordId": "f5a4728c-9db3-4528-b8f6-97c0b3d3c47f",
      "Email": "shawn2@sample.com"
    },
    {
      "RecordId": "a92fce0d-6ae4-4f3a-9b91-d14e75a8cd25",
      "Email": "shawn3@sample.com"
    },
    {
      "RecordId": "d47e291a-3b12-4d5e-a0a8-42b2e9c6fa21",
      "Email": "shawn3@sample.com"
    }
  ]
}

Response Body

Field	Type	Description
TotalRecords	Number	Returns the total number of records processed for online access
TotalSuccess	Number	Returns the total number of records successfully enabled for online access
TotalErrors	Number	Returns the total number of records failed to enable online access
SucessRecords	Object[]	Returns detailed information about the success records
SubmissionId	GUID	Unique identifier of a submission
RecordId	GUID	Unique identifier of a record
Email	String	Email address of the recipient
FormType	String	Returns the type of form
Status	String	Returns the record status
ErrorRecords	Object[]	Returns detailed information about the failure records
SubmissionId	GUID	Unique identifier of a submission
RecordId	GUID	Unique identifier of a record
Email	String	Email address of the recipient
FormType	String	Returns the type of form
Info	String	Shows the detailed error information
Errors	Object[]	Shows detailed error information.
Id	String	Error ID number. This ID is assigned by TaxBandits and it is unique for each error.
Name	String	Name of the errored node.
Message	String	Shows the error message.

Response JSON

200

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

{
    "TotalRecords": 1,
    "TotalSuccess": 1,
    "TotalErrors": 0,
    "SuccessRecords": [
        {
            "SubmissionId": "34b00ed3-c60f-47ce-aed1-8e13b0a35eb3",
            "RecordId": "8933a30d-6377-49e0-8c16-a1060052dfd2",
            "Email": "shawn@sample.com",
            "FormType": "Form1099NEC",
            "Status": "ORDER_CREATED"
        }
    ],
    "ErrorRecords": null,
    "Errors": null
}

300

Multi-status Response - You'll get the below response when multiple statuses are included.

{
    "TotalRecords": 4,
    "TotalSuccess": 2,
    "TotalErrors": 2,
    "SuccessRecords": [
        {
            "SubmissionId": "c61f5fa0-67d6-4096-a175-6a9eb0f0c67e",
            "RecordId": "e9f39bd7-76f7-4805-a3a9-e7eeed494d3a",
            "Email": "shawn1@sample.com",
            "FormType": "Form1099NEC",
            "Status": "ORDER_CREATED"
        },
        {
            "SubmissionId": "c61f5fa0-67d6-4096-a175-6a9eb0f0c67e",
            "RecordId": "5501bda6-bbac-4ca7-9d4e-4997207f350c",
            "Email": "shawn2@sample.com",
            "FormType": "Form1099NEC",
            "Status": "ORDER_CREATED"
        }
    ],
    "ErrorRecords": [
        {
            "SubmissionId": null,
            "RecordId": "0b7def5d-fa53-453d-b091-94e232e9c4e0",
            "Email": "shawn3@sample.com",
            "FormType": null,
            "Info": null,
            "Errors": [
                {
                    "Id": "F00-100752",
                    "Name": "RecordIds[2].RecordId",
                    "Message": "Invalid RecordId"
                }
            ]
        },
        {
            "SubmissionId": null,
            "RecordId": "d47e291a-3b12-4d5e-a0a8-42b2e9c6fa21",
            "Email": "shawn4@sample.com",
            "FormType": null,
            "Info": null,
            "Errors": [
                {
                    "Id": "F00-100752",
                    "Name": "RecordIds[3].RecordId",
                    "Message": "Invalid RecordId"
                }
            ]
        }
    ],
    "Errors": null
}

401

Unauthorized Response - You'll get the below response when your API requests don't contain valid authentication credentials.

{
    "StatusCode": 401,
    "StatusName": "Unauthorized",
    "StatusMessage": "Invalid authorization credentials",
    "Errors": [
        {
            "Id": "AUTH-100018",
            "Name": "Authorization",
            "Message": "JWT EXPIRED"
        }
    ]
}