One Firm, multiple people
A Firm in Confido is the business entity. That Firm can then have multiple users (Firm Admin and Firm User roles) with their own logins; additional users are managed inside the Confido Legal app. For integrations:- Sign Up Links attach the person who completes the link as an admin on the Firm you already created with
createFirm. - Connect lets an existing Confido user authorize your app and yields a Firm API token you store server-side.
firm_staff model) for staff vs owner; use one stored Firm API token per Confido Firm for server-to-server calls.
Timeline
During onboarding, thefirm.status field will go through the following values. A firm.updated webhook will be sent each time the firm.status changes.
CREATED -> The Firm was created but there haven’t been any edits to the application yet.
APP_IN_DRAFT -> The application has been updated and is currently being filled out.
APP_SUBMITTED -> The application has been submitted and is going through our review process. From this stage on, the application is locked and cannot be modified.
APP_IN_REVIEW -> The application is currently under review.
ACTIVE -> The Firm has been approved and is ready to start processing payments.
INACTIVE -> The Firm is no longer set up to process payments.
Developing in Sandbox
In our sandbox environment, the following methods can be used to set up firms depending on whether or not you are testing the onboarding flow.Skip onboarding flow
If you are utilizing thecreateFirm mutation, the mockOnboarding input parameter can be used in sandbox only to transition the Firm directly into the ACTIVE status with one default operating and one default trust bank account. This is useful when you are developing payment features and don’t want to hassle with “onboarding” the Firm.
Trigger via the Partner Portal
Through the Partner Portal, you can update the Firm status via the Firm settings page. ClickFirms on the navbar and then click on the Firm you would like to edit.
Trigger via a Firm Admin
If you have created a Firm Admin user for the Firm, you can log in as that user and update the status of the Firm through the Application or Settings page.Trigger via the GraphQL API
If you are looking to step through the statuses via the GraphQL API, we have created a series ofsandboxOnly functions for the different steps of the onboarding flow.
sandboxOnlyFillOnboardingData -> Fills the application with mock data, including one operating and one trust bank account. This will not overwrite fields of the application that have already been filled out (which can be useful to create a Firm with more than one trust account).
sandboxOnlySubmitOnboardingData -> Transitions the Firm to the APP_SUBMITTED status. Under the hood, this will first call sandboxOnlyFillOnboardingData so this function can be called when the Firm status is either CREATED or APP_IN_DRAFT.
sandboxOnlySendFirmToReview -> Transitions the Firm to the APP_IN_REVIEW status. Under the hood, this will first call sandboxOnlySubmitOnboardingData so this function can be called when the Firm status is CREATED, APP_IN_DRAFT, or APP_SUBMITTED.
sandboxOnlyActivateFirm -> Transitions the Firm to the ACTIVE status. Under the hood, this will first call sandboxOnlySubmitOnboardingData so this function can be called when the Firm status is CREATED, APP_IN_DRAFT, APP_SUBMITTED, or APP_IN_REVIEW. It will error out if the Firm is already ACTIVE or INACTIVE.