Skip to Content

Providers

Providers are the services your users can link their accounts from.

Resource model

Each provider is structured as an integration containing one or more resources, each with one or more operations (actions):

Integration (e.g., tmobile) └── Resource (e.g., paymentMethod) ├── read — List saved payment methods └── write — Add a new payment method

When creating a link, you specify the full path: integrationId + resource + action.

Supported integrations

IntegrationResourcesActions
tmobilepaymentMethod, mobileBillingStatementread, write
attpaymentMethod, mobileBillingStatementread, write
verizonpaymentMethod, mobileBillingStatementread, write
ubereatsorderHistoryread

Fetch the full catalog with argument and result schemas via GET /v1/providers.

Argument validation

Some operations accept arguments (e.g., card details for paymentMethod:write). Arguments are validated against a Zod schema at link creation time. Use the GET /v1/providers discovery endpoint to inspect the JSON Schema for each operation.

Result validation

Each operation defines a canonical result schema. After an automation completes, the result data is validated against its schema before persisting. If validation fails, the link is marked as failed with a RESULT_VALIDATION_ERROR code. The canonical schemas ensure consistent result shapes across providers — for example, all carriers return billing data in the same { billing: BillingStatement[] } format regardless of their native API responses.

Provider automations

Each operation maps to an automation function that:

  1. Navigates to the provider’s login page
  2. Sends commands to fill in form fields
  3. Yields to the user for authentication (password, 2FA)
  4. Waits for post-login conditions
  5. Extracts or writes the account data

Next steps

Last updated on