Business
List Businesses
List businesses for your platform. Archived businesses are not returned. This endpoint supports pagination.
get/entities/business
Request
- Base URLhttps://api.justifi.ai/v1
- Authnone declared. Required headers: Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
business_namestring
filter businesses by legal name. Matches any business whose legal name contains this value, ignoring case
industrystring
filter businesses by industry. Matches any business whose industry contains this value, ignoring case
created_beforestring date-time
filter records which were created before the date and time (UTC) specified. Dates without time specified will default to 00:00:00
created_afterstring date-time
filter records which were created after the date and time (UTC) specified. Dates without time specified will default to 00:00:00
Headers
Authorizationstring required
the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)
Response
Successfully list businesses
Example response
{
"id": 1,
"type": "array",
"data": [
{
"id": "biz_xyz",
"platform_account_id": "acc_xyz",
"mode": "test",
"legal_name": "Business Name",
"website_url": "https://justifi.ai",
"email": "business@justifi.ai",
"phone": "6124011111",
"doing_business_as": "Best Business",
"industry": "Big Business",
"mcc": "8021",
"date_of_incorporation": "2015-02-20",
"country_of_establishment": "USA",
"associated_accounts": [
{
"id": "acc_123xyz"
}
],
"provisioned": [
"payments",
"underwriting"
],
"legal_address": {
"id": "addr_123xyz",
"platform_account_id": "acc_123xyz",
"line1": "123 Example St",
"line2": "Suite 101",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55555",
"country": "USA",
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
},
"representative": {
"id": "idty_xyz",
"platform_account_id": "acc_xyz",
"business_id": "biz_xyz",
"name": "Person Name",
"title": "President",
"email": "person.name@justifi.ai",
"phone": "6124011111",
"dob_day": "01",
"dob_month": "01",
"dob_year": "1980",
"ssn_last4": "6789",
"is_owner": true,
"ownership_percentage": 25,
"address": {
"id": "addr_123xyz",
"platform_account_id": "acc_123xyz",
"line1": "123 Example St",
"line2": "Suite 101",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55555",
"country": "USA",
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
},
"documents": [
{
"id": "doc_abc123",
"platform_account_id": "acc_123xyz",
"description": "My Document",
"file_name": "my_document",
"file_type": "pdf",
"document_type": "balance_sheet",
"business_id": "biz_abc123",
"identity_id": "idty_abc123",
"presigned_url": "https://test.test/doc_abc123/file_name.pdf",
"metadata": {
"language": "english",
"social_network": "@person"
},
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
}
],
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
},
"owners": [
{
"id": "idty_xyz",
"platform_account_id": "acc_xyz",
"business_id": "biz_xyz",
"name": "Person Name",
"title": "President",
"email": "person.name@justifi.ai",
"phone": "6124011111",
"dob_day": "01",
"dob_month": "01",
"dob_year": "1980",
"ssn_last4": "6789",
"is_owner": true,
"ownership_percentage": 25,
"address": {
"id": "addr_123xyz",
"platform_account_id": "acc_123xyz",
"line1": "123 Example St",
"line2": "Suite 101",
"city": "Minneapolis",
"state": "MN",
"postal_code": "55555",
"country": "USA",
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
},
"documents": [
{
"id": "doc_abc123",
"platform_account_id": "acc_123xyz",
"description": "My Document",
"file_name": "my_document",
"file_type": "pdf",
"document_type": "balance_sheet",
"business_id": "biz_abc123",
"identity_id": "idty_abc123",
"presigned_url": "https://test.test/doc_abc123/file_name.pdf",
"metadata": {
"language": "english",
"social_network": "@person"
},
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
}
],
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
}
],
"documents": [
{
"id": "doc_abc123",
"platform_account_id": "acc_123xyz",
"description": "My Document",
"file_name": "my_document",
"file_type": "pdf",
"document_type": "balance_sheet",
"business_id": "biz_abc123",
"identity_id": "idty_abc123",
"presigned_url": "https://test.test/doc_abc123/file_name.pdf",
"metadata": {
"language": "english",
"social_network": "@person"
},
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
}
],
"bank_accounts": [
{
"id": "ba_123xyz",
"account_owner_name": "Napheesa Collier",
"account_type": "checking",
"account_number_last4": "6789",
"routing_number": "110000000",
"bank_name": "Wells Fargo",
"country": "USA",
"nickname": "Phee's money",
"metadata": {},
"business_id": "biz_123abc",
"platform_account_id": "acc_123abc",
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
}
],
"additional_questions": {
"business_revenue": "84220",
"business_payment_volume": "1000000",
"business_average_transaction_amount": "150",
"business_when_service_received": "Within 7 days",
"business_recurring_payments": "true",
"business_recurring_payments_percentage": "50% monthly, 50% annual",
"business_seasonal": "No. The business revenue is generated evenly throughout the year",
"business_other_payment_details": "50% of revenue is taken 90 days in advance of service and 50% of revenue is taken 30 days in advance of service",
"business_purchase_order_volume": "150",
"business_invoice_volume": "500",
"business_fund_use_intent": "expanding marketing efforts",
"equipment_invoice": "$10,000 invoice for computer equipment",
"business_invoice_number": "202105-001",
"business_invoice_amount": "$4500",
"business_purchase_order_number": "120",
"industry_code": "541512",
"duns_number": "123456789",
"business_payment_decline_volume": "500",
"business_refund_volume": "100",
"business_dispute_volume": "50",
"business_receivable_volume": "US $100,000",
"business_future_scheduled_payment_volume": "200",
"business_dispute_win_rate": "75%",
"length_of_business_relationship": "5 years"
},
"product_categories": {
"payment": true
},
"created_at": "2021-01-01T12:00:00Z",
"updated_at": "2021-01-01T12:00:00Z"
}
],
"page_info": {
"end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
"start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.