Documentation Index
Fetch the complete documentation index at: https://docs.wepayout.co/llms.txt
Use this file to discover all available pages before exploring further.
List KYC
Retrieves a list of pending KYC verifications.
Status: You can filter KYC results by using the status_id query parameter at the KYC listing endpoint. Below are the available status values.
Status Table
| TENDER ID | STATUS NAME |
|---|
| 1 | Awaiting Upload Documents |
| 2 | Awaiting Approval Documents |
| 3 | Approved |
| 4 | Pending Regularization |
| 5 | Canceled |
Query Parameters
The current number you wish to view.
The maximum number of items shown per page.
Sort order.Allowed values: 0, 1, 2, 3, 4, 5
Status filter.Allowed values: 1, 2, 3, 4, 5
Response
Array of KYC records.
Unique identifier for the KYC record.
Identifier or reference of the original request that triggered this KYC process.Example: PAYIN or REQUEST
Textual description or details about the KYC request.
Additional notes or observations about the KYC request.
Date and time of the KYC record was created.Format: YYYY-MM-DD HH:mm:ss
Date and time of the last update made to this KYC record.Format: YYYY-MM-DD HH:mm:ss
Name of the main merchant associated with the KYC process.
Identifier of the submerchant involved in the KYC process.
Object representing the current status of the KYC.
Status identifier.Example: 1
Name of the status.Example: Waiting Upload Documents, Waiting Approval Documents, Approved, Pending Regularization or Canceled
Object with information about the person or entity being verified.
Document number used for identification.
Request Example
curl --request GET \
--url 'https://api.sandbox.wepayout.com.br/v1/kyc' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer 123'
[
{
"id": 1563,
"origin_request": "PAYIN",
"description": "test",
"notes": null,
"created_at": "2025-05-19 10:53:48",
"updated_at": "2025-05-19 10:53:48",
"merchant": "Merchant's name",
"submerchant": null,
"status": {
"id": 1,
"name": "Waiting Upload Documents"
},
"beneficiary": {
"id": 1691,
"name": "TEST",
"document": "12345678987"
}
}
]
Use Cases
Monitor Pending KYC Verifications
Track all KYC verifications that are awaiting document upload:async function getPendingKYC() {
const pending = await listKYC({ status_id: 1 });
console.log(`Found ${pending.length} pending KYC verifications`);
pending.forEach(kyc => {
console.log(`- ${kyc.beneficiary.name}: ${kyc.status.name}`);
});
return pending;
}
Get KYC records by origin (PAYIN or REQUEST):async function getKYCByOrigin(origin) {
const allKYC = await listKYC();
return allKYC.filter(kyc => kyc.origin_request === origin);
}
// Get all PAYIN-related KYC
const payinKYC = await getKYCByOrigin('PAYIN');
Monitor KYC status changes over time:async function trackKYCStatus(kycId) {
const allKYC = await listKYC();
const kyc = allKYC.find(k => k.id === kycId);
if (!kyc) {
throw new Error('KYC not found');
}
return {
id: kyc.id,
beneficiary: kyc.beneficiary.name,
currentStatus: kyc.status.name,
lastUpdate: kyc.updated_at,
origin: kyc.origin_request
};
}
Generate a report of all KYC verifications by status:async function generateKYCReport() {
const allKYC = await listKYC();
const report = {
total: allKYC.length,
byStatus: {},
byOrigin: {}
};
allKYC.forEach(kyc => {
// Count by status
const statusName = kyc.status.name;
report.byStatus[statusName] = (report.byStatus[statusName] || 0) + 1;
// Count by origin
const origin = kyc.origin_request;
report.byOrigin[origin] = (report.byOrigin[origin] || 0) + 1;
});
return report;
}
// Usage
const report = await generateKYCReport();
console.log('KYC Report:', report);
// Output: { total: 50, byStatus: { 'Approved': 30, 'Pending': 20 }, byOrigin: { 'PAYIN': 35, 'REQUEST': 15 } }
Status Workflow
Best Practices
Pagination: Always use pagination when listing KYC records to avoid performance issues. The default page size is 10.
Status Monitoring: Regularly check KYC status to ensure timely document uploads and approvals.
Filter by Status: Use the status_id parameter to filter KYC records by specific statuses and reduce response size.
Get Balance
Check account balance
Create Charge
Create a new charge
Create Payment
Create a payout payment
Get Statement
View account statement
