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

# Get user attributes for destination_token

`GET /attribute/{user_token}/{endpoint_token}/{currency}`

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`, `endpoint_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
- `endpoint_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

- AttrSetRequirement[]
  - `attr_set_token` string, required — 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. For attributes that are not endpoint specific, like ID, EIN, SSN, etc, `attr_set_token` will not be set.
  - `last_attr_value_used` boolean, required — 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
  - `label` string — User-defined label for identifying or naming the set of attributes. Useful for UI display or future reference.
  - `destination_currency` string — The currency that the `attr_set_token` is associated with
  - `attributes` object[]
    - `token` string, required — The token that represents the attribute.
    - `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, required — The existing value that is stored. 'Null' if no existing value is stored.
    - `expected_value` string, required — 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', required — The type of attribute
    - `input_type` 'text' | 'options' | 'date', required — The type of input field that is suggested for this this attribute

## Other responses

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

---

[API](https://skmtc.net/masspay/apis/masspay-api.md) · [All operations](https://skmtc.net/masspay/apis/masspay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/masspay/masspay-api/revisions/c03b61a6a551/schema)
