Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/blindpaylabs/blindpay-node/llms.txt

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

Receivers represent individuals or businesses who receive funds through the BlindPay platform. Each receiver must complete KYC/KYB verification before they can receive payouts.

​
List Receivers

Retrieve all receivers for your instance. 
const response = await blindpay.receivers.list();

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(response.data); // Array of receivers
}

​
Response

​
data
array
Array of receiver objects (individual or business)

​
Get Receiver

Retrieve a specific receiver by ID. 
const response = await blindpay.receivers.get("rcv_123abc");

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(response.data); // Receiver object
}

​
Parameters

​
receiver_id
string
required
The unique identifier of the receiver to retrieve

​
Response

Returns a receiver object (individual or business) with the same structure as shown in the List Receivers response.

​
Update Receiver

Update an existing receiver’s information. 
const response = await blindpay.receivers.update({
  receiver_id: "rcv_123abc",
  email: "newemail@example.com",
  phone_number: "+1-555-0123",
  address_line_1: "456 New St",
  city: "San Francisco",
  state_province_region: "CA",
  postal_code: "94103"
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("Receiver updated successfully");
}

​
Parameters

​
receiver_id
string
required
The unique identifier of the receiver to update
​
email
string
Updated email address
​
phone_number
string
Updated phone number
​
address_line_1
string
Updated first line of address
​
address_line_2
string
Updated second line of address
​
city
string
Updated city
​
state_province_region
string
Updated state, province, or region
​
country
string
Updated two-letter ISO country code
​
postal_code
string
Updated postal or ZIP code
​
account_purpose
string
Purpose of account. Options: "charitable_donations", "ecommerce_retail_payments", "investment_purposes", "business_expenses", "payments_to_friends_or_family_abroad", "personal_or_living_expenses", "protect_wealth", "purchase_goods_and_services", "receive_payments_for_goods_and_services", "tax_optimization", "third_party_money_transmission", "payroll", "treasury_management", "other"
​
external_id
string
Your internal identifier for this receiver
​
image_url
string
URL to profile image or logo
​
ip_address
string
IP address to associate with this receiver
​
tos_id
string
ID of terms of service accepted by receiver

​
Individual-specific fields

​
first_name
string
Updated first name (individuals only)
​
last_name
string
Updated last name (individuals only)
​
date_of_birth
string
Updated date of birth in YYYY-MM-DD format (individuals only)
​
tax_id
string
Updated tax ID (SSN, TIN, etc.)
​
id_doc_type
string
Type of ID: "PASSPORT", "ID_CARD", or "DRIVERS"
​
id_doc_country
string
Country code of ID document issuing country
​
id_doc_front_file
string
Updated front of ID document
​
id_doc_back_file
string
Updated back of ID document
​
proof_of_address_doc_type
string
Type of proof of address: "UTILITY_BILL", "BANK_STATEMENT", "RENTAL_AGREEMENT", "TAX_DOCUMENT", or "GOVERNMENT_CORRESPONDENCE"
​
proof_of_address_doc_file
string
Updated proof of address document
​
selfie_file
string
Updated selfie photo for verification
​
purpose_of_transactions
string
Purpose of transactions (enhanced KYC only): "business_transactions", "charitable_donations", "investment_purposes", "payments_to_friends_or_family_abroad", "personal_or_living_expenses", "protect_wealth", "purchase_good_and_services", "receive_payment_for_freelancing", "receive_salary", or "other"
​
purpose_of_transactions_explanation
string
Explanation if purpose is “other”
​
source_of_funds_doc_type
string
Source of funds type: "business_income", "gambling_proceeds", "gifts", "government_benefits", "inheritance", "investment_loans", "pension_retirement", "salary", "sale_of_assets_real_estate", "savings", "esops", "investment_proceeds", or "someone_else_funds"
​
source_of_funds_doc_file
string
Supporting document for source of funds
​
source_of_wealth
string
Source of wealth: "business_dividends_or_profits", "investments", "asset_sales", "client_investor_contributions", "gambling", "charitable_contributions", "inheritance", or "affiliate_or_royalty_income"

​
Business-specific fields

​
legal_name
string
Updated legal business name (businesses only)
​
alternate_name
string
DBA or alternate name (businesses only)
​
formation_date
string
Business formation date in YYYY-MM-DD format (businesses only)
​
website
string
Business website URL (businesses only)
​
business_type
string
Type of business: "corporation", "llc", "partnership", "sole_proprietorship", "trust", or "non_profit"
​
business_industry
string
NAICS industry code (6-digit code as string)
​
business_description
string
Description of business activities
​
estimated_annual_revenue
string
Estimated annual revenue range: "0_99999", "100000_999999", "1000000_9999999", "10000000_49999999", "50000000_249999999", or "2500000000_plus"
​
publicly_traded
boolean
Whether the business is publicly traded
​
owners
array
Array of owner objects (without id field for updates)
​
incorporation_doc_file
string
Updated incorporation documents (businesses only)
​
proof_of_ownership_doc_file
string
Updated proof of ownership document (businesses only)

​
Response

Returns an empty success response if the update was successful.

​
Delete Receiver

Delete a receiver. This action cannot be undone. 
const response = await blindpay.receivers.delete("rcv_123abc");

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("Receiver deleted successfully");
}

​
Parameters

​
receiver_id
string
required
The unique identifier of the receiver to delete

​
Response

Returns an empty success response if the deletion was successful.

​
Get Receiver Limits

Retrieve the current transaction limits for a receiver. 
const response = await blindpay.receivers.getLimits("rcv_123abc");

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(response.data.limits);
}

​
Parameters

​
receiver_id
string
required
The unique identifier of the receiver

​
Response

​
limits
object
required
Transaction limits for the receiver

​
Get Limit Increase Requests

Retrieve all limit increase requests for a receiver. 
const response = await blindpay.receivers.getLimitIncreaseRequests("rcv_123abc");

if (response.error) {
  console.error(response.error.message);
} else {
  console.log(response.data); // Array of limit increase requests
}

​
Parameters

​
receiver_id
string
required
The unique identifier of the receiver

​
Response

​
data
array
required
Array of limit increase request objects

​
Request Limit Increase

Submit a request to increase a receiver’s transaction limits. 
const response = await blindpay.receivers.requestLimitIncrease({
  receiver_id: "rcv_123abc",
  per_transaction: 100000,
  daily: 500000,
  monthly: 2000000,
  supporting_document_type: "business_bank_statement",
  supporting_document_file: "file_456def"
});

if (response.error) {
  console.error(response.error.message);
} else {
  console.log("Limit increase requested:", response.data.id);
}

​
Parameters

​
receiver_id
string
required
The unique identifier of the receiver
​
per_transaction
number
required
Requested maximum amount per transaction
​
daily
number
required
Requested maximum daily transaction amount
​
monthly
number
required
Requested maximum monthly transaction amount
​
supporting_document_type
string
required
Type of supporting document being provided:
  • "individual_bank_statement" - Individual’s bank statement
  • "individual_tax_return" - Individual’s tax return
  • "individual_proof_of_income" - Individual’s proof of income
  • "business_bank_statement" - Business bank statement
  • "business_financial_statements" - Business financial statements
  • "business_tax_return" - Business tax return
​
supporting_document_file
string
required
File ID or URL of the supporting document that justifies the limit increase

​
Response

​
id
string
required
Unique identifier for the created limit increase request