Retrieve User Account

POST /user_account/session/get

Returns user permissioned account data including identity and Item access tokens.

Request Body

Required

UserAccountSessionGetRequest defines the request schema for /user_account/session/get

Parameters

client_id
string
Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
secret
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
public_token
required, string
The public token generated by the end user Layer session.

Response

UserAccountSessionGetResponse defines the response schema for /user_account/session/get

Response Properties

identity
required, object
The identity data permissioned by the end user during the authorization flow.
name
object
The user’s first name and last name.
first_name
string
last_name
string
address
object
The user’s address.
city
string
The full city name
region
string
The region or state. Example: "NC"
street
string
The full street address Example: "564 Main Street, APT 15"
street2
string
The second line street address
postal_code
string
The postal code. In API versions 2018-05-22 and earlier, this field is called zip.
country
string
The ISO 3166-1 alpha-2 country code
phone_number
string
The user’s phone number in E.164 format
email
string
The user’s email address. Note: email is currently not returned for users, and will be added later in 2025.
date_of_birth
string
The user’s date of birth.
ssn
string
The user’s social security number.
ssn_last_4
string
The last 4 digits of the user’s social security number.
items
required, array[object]
item_id
string
The Plaid Item ID. The item_id is always unique; linking the same account at the same institution twice will result in two Items with different item_id values. Like all Plaid identifiers, the item_id is case-sensitive.
access_token
string
The access token associated with the Item data is being requested for.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.