---
title: "Get user attributes for destination_token"
method: GET
path: "/payout/attribute/{user_token}/{destination_token}/{currency}"
tags: ["Attribute"]
deprecated: true
---

# Get user attributes for destination_token

`GET /payout/attribute/{user_token}/{destination_token}/{currency}`

## Request

- Base URL: `https://api.masspay.io/v1.0.0`
- URL: `https://api.masspay.io/v1.0.0/payout/attribute/{user_token}/{destination_token}/{currency}`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/masspay/apis/masspay-api/docs/payout/attribute/:user_token/:destination_token/:currency/get.ts> (a function with typed inputs; its response is checked against the schema)

> **Deprecated.**

This **GET** endpoint is used to retrieve user attributes for a specific destination token. <br> You can use this endpoint to retrieve user attributes and provide personalized service to your users based on their preferences, demographic data, or other relevant information. <br> To use this endpoint, you need to provide the `user_token`, `destination_token`, and `currency` as parameters in the URL Path. <br> The endpoint will then return all the required attributes for the provided user for the specified destination token. If any of the attributes already have a stored value, it will be returned as well.

## Path parameters

- `user_token` string, required
- `destination_token` string, required

## Query parameters

- `show_latest_attr_set_token` boolean
- `show_translated_labels` boolean
- `include_completed_global_attributes` boolean

## Headers

- `Idempotency-Key` string
- `Language` string

## Response `200`

successful operation

- AttrsRequirement[]
  - `token` string, required: The token that represents the attribute.
  - `attr_set_token` string: The token that represents the stored attributes for this payer. You would use this token in attr_set_token of `initiatePayout` if you have to specify an account number when paying a transaction out.
  - `label` string, required: The label that describes that required attribute
  - `validation` string, required: RegEx that validates that input
  - `is_optional` boolean, required: Flag to indicate whether this field is required or not
  - `value` string: The existing value that is stored. 'Null' if no existing value is stored.
  - `expected_value` string: Written explanation of the value that the regex validation requires
  - `type` 'CardNumber' | 'BankAccountType' | 'BankAccountNumber' | 'BankAccountBranchNumber' | 'BankName' | 'PhoneNumber' | 'Gender' | 'IdentificationNumber' | 'BillReferenceNumber' | 'BankRoutingNumber' | 'BankAccountName' | 'MaidenName' | 'SocialSecurity' | 'EmploymentName' | 'EmploymentAddress' | 'EmploymentPhone' | 'EmploymentOccupation' | 'EmploymentSupervisor' | 'RemittanceReason' | 'Relationship' | 'SecondLastName' | 'SWIFT' | 'BirthCountry' | 'SourceOfFunds' | 'DateOfBirth' | 'CardExpiration' | 'CardZip' | 'IdentificationType' | 'BankCity' | 'BankState' | 'IDSelfieCollection' | 'City' | 'Country' | 'IdentificationExpiration' | 'Address1' | 'IFramePaymentCollection' | 'PostalCode' | 'GuardianFullName' | 'GuardianGovIDType' | 'GuardianGovIDNumber' | 'GuardianConsent' | 'EIN' | 'WalletAddress' | 'OAuthGrant' | 'SecurityAnswer', required: The type of attribute
  - `input_type` 'text' | 'options' | 'date', required: The type of input field that is suggested for this this attribute
  - `last_attr_value_used` boolean: If set to true, it means this was the last value that was used and if no attr_set_token is provided to init payout, this value will be used by default

## Other responses

- `400`: Bad request.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Not found.
- `405`: Method Not Allowed.
- `500`: Internal server error.
- `504`: Gateway Time-out.

## Changes

- **2026-11-03** `f9fa41b7c45c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/masspay/apis/masspay-api/changes/payout/attribute/:user_token/:destination_token/:currency/get.md)

---

[API](https://skmtc.dev/masspay/apis/masspay-api.md) - [All operations](https://skmtc.dev/masspay/apis/masspay-api/llms.txt) - [OpenAPI document](https://skmtc.dev/masspay/apis/masspay-api/revisions/f9fa41b7c45c?raw)