Pinwheel · Schema

CompanyConnect

This class defines the fields present in the `company_connect` object in the link token. For non-Company Connect link tokens, this field is optional. If the object is present, it indicates that the link token is a Company Connect link token. Attributes: company_connection_id (UUID): This field specifies the ID of the company connection. This ID is generated by Pinwheel. All Company Connect webhooks reference the connection by this ID, and all public CC API endpoints require this ID as well.

PayrollDirect DepositIncome VerificationEmploymentTax FormsFintechOpen FinanceBill SwitchingFinancial Data

Properties

Name	Type	Description
company_connection_id	string	ID of the Company Connection.

View JSON Schema on GitHub

JSON Schema

{
  "properties": {
    "company_connection_id": {
      "type": "string",
      "format": "uuid",
      "title": "company_connection_id",
      "description": "ID of the Company Connection."
    }
  },
  "type": "object",
  "title": "CompanyConnect",
  "description": "This class defines the fields present in the `company_connect` object in\nthe link token.\n\nFor non-Company Connect link tokens, this field is optional. If the object\nis present, it indicates that the link token is a Company Connect link\ntoken.\n\nAttributes:\n    company_connection_id (UUID): This field specifies the ID of the\n        company connection. This ID is generated by Pinwheel. All Company\n        Connect webhooks reference the connection by this ID, and all\n        public CC API endpoints require this ID as well.",
  "x-tags": [
    "Schemas"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.pinwheelapi.com/CompanyConnect.json"
}