Providers

import Finch from '@tryfinch/finch-api';

const client = new Finch();

async function main() {
  // Automatically fetches more pages as needed.
  for await (const provider of client.providers.list()) {
    console.log(provider.id);
  }
}

main();

[
  {
    "id": "<string>",
    "display_name": "<string>",
    "products": [
      "<string>"
    ],
    "icon": "<string>",
    "logo": "<string>",
    "mfa_required": true,
    "primary_color": "<string>",
    "manual": true,
    "beta": true,
    "authentication_methods": [
      {
        "type": "assisted",
        "benefits_support": {
          "s125_medical": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          },
          "s125_dental": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          },
          "s125_vision": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          },
          "hsa_pre": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          },
          "hsa_post": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          },
          "fsa_medical": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          },
          "fsa_dependent_care": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          },
          "simple_ira": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          },
          "simple": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          },
          "commuter": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          },
          "custom_post_tax": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          },
          "custom_pre_tax": {
            "supported_features": {
              "description": "<string>",
              "frequencies": [
                "one_time"
              ],
              "employee_deduction": [
                "fixed"
              ],
              "company_contribution": [
                "fixed"
              ],
              "annual_maximum": true,
              "catch_up": true,
              "hsa_contribution_limit": [
                "individual"
              ]
            },
            "supported_operations": {
              "company_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              },
              "individual_benefits": {
                "create": "supported",
                "update": "supported",
                "delete": "supported",
                "read": "supported"
              }
            }
          }
        },
        "supported_fields": {
          "company": {
            "id": true,
            "legal_name": true,
            "entity": {
              "type": true,
              "subtype": true
            },
            "primary_email": true,
            "primary_phone_number": true,
            "ein": true,
            "accounts": {
              "routing_number": true,
              "account_name": true,
              "institution_name": true,
              "account_type": true,
              "account_number": true
            },
            "departments": {
              "name": true,
              "parent": {
                "name": true
              }
            },
            "locations": {
              "line1": true,
              "line2": true,
              "city": true,
              "state": true,
              "postal_code": true,
              "country": true
            }
          },
          "directory": {
            "paging": {
              "count": true,
              "offset": true
            },
            "individuals": {
              "id": true,
              "first_name": true,
              "middle_name": true,
              "last_name": true,
              "is_active": true,
              "department": true,
              "manager": {
                "id": true
              }
            }
          },
          "individual": {
            "id": true,
            "first_name": true,
            "middle_name": true,
            "last_name": true,
            "preferred_name": true,
            "dob": true,
            "gender": true,
            "ethnicity": true,
            "ssn": true,
            "encrypted_ssn": true,
            "emails": {
              "data": true,
              "type": true
            },
            "phone_numbers": {
              "data": true,
              "type": true
            },
            "residence": {
              "city": true,
              "country": true,
              "line1": true,
              "line2": true,
              "postal_code": true,
              "state": true
            }
          },
          "employment": {
            "id": true,
            "first_name": true,
            "middle_name": true,
            "last_name": true,
            "title": true,
            "start_date": true,
            "end_date": true,
            "is_active": true,
            "employment_status": true,
            "income_history": true,
            "class_code": true,
            "custom_fields": true,
            "department": {
              "name": true
            },
            "employment": {
              "type": true,
              "subtype": true
            },
            "income": {
              "amount": true,
              "currency": true,
              "unit": true
            },
            "location": {
              "line1": true,
              "line2": true,
              "city": true,
              "state": true,
              "postal_code": true,
              "country": true
            },
            "manager": {
              "id": true
            }
          },
          "payment": {
            "id": true,
            "pay_date": true,
            "debit_date": true,
            "company_debit": true,
            "gross_pay": true,
            "net_pay": true,
            "employer_taxes": true,
            "employee_taxes": true,
            "individual_ids": true,
            "pay_period": {
              "start_date": true,
              "end_date": true
            },
            "pay_group_ids": true,
            "pay_frequencies": true
          },
          "pay_statement": {
            "paging": {
              "count": true,
              "offset": true
            },
            "pay_statements": {
              "individual_id": true,
              "type": true,
              "payment_method": true,
              "total_hours": true,
              "gross_pay": true,
              "net_pay": true,
              "earnings": {
                "type": true,
                "name": true,
                "amount": true,
                "currency": true
              },
              "employee_deductions": {
                "name": true,
                "amount": true,
                "type": true,
                "pre_tax": true,
                "currency": true
              },
              "employer_contributions": {
                "name": true,
                "amount": true,
                "currency": true
              },
              "taxes": {
                "type": true,
                "name": true,
                "employer": true,
                "amount": true,
                "currency": true
              }
            }
          },
          "pay_group": {
            "id": true,
            "name": true,
            "pay_frequencies": true,
            "individual_ids": true
          }
        }
      }
    ]
  }
]