Update a company onboarding

Update company onboardings using the API.

Updating related individuals

Fields about related individuals can't be updated incrementally. If you need to update related individual information, you must submit all of the fields again.

Prerequisites

• You must have a project access token.
• The onboarding status must be Ongoing (valid or invalid).

Guide

Update a company onboarding by changing the preferred language.

1. First, retrieve the ID for the onboarding you need to update.
2. Call the updateCompanyAccountHolderOnboarding mutation.
3. Enter the onboarding ID retrieved in step 1.
4. Add the accountAdmin.preferredLanguage field with the language code of your choosing (example: fr or es).
5. Add desired messages to the success payload, either for validation or in case of rejection.

Deprecated mutation

The previous updateCompanyOnboarding mutation is deprecated.

Deprecated mutations will be removed in December 2026.

Use updateCompanyAccountHolderOnboarding for all new integrations.

Mutation

Open in API Explorer

mutation UpdateCompanyOnboarding {
  updateCompanyAccountHolderOnboarding(
    input: {
      onboardingId: "$ONBOARDING_ID"
      accountAdmin: {
        preferredLanguage: fr
      }
    }
  ) {
    ... on UpdateCompanyAccountHolderOnboardingSuccessPayload {
      __typename
      onboarding {
        statusInfo {
          status
        }
      }
    }
    ... on OnboardingNotFoundRejection {
      __typename
    }
    ... on OnboardingAlreadyFinalizedRejection {
      __typename
    }
  }
}

Payload

{
  "data": {
    "updateCompanyAccountHolderOnboarding": {
      "__typename": "UpdateCompanyAccountHolderOnboardingSuccessPayload",
      "onboarding": {
        "statusInfo": {
          "status": "Valid"
        }
      }
    }
  }
}