Get Taxpayer Profile Action

Returns the logged-in taxpayer’s display name and the tax years that have filings.

This action is available in API version 68.0 and later.

The logged-in user determines the taxpayer. The response fields match Tax Revenue Profile. For the Connect REST resource the taxpayer portal uses, see Tax Revenue Profile (POST).

Special Access Rules

Tax and Revenue Management is turned on, and the caller has the Tax and Revenue permissions for the portal user or the internal user. For setup, see Set Up Tax and Revenue.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/getTaxpayerProfile

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: GET, POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

This action has no input parameters.

Outputs

Output	Type	Description
`displayName`	string	The taxpayer’s display name.
`availableTaxYears`	string[]	The tax years for which filings exist, in descending order. This value is `taxAccount.availableTaxYears` on the Connect response.

Example

GET

This example shows how to get the details of the Get Taxpayer Profile action type.

1curl --include --request GET \
2--header 'Authorization: Bearer 00DR...xyz' \
3--header 'Content-Type: application/json' \
4"https://instance.salesforce.com/services/data/v68.0/actions/standard/getTaxpayerProfile"

POST

Here’s a request for the Get Taxpayer Profile action.

1{
2  "inputs": [
3    {}
4  ]
5}

Here’s a response for the Get Taxpayer Profile action.

1[
2  {
3    "actionName": "getTaxpayerProfile",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "displayName": "Alex Taxpayer",
10      "availableTaxYears": ["2025", "2024"]
11    },
12    "sortOrder": -1,
13    "version": 1
14  }
15]