JUjustifi
Business

Update a Business

Update information about a Business

This API does not validate that any specific properties are present, so a business can be updated with partial information and completed over multiple requests. However, when a business is provisioned for payments via the Provisioning API, specific properties are required. These properties are marked as "Required when provisioning payments" in their descriptions below.

patch/entities/business/{id}

Request

Path parameters

idstring uuid required

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Request body

archivedboolean

set to true to archive this business. Test mode businesses can always be archived. A live mode business can only be archived while it has not been provisioned; once a product has been provisioned for it, or a sub account is associated with it, archiving returns an error. Archiving frees the business's legal_name for reuse, so setting this back to false returns an error if another active business on your platform has taken that name in the meantime

legal_namestring

legal business entity name. Required when provisioning payments

website_urlstring

website for this business (if they don't have a website, can send their social media business page, app store link, or a product description instead). Required when provisioning payments

emailstring

email address of business entity or representative. Required when provisioning payments

phonestring

business phone number. Required when provisioning payments

doing_business_asstring

only needed if registered with DBA/Trade Name on SS-4 tax document

business_type'for_profit' | 'non_profit' | 'government_entity' | 'individual'

(deprecated) use classification instead - see classification mapping table

business_structure'sole_proprietorship' | 'single_llc' | 'multi_llc' | 'private_partnership' | 'private_corporation' | 'unincorporated_association' | 'public_partnership' | 'public_corporation' | 'incorporated' | 'unincorporated' | 'government_unit' | 'government_instrumentality' | 'tax_exempt_government_instrumentality'

(deprecated) use classification instead - see classification mapping table

classification'government' | 'limited' | 'non_profit' | 'partnership' | 'corporation' | 'public_company' | 'sole_proprietor'

simplified classification, use instead of business_type and business_structure - see classification mapping table. Required when provisioning payments

industrystring

to help us identify this business entity's category code (MCC), please provide a concise description of what service they offer. Required when provisioning payments

mccstring

merchant category code for this business, if known. Please note, the JustiFi underwriting team may modify this. If you are unsure, just submit a description in the industry field instead of an MCC

tax_idstring

the federal tax identification number/EIN issued to this sub account by the IRS (for Individual type, this will be their full SSN), the value is saved but not returned in any API response. Required when provisioning payments (US businesses only)

date_of_incorporationstring

the specific day when this business was officially registered with a relevant government authority and was then permitted to carry out its activities. Required when provisioning payments

metadataobject

any useful information you'd like to store alongside this business

Example request

{
  "archived": true,
  "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",
  "metadata": {
    "arr": 1200,
    "social_network": "@business"
  },
  "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"
  },
  "legal_address": {
    "line1": "123 Example St",
    "line2": "Suite 101",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55555",
    "country": "USA"
  },
  "representative": {
    "name": "Person Name",
    "title": "President",
    "email": "person.name@justifi.ai",
    "phone": "6124011111",
    "dob_day": "01",
    "dob_month": "01",
    "dob_year": "1980",
    "identification_number": "123456789",
    "ownership_percentage": 25,
    "metadata": {
      "language": "english",
      "social_network": "@person"
    },
    "address": {
      "line1": "123 Example St",
      "line2": "Suite 101",
      "city": "Minneapolis",
      "state": "MN",
      "postal_code": "55555",
      "country": "USA"
    }
  },
  "owners": [
    {
      "name": "Person Name",
      "title": "President",
      "email": "person.name@justifi.ai",
      "phone": "6124011111",
      "dob_day": "01",
      "dob_month": "01",
      "dob_year": "1980",
      "identification_number": "123456789",
      "ownership_percentage": 25,
      "metadata": {
        "language": "english",
        "social_network": "@person"
      },
      "address": {
        "line1": "123 Example St",
        "line2": "Suite 101",
        "city": "Minneapolis",
        "state": "MN",
        "postal_code": "55555",
        "country": "USA"
      }
    }
  ]
}

Response

Successfully update a business

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "business",
  "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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.