The company object

The company object returned when searching or receiving webhook events.

Attribute	Description
_id	ID of the company.
name	Name of the company.
categories	Categories of the company. A company may fall under multiple categories.
status	The operational status of the company at any given moment of time. Possible values are `operational`, `maintenance`.
fullyAutomatedBill	DEPRECATED If `true`, then bill aggregation and payments are fully automated. Possible values are `true`, `false`.
fullyAutomatedCardSwap	If `true`, then swapping a card is fully automated. Possible values are `true`, `false`.
logo	Company logo object.
logo.url	URL of the company logo.
logo.background	If this is `true`, then the logo looks best as a background image.
logo.svg	Company logo svg object.
logo.svg.url	URL of the company svg logo.
logo.svg.color	Hex color of the company logo.
requiredPayment	DEPRECATED If a specific payment method type is required by this company, this will be defined. Possible values are `bank`, `card`.
userPresenceRequired	If the company requires that the user is present to pass through any security flows. See best practices in the Connect documentation.
schedule	DEPRECATED
additionalPaymentOptions	DEPRECATED Present when the company provides additional payment options that allow users to make payments towards their outstanding balance.
fees	DEPRECATED The surcharge object. Possible child objects are `ach`, `cards
fees.ach	DEPRECATED Present when the company applies surcharges to ACH payments.
fees.ach.percentage	DEPRECATED If the ACH surcharge is a percentage of the payment amount.
fees.ach.rate	DEPRECATED Either a dollar amount or a percentage amount.
fees.cards	DEPRECATED Present when the company applies surcharges to card payments. Possible child objects are `american express`, `discover`, `mastercard`, and `visa`, referred to below as `{cardBrand}`. See example `company` response.
fees.cards.	DEPRECATED Possible child objects are `credit` or `debit`, referred to below as `{cardType}`.
fees.cards.{cardBrand}.{cardType}.percentage`	DEPRECATED If the surcharge is a percentage of the payment amount.
fees.cards.{cardBrand}.{cardType}.rate	DEPRECATED Either a dollar amount or a percentage amount.
auth	Company auth fields.
auth.urls	Company Auth Urls (login URL is always available, but the others can by null).
auth.urls.login	Login URL.
auth.urls.signup	Signup URL.
auth.urls.forgotPassword	Forgot password URL.
auth.urls.forgotUsername	Forgot username URL.
auth.loginFields	Form fields for credentials.
auth.loginFields.placeholder	Input `placeholder` field.
auth.loginFields.formType	Input `type` field.
auth.loginFields.name	Input `name` field.
auth.loginFields.label	Label for `input`.

Sample Response

json

{
  "_id": "579b695decea110719b1874d",
  "name": "Netflix",
  "categories": ["streaming"],
  "status": "operational",
  "fullyAutomatedBill": true,
  "fullyAutomatedCardSwap": false,
  "logo": {
    "url": "https://s3.amazonaws.com/app-assets.unbill.io-primary/uploads/utility-provider-logos/7242937ba29042cce61a8e4745269fce.png",
    "background": false,
    "svg": {
      "url": "https://s3.amazonaws.com/app-assets.unbill.io-primary/uploads/utility-provider-logos/7242937ba29042cce61a8e4745269fce.svg",
      "color": "FF041F"
    }
  },
  "requiredPayment": "bank",
  "schedule": "on-due-date",
  "additionalPaymentOptions": [{
    "type": "custom-payment-amount",
    "settings": {
      "canExceedBalance": false
    }
  }],
  "auth": {
    "urls": {
      "login": "https://www.netflix.com/Login",
      "signup": "https://www.netflix.com"
    },
    "loginFields": [{
      "placeholder": "Username",
      "formType": "text",
      "name": "username",
      "label": "Username"
    }, {
      "placeholder": "Password",
      "formType": "password",
      "name": "password",
      "label": "Password"
    }]
  },
  "geo": {
    "lat": 30.70,
    "lng": -95.53,
    "state_short": "TX",
    "state_long": "Texas",
    "zipcode": "77340"
  },
  "fees": {
      "ach": {
          "rate": 1.5,
          "percentage": false
      },
      "cards": {
          "american express": {
              "credit": {
                  "rate": 1.5,
                  "percentage": false
              }
          },
          "discover": {
              "credit": {
                  "rate": 1.5,
                  "percentage": false
              },
              "debit": {
                  "rate": 1.5,
                  "percentage": false
              }
          },
          "mastercard": {
              "credit": {
                  "rate": 1.5,
                  "percentage": false
              },
              "debit": {
                  "rate": 1.5,
                  "percentage": false
              }
          },
          "visa": {
              "credit": {
                  "rate": 1.5,
                  "percentage": false
              },
              "debit": {
                  "rate": 1.5,
                  "percentage": false
              }
          },
          "amex": {
              "debit": {
                  "rate": 1.5,
                  "percentage": false
              }
          }
      }
  }
}

The company object ​

The company object