ActivityLogRecords

ActivityLogRecords

Use this endpoint to retrieve the online access activity summary of a particular recipient for whom you've enabled online access. The API request must include the RecipientId, date period, and page layout specifications.

GET OnlineAccess/ActivityLogRecords

Run in Postman

Request Params

Field	Type	Description
RecipientId	GUID	A unique ID generated by TaxBandits after the return is created and will be returned in the Response
Page	Number	Pulls the records listed in the page selected
PageSize	Number	Number of records to be listed in each page . Note: PageSize can be maximum of 100.
FromDate	String	Enter a date from which the records need to be listed in MM/DD/YYYY format
ToDate	String	Enter a date till which the records created are to be listed in MM/DD/YYYY format

Response Body

Field	Type	Description
ActivityLogRecords	Object[]	Returns detailed information of the activity logs performed in online access portal
Description	String	Description of the activity log
Platform	String	Platform from which action is made
Device	String	Device from which action is made
IPAddress	String	IP Address from which action is made
ActionTs	String	Returns date and time of action performed
Page	Number	Pulls the records listed in the page selected
TotalRecords	Number	Total number of records
TotalPages	Number	Total number of pages
PageSize	Number	Number of records to be listed in each page
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 Params

"OnlineAccess/ActivityLogRecords?RecipientId=63ce1ce9-8eef-4342-9f4c-006542f8eb50&Page=1&PageSize=100&FromDate=05/02/2023&ToDate=06/02/2024"

Response JSON

{
    "StatusCode": 200,
    "StatusName": "Ok",
    "StatusMessage": "Successful API call",
    "ActivityLogRecords": [
        {
            "Description": "Shawn Williams downloaded Form 1099 NEC",
            "Platform": "WEB",
            "Device": "Chrome(132.0.0)",
            "IPAddress": "203.223.189.10",
            "ActionTs": "2025-02-02 23:29:26 -05:00"
        },
        {
            "Description": "Shawn Williams viewed Form 1099 NEC",
            "Platform": "WEB",
            "Device": "Chrome(132.0.0)",
            "IPAddress": "203.223.189.10",
            "ActionTs": "2025-02-02 23:29:21 -05:00"
        },
        {
            "Description": "Shawn Williams e-signed the consent form for Snowdaze LLC",
            "Platform": "WEB",
            "Device": "Chrome(132.0.0)",
            "IPAddress": "203.223.189.10",
            "ActionTs": "2025-02-02 23:28:45 -05:00"
        },
        {
            "Description": "Shawn Williams signed in",
            "Platform": "WEB",
            "Device": "Chrome(132.0.0)",
            "IPAddress": "203.223.189.10",
            "ActionTs": "2025-02-02 23:28:36 -05:00"
        }
    ],
    "Page": 1,
    "TotalRecords": 4,
    "TotalPages": 1,
    "PageSize": 100,
    "Errors": null
}