Invite

Invite

This endpoint can be used to add your team members to your TaxBandits developer console or retail (UI) account.

The request JSON must include the details of the team members, along with their role, assigned payers, and groups.

Available roles:

• Developer: The user can only access the TaxBandits developer console site.
• Team Member: The user can only access the TaxBandits retail (UI) account.
• Co-Admin: The user can access both the developer console and retail (UI) account. They will also have the option to invite more users.

POST TeamMember/Invite 

Request Body

Field	Type	Description
TeamMemberDetails	object[]	Object to identify the team member details to be invited
MemberNm	string	Name of the team member Size Range: 3..75
MemberEmail	string	Email of the team member Size Range: ..100
MemberRole	string	Assigned role for the member Allowed values: Allowed values "TEAM_MEMBER", "CO-ADMIN", "DEVELOPER"
MemberRef	string	Unique reference for the team member Size Range: ..20
AsgnGroups	object[]	Object to identify the assigned groups for the team member
GroupId	Guid	A unique identifier of the group
GroupRef	string	A Unique reference of the group
AsgnPayers	object[]	Object to identify the assigned payer details for the team member
BusinessId	Guid	A unique identifier of the Business
PayerRef	string	A Unique reference of the payer

Response Body

Field	Type	Description
SuccessRecords	object[]	Returns detailed information about the success records
SequenceId	string	A unique reference ID that can be used to identify a team member's details
MemberId	Guid	A Unique identifier of the team member generated by Taxbandits
MemberRole	string	Assigned role for the team member
MemberRef	string	Unique reference of the team member
AsgnGroup	object[]	Gets the assigned group details for the team member
GroupId	Guid	A Unique identifier of the group generated by Taxbandits
GroupRef	string	Unique reference of the group
Status	string	Returns the invite status of the team member
StatusTs	string	Returns the date and time of the team member invite
AsgnPayers	object[]	Gets the assigned payer details for the team member
BusinessId	Guid	A unique identifier of the Business
PayerRef	string	A Unique reference of the payer
Status	string	Returns the invite status of the team member
StatusTs	string	Returns the date and time of the team member invite
ErrorRecords	object[]	Returns detailed information about the error records
SequenceId	string	A unique reference ID that can be used to identify a member's details
MemberId	Guid	A Unique identifier of the team member generated by Taxbandits
MemberRole	string	Assigned role for the team member
MemberRef	string	Unique reference of the team member
AsgnGroup	object[]	Gets the assigned group details for the team member
GroupId	Guid	A Unique identifier of the group generated by Taxbandits
GroupRef	string	Unique reference of the group
AsgnPayers	object[]	Gets the assigned payer details for the team member
BusinessId	Guid	A unique identifier of the Business
PayerRef	string	A Unique reference of the payer
Status	string	Returns the invite status of the team member
StatusTs	string	Returns the date and time of the team member invite
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

{
    "TeamMemberDetails": [
        {
            "MemberNm": "Camille Henderson",
            "MemberEmail": "james@sample.com",
            "MemberRole": "Team_Member",
            "AsgnGroups": [
                {
                    "GroupId": 12897
                }
            ],
            "AsgnPayers": [
                {
                    "BusinessId": "55597001-aeb0-420b-ac53-8b3d4fc15dd8"
                }
            ]
        }
    ]
}

Response JSON

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

{
    "SuccessRecords": [
        {
            "SequenceId": "1",
            "MemberId": "70cbd19e-7b25-42fb-9581-bfcf9a24f059",
            "MemberRole": "Team_Member",
            "MemberRef": null,
            "AsgnGroup": [
                {
                    "GroupId": 12897,
                    "GroupRef": null,
                    "Status": "INVITED",
                    "StatusTs": "2026-01-13 18:45:03 -05:00"
                }
            ],
            "AsgnPayers": [
                {
                    "BusinessId": "55597001-aeb0-420b-ac53-8b3d4fc15dd8",
                    "PayerRef": null,
                    "Status": "ASSIGNED",
                    "StatusTs": "2026-01-13 18:45:04 -05:00"
                }
            ],
            "Errors": null
        }
    ],
    "ErrorRecords": null,
    "Errors": null
}