Skip to main content
GET
Get a recipient

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

x-api-key
string
header
required

API key issued by Kira.

Headers

X-Api-Version
string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-04-14"

Path Parameters

recipient_id
string<uuid>
required

UUID of the recipient to read.

Response

Success.

One recipient. A name or contact field you never set is left out altogether rather than returned empty.

recipient_id
string<uuid>

Recipient UUID. Send it on a payout or a quotation.

type
string

Whether the recipient is a person or a company. Available options: individual, business. See Recipient values.

first_name
string

Given name of a person.

middle_name
string

Middle name of a person.

last_name
string

Family name of a person.

company_name
string

Registered name of a company.

phone
string

Phone number.

email
string

Email address.

address

The recipient's own address, which is not the bank's. It comes back as an object when a city is on file, as a plain string when only free text was stored, and is absent when neither is.

account_type
string

Which rail the money travels on. Available options: ACH, WIRE, WALLET. See Recipient values.

account_details
object

Where the money goes. Which fields you get depends on account_type — a wallet, an ACH account, or a wire account.

created_ts
string

When the recipient was created, as an ISO 8601 timestamp.

updated_ts
string

When it last changed, as an ISO 8601 timestamp.

metadata
object

Key/value pairs you attached. {} when you attached none.