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

# Get Payee by Id

`GET /v2/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

- PayeeResponseV2
  - `payeeId` string, uuid
  - `payorRefs` PayeePayorRefV2[], nullable
    - `payorId` string, uuid
    - `remoteId` string
    - `invitationStatus` 'ACCEPTED' | 'PENDING' | 'DECLINED'
    - `invitationStatusTimestamp` string, date-time, nullable — The timestamp when the invitation status is updated
    - `paymentChannelId` string, uuid
  - `email` string, email, nullable
  - `onboardedStatus` 'CREATED' | 'INVITED' | 'REGISTERED' | 'ONBOARDED'
  - `ofacStatus` 'PENDING' | 'PASSED' | 'FAILED'
  - `language` 'AR' | 'EN' | 'ES' | 'FR' | 'HE' | 'HI' | 'JA' | 'PT' | 'RU' | 'UR' | 'ZH' — Available Payee Language codes
  - `created` string, date-time
  - `country` string
  - `displayName` string
  - `payeeType` 'Individual' | 'Company'
  - `disabled` boolean
  - `disabledComment` string
  - `disabledUpdatedTimestamp` string, date-time
  - `address` PayeeAddress2
    - `line1` string, required
    - `line2` string, nullable
    - `line3` string, nullable
    - `line4` string, nullable
    - `city` string, required
    - `countyOrProvince` string, nullable
    - `zipOrPostcode` string, nullable
    - `country` string, required
  - `individual` Individual
    - `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
  - `company` Company, nullable
    - `name` string, required
    - `taxId` string, nullable — Company Tax Id must be between 6 and 30 characters long
    - `operatingName` string, nullable
  - `cellphoneNumber` string
  - `lastOfacCheckTimestamp` string, date_time, nullable
  - `ofacOverride` boolean
  - `ofacOverrideReason` string
  - `ofacOverrideTimestamp` string, date_time, nullable
  - `gracePeriodEndDate` string, date, nullable
  - `enhancedKycCompleted` boolean
  - `kycCompletedTimestamp` string, date_time, nullable
  - `pausePayment` boolean
  - `pausePaymentTimestamp` string, date_time, nullable
  - `marketingOptInDecision` boolean
  - `marketingOptInTimestamp` string, date_time, nullable
  - `acceptTermsAndConditionsTimestamp` string, date-time, nullable — The timestamp when the payee last accepted T&Cs

## Other responses

- `404` — Payee Not found

## Changes

- **2020-01-28** `1b2abf26b5d6` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/velopaymentsapi/apis/velo-payments-apis/changes/v2/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/1b2abf26b5d6?raw)