Get a Beneficiary

Overview

This service is used to get the details of a particular beneficiary including status. Simply add a beneficiary account id to your GET URL and you will be returned the beneficiary details including ID, accountNumber, bankName, address, clientReference, status and other fields too.

Resource Access

• HTTP Method: GET
• Endpoint: /profile/v2.1/beneficiaries/{beneficiaryId}
• Authentication: Bearer token required (Authorization: Bearer {access_token})

Path Parameters

Parameter	Type	Required	Description
beneficiaryId	number	Yes	A unique identifier assigned to the beneficiary.

Response

Success Response (200 OK)

{
  "success": true,
  "account": {
    "id": 284,
    "accountNumber": "2000293918130",
    "bankName": "PUNJAB NATIONAL BANK",
    "beneficiaryAddress": "INSTITUTIONAL AREA, PLOT, NO.05 PNB SWIFT CENTRE - FLOOR 1 GURUGRAM - SECTOR 32",
    "beneficiaryCity": "HARYANA",
    "beneficiaryCompanyName": "Ahrvo",
    "beneficiaryCountryCode": "IN",
    "beneficiaryEntityType": "company",
    "beneficiaryPostcode": "122001",
    "country": "India",
    "reference": "RP-16062022-001",
    "beneficiaryFirstName": "Jon",
    "beneficiaryLastName": "Doe",
    "nationalId": "PUNB0644100",
    "currency": "INR",
    "clientReference": "Test Beneficiary",
    "status": "approved"
  }
}

Response Fields

Field	Type	Description
success	boolean	Indicates whether the query was successful.
account.id	number	Unique identifier assigned to the beneficiary.
account.accountNumber	string	Account number or IBAN.
account.bankName	string	Institution name.
account.beneficiaryEntityType	string	individual or company.
account.currency	string	Currency of the beneficiary.
account.status	string	Verification status (approved, pending verification, rejected).

Error Responses

• 400 Bad Request: Invalid beneficiary ID format.
• 401 Unauthorized: Missing or expired Bearer token.
• 403 Forbidden: Beneficiary belongs to another organization.
• 404 Beneficiary Not Found: No beneficiary exists with the specified ID.
• 500 Internal Server Error: Platform error.

Code Examples

cURL

curl -X GET "https://api.ahrvo.network/banking/ibans/v2/profile/v2.1/beneficiaries/284" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

Python

import requests

url = "https://api.ahrvo.network/banking/ibans/v2/profile/v2.1/beneficiaries/284"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
account = data.get("account", {})
print(f"Beneficiary {account.get('id')} status: {account.get('status')}")

JavaScript / Node.js

const response = await fetch("https://api.ahrvo.network/banking/ibans/v2/profile/v2.1/beneficiaries/284", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
  }
});

const data = await response.json();
console.log("Beneficiary status:", data.account?.status);

Interactive API Explorer