Beneficiary Details
curl --request GET \
--url https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId} \
--header 'X-Auth-Token: <x-auth-token>' \
--header 'platform: <platform>' \
--header 'uuid: <uuid>'import requests
url = "https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}"
headers = {
"platform": "<platform>",
"uuid": "<uuid>",
"X-Auth-Token": "<x-auth-token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {platform: '<platform>', uuid: '<uuid>', 'X-Auth-Token': '<x-auth-token>'}
};
fetch('https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Auth-Token: <x-auth-token>",
"platform: <platform>",
"uuid: <uuid>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("platform", "<platform>")
req.Header.Add("uuid", "<uuid>")
req.Header.Add("X-Auth-Token", "<x-auth-token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}")
.header("platform", "<platform>")
.header("uuid", "<uuid>")
.header("X-Auth-Token", "<x-auth-token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["platform"] = '<platform>'
request["uuid"] = '<uuid>'
request["X-Auth-Token"] = '<x-auth-token>'
response = http.request(request)
puts response.read_bodyAPI Endpoints
Beneficiary Details
Retrieves the full profile and banking details for a specific saved beneficiary.
GET
/
usermanagement
/
view-beneficiery-details
/
{beneficiaryId}
Beneficiary Details
curl --request GET \
--url https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId} \
--header 'X-Auth-Token: <x-auth-token>' \
--header 'platform: <platform>' \
--header 'uuid: <uuid>'import requests
url = "https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}"
headers = {
"platform": "<platform>",
"uuid": "<uuid>",
"X-Auth-Token": "<x-auth-token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {platform: '<platform>', uuid: '<uuid>', 'X-Auth-Token': '<x-auth-token>'}
};
fetch('https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Auth-Token: <x-auth-token>",
"platform: <platform>",
"uuid: <uuid>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("platform", "<platform>")
req.Header.Add("uuid", "<uuid>")
req.Header.Add("X-Auth-Token", "<x-auth-token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}")
.header("platform", "<platform>")
.header("uuid", "<uuid>")
.header("X-Auth-Token", "<x-auth-token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/{beneficiaryId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["platform"] = '<platform>'
request["uuid"] = '<uuid>'
request["X-Auth-Token"] = '<x-auth-token>'
response = http.request(request)
puts response.read_bodyRetrieves all stored details for a single beneficiary, identified by the unique
{beneficiaryId}. This includes personal information and the associated payout account details.
Request Headers
This endpoint requires a valid Access Token for authorization.string
required
The JWT Access Token obtained from the
/login or /refresh-token
endpoint.string
default:"fincode"
required
Platform identifier. Use
fincode.string
default:"200"
required
Unique request identifier.
Path Parameters
string
default:"6327c026-c646-4a9d-86b2-57731d867727"
required
The unique ID of the beneficiary whose details are being requested.
Code Examples
curl --location 'https://{your-domain}.fincode.software/api/v6/services/usermanagement/view-beneficiery-details/6327c026-c646-4a9d-86b2-57731d867727' \
--header 'X-Auth-Token: YOUR_JWT_ACCESS_TOKEN' \
--header 'platform: fincode' \
--header 'uuid: 200'
const axios = require('axios');
const BASE_URL =
'https://{your-domain}.fincode.software/api/v6/services/usermanagement';
async function viewBeneficiaryDetails(accessToken, beneficiaryId) {
const url = `${BASE_URL}/view-beneficiery-details/${beneficiaryId}`;
try {
const response = await axios.get(url, {
headers: {
'X-Auth-Token': accessToken,
platform: 'fincode',
uuid: '200',
},
});
const beneficiary = response.data;
console.log(
`Fetched Beneficiary: ${beneficiary.firstName} ${beneficiary.lastName}`
);
console.log(`Receiving Country: ${beneficiary.countryCode}`);
console.log(`Bank: ${beneficiary.bankDetails.bankName}`);
console.log(`Account: ${beneficiary.bankDetails.accountNumber}`);
return beneficiary;
} catch (error) {
console.error(
'Failed to fetch beneficiary details:',
error.response?.data || error.message
);
throw error;
}
}
⌘I