You will need the unique id for the Account.

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. The response includes requires_bank_account_file_ids_on_submit: when true, your submit request must include file_ids with uploaded bank-validation documents.

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. You may include external_account_id to set or update your partner identifier for the account. When updating user_fields, the value must conform to the Partner's user_fields_schema if validation is enabled.

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.

Submit a draft boarding application to move it to underwriting. The application must be in DRAFT status.

Access: Submit via API is an entitlement and is not available to every integration. Contact support if you want to learn more about eligibility or enabling this capability.

You can change most details about the application during the submit. Include the full application payload with any updates. Most fields from the draft can be modified in this request. Note: processing_plan_data cannot be changed on submit; the value from the draft is always used.

Make sure to select the signer. Exactly one owner in the owners array must have signer set to true. This is the person who will sign the agreement and become the primary business user.

Required fields for submit:

• terms_accepted — must be true.
• attest_verified — must be true (your attestation that the data is accurate).
• terms_version — must match GET /applications/{id}/terms.
• file_ids — required when GET /applications/{id} returns requires_bank_account_file_ids_on_submit true; use file IDs from this application's uploads.

Optional bank_account (US only): You may include US bank details for the business (routing_number, account_number, account_name, account_sub_type checking or savings). Not available when country is CA.

Typical workflow:

1. GET /applications/{id}/terms for terms_version; GET /applications/{id} for requires_bank_account_file_ids_on_submit and other fields.
2. Set terms_accepted and attest_verified to true; set terms_version.
3. If required, upload documents (initiate/complete file upload) and pass file_ids on submit.
4. Set one owner's signer to true.
5. Submit the full application payload.

See create_application for ownership types, owner titles, and country-specific validations.

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. Each item includes requires_bank_account_file_ids_on_submit when you need to attach file_ids on submit.

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. For payments terminology, US uses ACH and Canada uses EFT.

External Account ID: Optional external_account_id lets you store your own identifier for the account (e.g. partner system account ID). It is persisted with the application and copied to the Account when the application is approved; partners can also update it later via the Account API.

User Fields and Schema: Optional user_fields stores partner-defined key-value data. When the Partner has validate_user_fields_schema enabled, user_fields must conform to the Partner's user_fields_schema (JSON schema).

Company Ownership Types and Owner Titles (US): The following mapping shows valid owner titles for each company ownership type. Note: Owner title is optional where indicated (most clients pass null). 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

• Owner title is optional: pass null or omit (no titles required)

PUBLIC

• Owner title is optional: pass null or omit (no titles required)

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

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.

Upload bank-validation documents when requires_bank_account_file_ids_on_submit is true on the application (for example, voided check or bank statement).

Flow

1. Initiate (this call): Send filename, mimetype (application/pdf or image/png), size, purpose (underwriting_document), and optional document_type enum. You receive upload_id, key, and parts[].presigned_url.
2. Upload: For each part, PUT raw bytes to its presigned_url (no JSON body, no Authorization header). Store each response ETag (keep quoting as returned).
3. Complete: POST .../files/complete_upload with the same file metadata plus upload_id, key, and parts listing part_number and etag.

Presigned URLs expire quickly (often within minutes). Then reference returned file IDs in file_ids on submit.

Finishes the upload after parts are written to storage. Call only after initiate_upload and successful PUTs to each presigned_url.

Body: Same filename, mimetype, purpose, and optional document_type as initiate; size must match actual bytes uploaded; include upload_id, key, and all parts with etag from the storage responses.

Response: File metadata and message file_success. Use the file id in file_ids on submit when required.

Returns the point-in-time terms snapshot for this application: terms_version, canonical_payload_json, and display strings parsed from that JSON. The snapshot is the effective terms (tenant terms with partner overrides when configured).

The snapshot is created when the application is created (POST /v1/applications). If none exists, this returns not found (you may not be enabled for API submit).

Submit: Send terms_version from this response on PUT /applications/{id}/submit together with terms_accepted true. Present the terms to the merchant using the display fields and/or canonical_payload_json as needed for your UI.

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.

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.