Node.js
import { createHmac } from "node:crypto";
// Node.js 18+. Set credentials and resource values on your server.
function required(name) {
const value = process.env[name];
if (!value) throw new Error(`Set ${name} before running this example.`);
return value;
}
const baseUrl = process.env.LEDIG_API_BASE_URL ?? "https://api-sandbox.ledig.io";
const method = "GET";
const id = required("LEDIG_RECIPIENT_ID");
const path = `/v1/recipients/${encodeURIComponent(id)}`;
const pathWithQuery = path;
const rawBody = "";
const headers = { "Accept": "application/json" };
const timestamp = Math.floor(Date.now() / 1000).toString();
const payload = `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;
headers["x-ledig-key"] = required("LEDIG_API_KEY");
headers["x-ledig-timestamp"] = timestamp;
headers["x-ledig-signature"] = "v1=" + createHmac("sha256", required("LEDIG_API_SECRET"))
.update(payload).digest("base64");
const response = await fetch(`${baseUrl}${pathWithQuery}`, {
method,
headers,
});
const result = await response.json();
// Use result in your application; do not log credentials or upload links.
console.log(response.status);{
"status": "success",
"data": {
"id": "recipient_example_001",
"profileId": "profile_example_001",
"recipientRequirementId": "crypto_address",
"fields": {
"network": "ETHEREUM_SEPOLIA",
"address": "0x1111111111111111111111111111111111111111",
"accountName": "Example Treasury"
},
"destinationScope": {
"network": "ETHEREUM_SEPOLIA",
"assets": [
"USDC"
]
},
"is3rdParty": true,
"oneTime": false,
"deletedAt": null,
"active": true,
"object": "recipients",
"fieldsDetail": [
{
"name": "address",
"displayName": "Wallet address",
"value": "0x1111111111111111111111111111111111111111",
"required": true,
"visible": true,
"copyable": true
},
{
"name": "accountName",
"displayName": "Account Name",
"value": "Example Treasury",
"required": true,
"visible": true,
"copyable": true
}
],
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z",
"reviewStatus": "approved",
"usableForPayout": true,
"payoutReadiness": "checks_required"
}
}{
"status": "error",
"code": "UNAUTHORIZED",
"message": "Authentication is required."
}{
"status": "error",
"code": "FORBIDDEN",
"message": "You do not have permission to perform this action."
}{
"status": "error",
"code": "NOT_FOUND",
"message": "The requested resource was not found."
}{
"status": "error",
"code": "RATE_LIMITED",
"message": "Too many requests. Wait before trying again."
}Recipients
View a recipient
Read a recipient’s payment details and review status.
GET
/
v1
/
recipients
/
{id}
Node.js
import { createHmac } from "node:crypto";
// Node.js 18+. Set credentials and resource values on your server.
function required(name) {
const value = process.env[name];
if (!value) throw new Error(`Set ${name} before running this example.`);
return value;
}
const baseUrl = process.env.LEDIG_API_BASE_URL ?? "https://api-sandbox.ledig.io";
const method = "GET";
const id = required("LEDIG_RECIPIENT_ID");
const path = `/v1/recipients/${encodeURIComponent(id)}`;
const pathWithQuery = path;
const rawBody = "";
const headers = { "Accept": "application/json" };
const timestamp = Math.floor(Date.now() / 1000).toString();
const payload = `${timestamp}.${method}.${pathWithQuery}.${rawBody}`;
headers["x-ledig-key"] = required("LEDIG_API_KEY");
headers["x-ledig-timestamp"] = timestamp;
headers["x-ledig-signature"] = "v1=" + createHmac("sha256", required("LEDIG_API_SECRET"))
.update(payload).digest("base64");
const response = await fetch(`${baseUrl}${pathWithQuery}`, {
method,
headers,
});
const result = await response.json();
// Use result in your application; do not log credentials or upload links.
console.log(response.status);{
"status": "success",
"data": {
"id": "recipient_example_001",
"profileId": "profile_example_001",
"recipientRequirementId": "crypto_address",
"fields": {
"network": "ETHEREUM_SEPOLIA",
"address": "0x1111111111111111111111111111111111111111",
"accountName": "Example Treasury"
},
"destinationScope": {
"network": "ETHEREUM_SEPOLIA",
"assets": [
"USDC"
]
},
"is3rdParty": true,
"oneTime": false,
"deletedAt": null,
"active": true,
"object": "recipients",
"fieldsDetail": [
{
"name": "address",
"displayName": "Wallet address",
"value": "0x1111111111111111111111111111111111111111",
"required": true,
"visible": true,
"copyable": true
},
{
"name": "accountName",
"displayName": "Account Name",
"value": "Example Treasury",
"required": true,
"visible": true,
"copyable": true
}
],
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z",
"reviewStatus": "approved",
"usableForPayout": true,
"payoutReadiness": "checks_required"
}
}{
"status": "error",
"code": "UNAUTHORIZED",
"message": "Authentication is required."
}{
"status": "error",
"code": "FORBIDDEN",
"message": "You do not have permission to perform this action."
}{
"status": "error",
"code": "NOT_FOUND",
"message": "The requested resource was not found."
}{
"status": "error",
"code": "RATE_LIMITED",
"message": "Too many requests. Wait before trying again."
}Required scope:
recipient_read
payoutReadiness describes the recipient’s saved state: unavailable means it cannot currently be used; review_pending means review is pending; review_refresh_required means a new review is needed; checks_required means quote and payment checks are still required. usableForPayout is a selection hint and does not mean approval to send. Reading this endpoint does not run new payment checks. Create a quote and check its result before sending.