status

Use this endpoint to retrieve the status of online access for particular recipients. The API request must include the corresponding SubmissionId and the RecordIds.

POST OnlineAccess/Status

Request Body

Field	Type	Description
SubmissionId	GUID	Unique identifier of a submission
RecordIds	Object[]	unique identifier generated by TaxBandits when a return is created

Request Body

{
	"SubmissionId": "b8b7d0ad-51e2-424a-bc46-8425de87f7c7",
	"RecordIds":[
		"f5a4728c-9db3-4528-b8f6-97c0b3d3c47f"
	]
}

Response Body

Field	Type	Description
SuccessRecords	Object[]	It will show the detailed information about the success status of online access
SubmissionId	GUID	Unique identifier of a submission
RecordId	GUID	Unique identifier of a record
PayeeRef	String	A unique identifier for each payee completing their information
Email	String	Email address of the recipient
FormType	String	Returns the type of form
ConsentStatus	String	Returns the status of consent
ConsentStatusTs	String	Returns date and time of consent given
OnlineAccessStatus	String	Returns the status of online access
OnlineAccessStatusTs	String	Returns date and time of actions made in online access
ErrorRecords	Object[]	It will show the detailed information about the error status of failure records
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

Response JSON

{
    "SuccessRecords": [
        {
            "SubmissionId": "c61f5fa0-67d6-4096-a175-6a9eb0f0c67e",
            "RecordId": "e9f39bd7-76f7-4805-a3a9-e7eeed494d3a",
            "PayeeRef": "Payee001",
            "Email": "shawn1@sample",
            "FormType": "Form1099NEC",
            "ConsentStatus": "NOT_YET_CONSENTED",
            "ConsentStatusTs": "02/26/2025 02:12:46",
            "OnlineAccessStatus": "EMAIL_SENT",
            "OnlineAccessStatusTs": "02/26/2025 02:13:08"
        },
        {
            "SubmissionId": "c61f5fa0-67d6-4096-a175-6a9eb0f0c67e",
            "RecordId": "5501bda6-bbac-4ca7-9d4e-4997207f350c",
            "PayeeRef": "Payee002",
            "Email": "shawn2@sample",
            "FormType": "Form1099MISC",
            "ConsentStatus": "CONSENTED",
            "ConsentStatusTs": "02/26/2025 02:12:47",
            "OnlineAccessStatus": "PDF_VIEWED",
            "OnlineAccessStatusTs": "02/26/2025 02:13:08"
        }
    ],
    "ErrorRecords": [
        {
            "RecordId": "0b7def5d-fa53-453d-b091-94e232e9c4e0",
            "Errors": [
                {
                    "Id": "F00-100752",
                    "Name": "RecordIds[2].RecordId",
                    "Message": "Invalid RecordId"
                }
            ]
        },
        {
            "RecordId": "b2a3510e-f42c-45a1-987f-7081b267c447",
            "Errors": [
                {
                    "Id": "F00-100752",
                    "Name": "RecordIds[3].RecordId",
                    "Message": "Invalid RecordId"
                }
            ]
        }
    ],
    "Errors": null
}