---
title: "Get Payee by Id"
method: GET
path: "/v1/payees/{payeeId}"
tags: ["Payees"]
deprecated: true
---

# Get Payee by Id

`GET /v1/payees/{payeeId}`

> **Deprecated.**

Get Payee by Id

Please use V3 instead.

## Path parameters

- `payeeId` string, uuid, required

## Query parameters

- `sensitive` boolean

## Response `200`

Success response, request completed okay

- Payee
  - `payeeId` string, uuid
  - `payorRefs` PayeePayorRef[], nullable
    - `payorId` string, uuid
    - `remoteId` string
    - `invitationStatus` string
  - `email` string, email, nullable
  - `address` PayeeAddress
    - `line1` string, required
    - `line2` string, nullable
    - `line3` string, nullable
    - `line4` string, nullable
    - `city` string, required
    - `countyOrProvince` string, nullable
    - `zipOrPostcode` string, nullable
    - `country` string, required
  - `country` string
  - `displayName` string
  - `paymentChannel` PayeePaymentChannel
    - `paymentChannelName` string
    - `iban` string — Must match the regular expression ```^[A-Za-z0-9]+$```.
    - `accountNumber` string, required
    - `routingNumber` string, required
    - `countryCode` string, required — Country Code must be a valid 2 letter ISO 3166-1 country code.
    - `currency` 'USD' | 'GBP' | 'EUR', required
    - `accountName` string, required
  - `challenge` Challenge
    - `value` string, required
    - `description` string, required
  - `language` string — An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment.
  - `acceptTermsAndConditionsTimestamp` string, date-time, nullable — The timestamp when the payee last accepted T&Cs
  - `cellphoneNumber` string
  - `payeeType` 'Individual' | 'Company'
  - `company` CompanyV1, nullable
    - `name` string, required
    - `taxId` string, nullable — Company Tax Id (EIN) must be 9 numeric characters. Must match the regular expression ```[\d]{9}```.
    - `operatingName` string, nullable
  - `individual` IndividualV1
    - `name` IndividualV1Name, required
      - `title` string
      - `firstName` string, required
      - `otherNames` string
      - `lastName` string, required
    - `nationalIdentification` string — If not authorized to view, value will be masked. Example: XXXXX1234
    - `dateOfBirth` string, required — If not authorized to view, value will be masked. Example: - XXXX-XX-XX
  - `created` string, date-time
  - `gracePeriodEndDate` string, date, nullable
  - `lastOfacCheckTimestamp` string, date_time, nullable
  - `marketingOptIns` MarketingOptIn[]
    - `optedIn` boolean
    - `timestamp` string, date-time
  - `ofacStatus` 'PENDING' | 'PASSED' | 'FAILED'
  - `onboardedStatus` 'CREATED' | 'INVITED' | 'REGISTERED' | 'ONBOARDED'

## Other responses

- `404` — Payee Not found

## Changes

- **2020-09-25** `dd71433847a6` — 11 info
  - removed the `AR` enum value from the `language` response property for the response status `200`
  - removed the `EN` enum value from the `language` response property for the response status `200`
  - removed the `ES` enum value from the `language` response property for the response status `200`
  - removed the `FR` enum value from the `language` response property for the response status `200`
  - …7 more
- **2020-02-27** `7c8cfeb59952` — 5 breaking, 3 warning, 3 info
  - the `address/country` response property's maxLength was increased from `2` to `50` for the response status `200`
  - the `country` response property's maxLength was unset from `2` for the response status `200`
  - the `paymentChannel/currency` response property's maxLength was unset from `3` for the response status `200`
  - the `country` response property's minLength was decreased from `2` to `0` for the response status `200`
  - …7 more
- **2020-02-03** `68f50053dc40` — 6 info
  - removed the `EUR` enum value from the `paymentChannel/currency` response property for the response status `200`
  - removed the `GBP` enum value from the `paymentChannel/currency` response property for the response status `200`
  - removed the `USD` enum value from the `paymentChannel/currency` response property for the response status `200`
  - the `address/country` response's property pattern `^[A-Z]{2}$` was added for the status `200`
  - …2 more
- …earlier changes not shown

[Full history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v1/payees/:payeeId/get.md)

---

[API](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis.md) · [All operations](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/llms.txt) · [OpenAPI document](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/revisions/dd71433847a6?raw)