Get Beneficiary by ID (Atlas)

Overview

The GET /banking/ibans/v2/recipients/{recipientId} endpoint retrieves the complete profile for a specified recipient account, including banking details, verification states, correspondent banking configurations (forFurtherCredit), and associated wallet addresses.

Resource Access

• HTTP Method: GET
• Endpoint: /banking/ibans/v2/recipients/{recipientId}
• Authentication: Bearer token required

Request Headers

Header	Value	Required	Description
Authorization	Bearer {access_token}	Yes	JWT Bearer access token
Accept	application/json	Yes	Response payload format
x-api-key	string	No	Optional API key

Path Parameters

Parameter	Type	Required	Description
recipientId	string	Yes	Unique identifier of the beneficiary record (e.g. 948201).

Response

Success Response (200 OK)

{
  "success": true,
  "accounts": {
    "id": 948201,
    "companyId": 1045,
    "currencyId": 1,
    "paymentMode": "LOCAL",
    "beneficiaryType": "company",
    "companyName": "Acme Global Logistics Ltd",
    "accountNumber": "20406080",
    "bankCode": "200000",
    "bankName": "Barclays Bank UK",
    "bankAddress": {
      "countryCode": "GB",
      "city": "London",
      "address": "1 Churchill Place"
    },
    "beneficiaryAddress": {
      "countryCode": "GB",
      "city": "London",
      "addressLine1": "100 Bishopsgate",
      "postCode": "EC2N 4AG"
    },
    "partyType": "Third_Party",
    "verificationState": "approved",
    "copVerification": "confirmed",
    "isAccountActive": true,
    "isArchived": false,
    "createdAt": "2026-09-15T18:30:00.000Z"
  }
}

Response Fields

Field	Type	Description
success	boolean	Indicates successful retrieval.
accounts.id	integer	Unique recipient identifier.
accounts.paymentMode	string	Configured payment mode (LOCAL, INTERNATIONAL, STABLECOIN, etc.).
accounts.verificationState	string	Verification status (approved, pending, rejected).
accounts.copVerification	string	Confirmation of Payee status result.
accounts.isAccountActive	boolean	True if the account is operational.

Error Responses

• 400 Bad Request: Invalid recipientId format.
• 401 Unauthorized: Missing or expired Bearer token.
• 404 Not Found: Beneficiary ID not found or not owned by the authenticated company.
• 500 Internal Server Error: Internal platform failure.

Code Examples

cURL

curl -X GET "https://gateway.ahrvo.network/banking/ibans/v2/recipients/948201" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

Python

import requests

url = "https://gateway.ahrvo.network/banking/ibans/v2/recipients/948201"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
data = response.json()
print("Beneficiary Details:", data["accounts"])

JavaScript (Node.js)

const axios = require('axios');

const url = 'https://gateway.ahrvo.network/banking/ibans/v2/recipients/948201';
const headers = {
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
  'Accept': 'application/json'
};

axios.get(url, { headers })
  .then(res => console.log('Beneficiary:', res.data.accounts))
  .catch(err => console.error(err.response ? err.response.data : err.message));

Interactive API Explorer