Skip to main content
GET
/
v1
/
accounts
/
{account_id}
/
beneficiaries
/
{beneficiary_id}
Get Beneficiary
curl --request GET \
  --url https://api.hopnow.io/v1/accounts/{account_id}/beneficiaries/{beneficiary_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "account_id": "<string>",
  "beneficiary_type": "<string>",
  "title": "<string>",
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "display_name": "<string>",
  "company_name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "address": {
    "address_line": "<string>",
    "city": "<string>",
    "region": "<string>",
    "postal_code": "<string>",
    "country": "<string>"
  },
  "country_code": "<string>",
  "status": "<string>",
  "verified": true,
  "payout_destinations": [
    {}
  ],
  "created": "<string>",
  "updated": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://apidocs.hopnow.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Path Parameters

​
account_id
string
required
The account’s external ID (starts with acc_)
​
beneficiary_id
string
required
The beneficiary’s external ID (starts with bene_)

​
Response

​
id
string
Beneficiary identifier (starts with bene_)
​
object
string
Always returns "beneficiary"
​
account_id
string
Parent account external ID
​
beneficiary_type
string
Beneficiary type: individual or business
​
title
string
Title (e.g., Mr, Ms, Dr)
​
first_name
string
First name
​
middle_name
string
Middle name
​
last_name
string
Last name
​
display_name
string
Display name
​
company_name
string
Company name (for business beneficiaries)
​
email
string
Email address
​
phone
string
Phone number
​
address
object
Beneficiary address
​
country_code
string
Payout country code
​
status
string
Beneficiary status: active, disabled, or inactive
​
verified
boolean
Whether beneficiary has been verified
​
payout_destinations
array
Array of payout destination objects associated with this beneficiary
​
created
string
ISO 8601 timestamp when created
​
updated
string
ISO 8601 timestamp when last updated

​
Response Example

{
  "id": "bene_1234567890abcdef",
  "object": "beneficiary",
  "account_id": "acc_1234567890abcdef",
  "beneficiary_type": "individual",
  "title": null,
  "first_name": "John",
  "middle_name": null,
  "last_name": "Doe",
  "display_name": "John Doe",
  "company_name": null,
  "email": "john.doe@example.com",
  "phone": "+1234567890",
  "address": {
    "address_line": "123 Main St",
    "city": "New York",
    "region": "NY",
    "postal_code": "10001",
    "country": "US"
  },
  "country_code": "US",
  "status": "active",
  "verified": false,
  "payout_destinations": [],
  "created": "2024-01-15T10:00:00Z",
  "updated": "2024-01-15T10:00:00Z"
}