- Taxpayers
- List taxpayers
Taxpayers
List taxpayers
List the taxpayers of a firm, optionally filtered by external id or email address.
GET
/v1/firms/{firmId}/taxpayers
curl --request GET \
--url https://public-api.sandbox.remitian.com/v1/firms/{firmId}/taxpayers \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <x_api_key>'
curl --request GET \
--url https://public-api.sandbox.remitian.com/v1/firms/{firmId}/taxpayers \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <x_api_key>'Authorizations
bearerAuth
required
string
Access token from POST /v1/auth/token, sent as `Authorization: Bearer {accessToken}`.
Query Parameters
firmId
required
string
Unique identifier of the firm.
externalId
string
Filter by your system's identifier.
emailAddress
string
Filter by the taxpayer user's email address. Exact match, case-insensitive.
encryptedTin
string
Filter by exact TIN, encrypted with the Remitian TIN encryption public key (RSA-OAEP SHA-256, base64url without padding).
pageNumber
integer
Page to retrieve, starting at 1.
pageSize
integer
Items per page.
x-api-key
required
string
API key of your Client Application.
Response
application/json
200
400
401
403
404
OK
items
required
array
List of taxpayers linked to the firm.
totalCount
required
integer
Total number of taxpayers across all pages.
totalPages
required
integer
Total number of pages.
currentPage
integer
Current page number (nullable).
pageSize
integer
Number of items per page (nullable).
curl --request GET \
--url https://public-api.sandbox.remitian.com/v1/firms/{firmId}/taxpayers \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <x_api_key>'
curl --request GET \
--url https://public-api.sandbox.remitian.com/v1/firms/{firmId}/taxpayers \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <x_api_key>'