---
title: "Retrieve a recipient"
method: GET
path: "/recipients/{recipientId}"
tags: ["Recipients"]
---

# Retrieve a recipient

`GET /recipients/{recipientId}`

Returns the details of a recipient.

## Path parameters

- `recipientId` string, required — The recipient's ID.

## Query parameters

- `accountId` string, required — The ID of the account to work with.

## Response `200`

OK

- object
  - `id` string, nullable — The recipient's ID.
  - `accountId` string, nullable — The ID of the account to work with.
  - `accountIdentifier` string, nullable — Identifier of the account, could be iban or account number
  - `bankIdentifier` string, nullable — Identifier of the bank, could be BIC or sort code
  - `schemeName` 'UK.OBIE.IBAN' | 'UK.OBIE.SortCodeAccountNumber', nullable — The name of the scheme.
  - `name` string, nullable — The recipient's name.
  - `friendlyName` string, nullable — An optional friendly name for the recipient. This is used only for display purposes.
  - `intermediaryBankIdentifier` string, nullable — The intermediary bank identifier: either a BIC or a numeric account number.
  - `paymentNetwork` 'SWIFT' | 'SEPA.INSTANT' | 'SEPA.CREDITTRANSFER' | 'CHAPS' | 'UKFPS' | 'ACH' | 'WIRETRANSFER' | 'OFF_PLATFORM' | 'NIP', nullable, required
  - `purposeCode` string, nullable
  - `email` string, nullable — The recipient's email address.
  - `defaultPurpose` string, nullable — The purpose of the payment.
  - `defaultReference` string, nullable
  - `status` 'UNVERIFIED' | 'PENDING' | 'AUTHORISED' | 'REJECTED', required — The recipient's status.
  - `sepa` boolean, nullable
  - `currency` string, required — The currency code, in ISO-4217 format.
  - `bankCode` string, nullable
  - `createdBy` string, nullable
  - `recipientType` string, nullable
  - `verificationMethod` 'phone' | 'sms_otp' | 'biometrics' | 'email' | 'other', nullable
  - `recipientAddress` object — Details about the address of the recipient.
    - `country` string, nullable, required
    - `address` string, nullable — The recipient's address.
    - `city` string, nullable — The recipient's city.
    - `postcode` string, nullable — The recipient's postcode.
  - `bankAddress` object — Details about the bank's address.
    - `bankName` string, nullable — The name of the bank.
    - `fullBankName` string, nullable — The full name of the bank.
    - `city` string, nullable — The bank's city.
    - `postcode` string, nullable — The bank's postal or ZIP code.
    - `country` string, nullable, required
    - `address` string, nullable — The bank's address.
  - `validation` object
    - `nameMatch` boolean
    - `reason` string
    - `reasonCode` 'N000' | 'N100' | 'N101' | 'N102' | 'N103' | 'N104' | 'N200' | 'N201' | 'N202' | 'N203' | 'N204' | 'N205' | 'N206' | 'N207' | 'N300' | 'N400' | 'N500', required
    - `actualName` string — The actual name of the recipient.
  - `bankDetailsFormat` 'bic-accountnumber' | 'usroutingnumber-accountnumber' | 'bic-caroutingnumber-accountnumber' | 'bic-bsb-accountnumber' | 'bic-ifsc-accountnumber' | 'sortcode-accountnumber' | 'bic-clabe' | 'bic-iban', nullable

---

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