Bank Account
- POSTValidate bank account and routing number
- GETGet all bank accounts for a user
- POSTAdd a new bank account for a user
- DELDelete a bank account
- GETGet Bank Account Balance
- GETGet bank account details
- POSTAdd bank account
- GETGet all bank accounts for a user
- POSTGet balance approval
- PUTSwitch default bank account
- POSTGet User Details by bank account
Business,Merchant
Refunds
Transaction
Webhook
Processor
Onboard Person
Users
Get All Users
This API provides a comprehensive list of all registered businesses and individuals, including essential details. Pagination options are available to efficiently manage large datasets.
GET
/
3p
/
api
/
v2
/
users
{
"data": [
{
"client_reference_id": "company_45458",
"uuid": "9d264b4a-006c-4d01-acd0-730e27784c59",
"first_name": "John",
"last_name": "Dew",
"email": "[email protected]",
"phone": "2457856490",
"business": {
"name": "John Incorporation",
"tin": "922454715",
"address_type": "Registered",
"address": {
"street_address": "10554 W Quarles Ave",
"city": "Littleton",
"state": "CO",
"country": "US",
"zip": "80127"
},
"trading_name": "John Incorporation",
"entity_type": "Sole Trader",
"incorporation_date": "2024-02-02",
"incorporation_state": "CO",
"industry": "Nature of business",
"industry_classification": {
"code_type": "SIC",
"codes": [
"NAICS 42",
"NAICS 45"
],
"description": "NAICS"
},
"source_of_wealth": "2344",
"source_of_funds": "Industry",
"first_transaction_completed_at": "2024-05-02 16:14:25",
"product_type": "financial",
"registered_as_inactive": false
},
"user_status": "APPROVED",
"kyb_status": "APPROVED",
"kyb_rejected_reason": null,
"financing_credit_balance": null,
"role": "business",
"vendor_name": "Fintech",
"business_owners": [
{
"first_name": "John",
"last_name": "Dew",
"dob": "2023-04-11",
"ssn9": "123456789",
"address_line_1": "10554 W Quarles Ave",
"city": "Littleton",
"state": "CO",
"zip": "80127",
"is_beneficial_owner": true,
"is_director": false,
"is_account_owner": false,
"is_share_holder": false,
"is_significant_control_person": false,
"ownership_percentage": 25,
"email": "[email protected]",
"phone": "2457856490",
"nationality": "US",
"occupation": "Co-founder",
"first_transaction_completed_at": "2024-05-02 16:14:25",
"product_type": "financial"
}
],
"created_at": "2024-10-02 14:06:14",
"updated_at": "2024-10-02 14:06:17"
}
],
"pagination": {
"current_page": 1,
"total_pages": 5,
"total_items": 50,
"per_page": 10
}
}Authorizations
Sanctum token-based authentication using the Bearer scheme.
Query Parameters
Filter users by role
Filter users created after this date (YYYY-MM-DD)
Filter users created before this date (YYYY-MM-DD)
Sort order (asc or desc)
Available options:
asc, desc Page number for pagination
Number of users per page
Response
200
application/json
Users retrieved successfully
Schema for a Business response
Example:
"company_45458"
Example:
"9d264b4a-006c-4d01-acd0-730e27784c59"
Example:
"John"
Example:
"Dew"
Example:
Example:
"2457856490"
Example:
"John Incorporation"
Example:
"922454715"
Example:
"Registered"
Example:
"John Incorporation"
Example:
"Sole Trader"
Example:
"2024-02-02"
Example:
"CO"
Example:
"Nature of business"
Example:
"2344"
Example:
"Industry"
Example:
"2024-05-02 16:14:25"
Example:
"financial"
Example:
false
Example:
"APPROVED"
Example:
"APPROVED"
Example:
null
Example:
null
Example:
"business"
Example:
"Fintech"
Example:
"John"
Example:
"Dew"
Example:
"2023-04-11"
Example:
"123456789"
Example:
"10554 W Quarles Ave"
Example:
"Littleton"
Example:
"CO"
Example:
"80127"
Example:
true
Example:
false
Example:
false
Example:
false
Example:
false
Example:
25
Example:
Example:
"2457856490"
Example:
"US"
Example:
"Co-founder"
Example:
"2024-05-02 16:14:25"
Example:
"financial"
Example:
"2024-10-02 14:06:14"
Example:
"2024-10-02 14:06:17"
{
"data": [
{
"client_reference_id": "company_45458",
"uuid": "9d264b4a-006c-4d01-acd0-730e27784c59",
"first_name": "John",
"last_name": "Dew",
"email": "[email protected]",
"phone": "2457856490",
"business": {
"name": "John Incorporation",
"tin": "922454715",
"address_type": "Registered",
"address": {
"street_address": "10554 W Quarles Ave",
"city": "Littleton",
"state": "CO",
"country": "US",
"zip": "80127"
},
"trading_name": "John Incorporation",
"entity_type": "Sole Trader",
"incorporation_date": "2024-02-02",
"incorporation_state": "CO",
"industry": "Nature of business",
"industry_classification": {
"code_type": "SIC",
"codes": [
"NAICS 42",
"NAICS 45"
],
"description": "NAICS"
},
"source_of_wealth": "2344",
"source_of_funds": "Industry",
"first_transaction_completed_at": "2024-05-02 16:14:25",
"product_type": "financial",
"registered_as_inactive": false
},
"user_status": "APPROVED",
"kyb_status": "APPROVED",
"kyb_rejected_reason": null,
"financing_credit_balance": null,
"role": "business",
"vendor_name": "Fintech",
"business_owners": [
{
"first_name": "John",
"last_name": "Dew",
"dob": "2023-04-11",
"ssn9": "123456789",
"address_line_1": "10554 W Quarles Ave",
"city": "Littleton",
"state": "CO",
"zip": "80127",
"is_beneficial_owner": true,
"is_director": false,
"is_account_owner": false,
"is_share_holder": false,
"is_significant_control_person": false,
"ownership_percentage": 25,
"email": "[email protected]",
"phone": "2457856490",
"nationality": "US",
"occupation": "Co-founder",
"first_transaction_completed_at": "2024-05-02 16:14:25",
"product_type": "financial"
}
],
"created_at": "2024-10-02 14:06:14",
"updated_at": "2024-10-02 14:06:17"
}
],
"pagination": {
"current_page": 1,
"total_pages": 5,
"total_items": 50,
"per_page": 10
}
}