You will need the unique id for the Account.

Partial updates to Account are allowed as needed. This will fully replace user_fields if provided.

You can fetch all the Accounts that are associated with you. Additionally there is further filtering available for Account Name or Business Id

Retrieve complete details about a specific boarding application by its unique identifier. This endpoint returns all application information including status, business details, company information, and configuration. Use this to review application details at any stage of the onboarding process, from draft to approved status.

Update an existing draft boarding application to modify or complete application details. Important: This endpoint can only be used to update applications that are in DRAFT status. Once an application has been submitted and moved to other statuses (such as UNDER_REVIEW, APPROVED, etc.), it cannot be updated through this route. Use this to save your progress, correct information, or add missing details before submitting the application.

Permanently delete a boarding application that is in DRAFT or CANCELLED status. Important: This operation can only be performed on applications in DRAFT or CANCELLED states. Applications in other statuses (such as UNDER_REVIEW, APPROVED, DECLINED, etc.) cannot be deleted. Once an application is deleted, it will be permanently removed and will no longer appear in application lists or be accessible through the API. Use this to clean up draft applications that are no longer needed or to remove cancelled applications from your records.

Retrieve a paginated list of all boarding applications associated with your account. Use the request parameters to filter results by status, business ID, or creation timestamps. This endpoint is useful for monitoring all your applications across different stages of the onboarding process, from draft applications to those under review, approved, or declined.

Create a new draft boarding application to initiate the onboarding process on Forward. This endpoint creates an application in DRAFT status, which allows you to save your progress and complete the application over time. Note: Most fields in the request are optional - you can create a minimal draft and add details later, or provide complete information upfront.

Important: Once the application is submitted (via application link), it will be processed and go through our approval workflow. Note: Webhooks are available to receive real-time notifications about application status changes, eliminating the need for polling.

Country: The country field (or address.country) determines US vs Canadian (CA) application behavior. Set country to US or CA accordingly; ownership types and validations depend on the selected country.

Company Ownership Types and Owner Titles (US): The following mapping shows valid owner titles for each company ownership type. Note: These are optional during the 'Create Application' step and can be provided later.

LIMITED LIABILITY COMPANY

• PRESIDENT
• VICE_PRESIDENT
• TREASURER
• CEO
• CFO
• COO
• SECRETARY
• MEMBER

PRIVATE

• PRESIDENT
• VICE_PRESIDENT
• SECRETARY
• TREASURER
• CEO
• CFO
• COO

TAX EXEMPT ORGANIZATION

• ADMINISTRATOR

SOLO TRADER

• OWNER

PARTNERSHIP

• PARTNER

GOVERNMENT

• ADMINISTRATOR

PUBLIC

• ADMINISTRATOR

Canadian (CA) Business Types and Owner Titles: For applications with country = CA, use one of the following ownership types and the corresponding owner titles.

SOLE_PROPRIETORSHIP

• OWNER

GENERAL_PARTNERSHIP

• PARTNER

LIMITED_PARTNERSHIP

• PARTNER

PRIVATE_CORPORATION_FEDERALLY_OR_PROVINCIALLY_INCORPORATED

• PRESIDENT
• VICE_PRESIDENT
• SECRETARY
• TREASURER
• CEO
• CFO
• COO

PUBLIC_CORPORATION_SHARES_TRADED_ON_EXCHANGE

• PRESIDENT
• VICE_PRESIDENT
• SECRETARY
• TREASURER
• CEO
• CFO
• COO

COOPERATIVE_FOR_PROFIT

• PRESIDENT
• VICE_PRESIDENT
• SECRETARY
• TREASURER
• CEO
• CFO
• COO

COOPERATIVE_NOT_FOR_PROFIT

• OWNER
• PARTNER
• PRESIDENT
• VICE_PRESIDENT
• SECRETARY
• TREASURER
• CEO
• CFO
• COO
• MEMBER

NOT_FOR_PROFIT_ORGANIZATION_NON_CHARITY

• OWNER
• PARTNER
• PRESIDENT
• VICE_PRESIDENT
• SECRETARY
• TREASURER
• CEO
• CFO
• COO
• MEMBER

REGISTERED_CHARITY

• OWNER
• PARTNER
• PRESIDENT
• VICE_PRESIDENT
• SECRETARY
• TREASURER
• CEO
• CFO
• COO
• MEMBER

GOVERNMENT_ENTITY_FEDERAL_PROVINCIAL_MUNICIPAL_CROWN_CORPORATION

• No owner titles required (government entity)

UNLIMITED_LIABILITY_CORPORATION_ULC

• PRESIDENT
• VICE_PRESIDENT
• SECRETARY
• TREASURER
• CEO
• CFO
• COO

EXTRA_PROVINCIAL_CORPORATION_FOREIGN_CORPORATION_REGISTERED_IN_CANADA

• PRESIDENT
• VICE_PRESIDENT
• SECRETARY
• TREASURER
• CEO
• CFO
• COO

FOREIGN_PARTNERSHIP_REGISTERED_IN_CANADA

• PARTNER

COMMUNITY_CONTRIBUTION_COMPANY_FOR_PROFIT

• PRESIDENT
• VICE_PRESIDENT
• SECRETARY
• TREASURER
• CEO
• CFO
• COO

COMMUNITY_CONTRIBUTION_COMPANY_NOT_FOR_PROFIT

• OWNER
• PARTNER
• PRESIDENT
• VICE_PRESIDENT
• SECRETARY
• TREASURER
• CEO
• CFO
• COO
• MEMBER

Generate a shareable link for a boarding application that allows applicants to complete or submit the application through a hosted form. If you have configured your own Hosted Application domain, the link will be generated using your domain. Otherwise, the link will be hosted on Forward's platform. Prerequisites: A Processing Plan must be selected for the application before you can generate a link. Important: Application links can expire. Once a link expires, you will need to generate a new link to continue the application process. Use this endpoint when you want to share the application with applicants or allow them to complete the application form.

Here you can fetch all the Bank Accounts that have been linked to Businesses that are linked to you.

Here you can fetch a Bank Account and retrieve the status of a given bank account.

You can find all Businesses or specifically filter by Name or Contact information.

You can create a new Business that will be linked to your Account. We encourage you to complete all the fields while creating a new Business. Once you have created a Business you can start creating Applications and get associated Accounts.

Each Business has a unique id and must be associated with your Account. You can only search a Business you have access to.

Use this endpoint to create a new contractor application link. A contractor can select to be an individual or company. A company contractor will require some information link Owners information. ⚠️ DEPRECATED: Use payees/link instead.

Deactivate an existing Contractor. ⚠️ DEPRECATED: Use payees/{id}/deactivate instead.

Note: The contractor has to have gone through the identity process before you can activate/deactivate a Contractor. ⚠️ DEPRECATED: Use payees/{id}/activate instead.

Please provide the x-business-id so that all the Contractors can be retrieved for a given Business. If you don't provide this header you will get back all the Contractors that belong to you and none of our business specific Contractors. ⚠️ DEPRECATED: Use payees instead.

Retrieve the details about a given Contractor. ⚠️ DEPRECATED: Use payees/{id} instead.

Here you can check the status of contractor application, if the contractor is created for an application you can also monitor is status with this endpoint. ⚠️ DEPRECATED: Use payees/application/{id} instead.

You can review an existing Location that's assigned to a specific Business. Note: You can only review Business that you have access to.

Business Locations are always editable, please keep this information updated as your information changes.

If a Location needs to be deleted, you can use this endpoint to delete a Location at Forward.

You can find all Locations that you have access to. Further filter on Business Location name and Business Id can be applied on the list of Locations.

This endpoint can be used to create a new Business Location only two fields are needed Business Id and Location Name.

Use this endpoint to list all of the MCCs that have been assigned to you. Please verify this information as it plays a key role in our payment processing flows, as well as the Application creation process.

Use this endpoint to create a new payee application link. Note: All top-level fields in the request are optional. You can send an empty request body to generate a link without pre-populating any data. If you choose to provide application data, you can specify either an individual or company payee. Important: If you include application data, all required fields within that data must be properly completed. Individual Payee: If you provide individual payee information, all required fields (first name, last name, email, phone number, address, etc.) must be included and valid. Company Payee: If you provide company payee information, required fields like company name, legal name, email, website, and owner information must be properly completed.

Deactivate a payee to temporarily disable it from being used in split payment transactions. A deactivated payee cannot receive payments as part of transaction splits, but the payee record is preserved and can be reactivated later. Use this when you need to temporarily stop payments to a payee without deleting their information, such as when a payee is on hold or under review.

Activate a payee to make it available for use in split payment transactions. An activated payee can receive payments as part of a transaction split. Note: The payee must have completed the identity verification process before it can be activated. Once activated, the payee will be in an active state and can be used in payment operations.

Retrieve a paginated list of all payees associated with your Partner account. Use the request parameters to filter and paginate results. This endpoint is useful for viewing all available payees that can be used in split payment transactions.

Retrieve complete details about a specific payee by its unique identifier. This endpoint returns all payee information including status, contact details, and configuration. Use this to view payee details before including them in split payment transactions.

Retrieve a paginated list of all payee applications associated with your Partner account. Use the request parameters to filter and paginate results. This endpoint allows you to monitor all payee applications in various stages of the onboarding process, from pending to approved.

Retrieve the current status of a payee application. If a payee entity has been created from the application, you can also check the payee's status using this endpoint. Note: Webhooks are available to receive real-time notifications about payee application and payee status changes, eliminating the need for polling. This endpoint is useful for one-time status checks or when webhooks are not configured.

Here you can find all the Processing Plans, if you specify Name you can filter on specific Name as well.The Processing Plan data will be returned to you in a list.

Here you can review Processing Plan that has been created and verify the information is accurate. If there are any discrepancies in the Fees data please reach out as these play a key role processing payouts.

Get user details

You can keep information regarding your user updated here.

You can activate or deactivate your user.

Here you can create a user for a specific Business. Provide all the necessary details about the user. We will send an automated email out informing your user to setup a password and login. You can also generated a one time login link for this user.

You can retrieve a magic link for a specific Business user that you have access to.