Update an individual onboarding

Update individual onboardings using the API.

Prerequisites

• You must have a project access token.
• The onboarding must be ongoing, meaning its status is Valid or Invalid (not Finalized).

Guide

Update an individual onboarding by adding an account name.

1. First, retrieve the ID for the onboarding you need to update.
2. Call the updateIndividualAccountHolderOnboarding mutation.
3. Enter the onboarding ID retrieved in step 1.
4. Add the accountInfo.name field with an account name (example: Personal account).
5. Add desired messages to the success payload, either for validation or in case of rejection.

Deprecated mutation

The previous updateIndividualOnboarding mutation is deprecated.

Creating onboardings with the deprecated mutations stops on 30 September 2026; the deprecated mutations and queries are removed on 31 December 2026.

Use updateIndividualAccountHolderOnboarding for all new integrations.

Mutation

Open in API Explorer

mutation UpdateIndividualOnboarding {
  updateIndividualAccountHolderOnboarding(
    input: {
      onboardingId: "$ONBOARDING_ID"
      accountInfo: {
        name: "Personal account"
      }
    }
  ) {
    ... on UpdateIndividualAccountHolderOnboardingSuccessPayload {
      __typename
      onboarding {
        accountInfo {
          name
        }
        statusInfo {
          status
        }
      }
    }
    ... on OnboardingNotFoundRejection {
      __typename
    }
    ... on OnboardingAlreadyFinalizedRejection {
      __typename
    }
  }
}

Payload

{
  "data": {
    "updateIndividualAccountHolderOnboarding": {
      "__typename": "UpdateIndividualAccountHolderOnboardingSuccessPayload",
      "onboarding": {
        "accountInfo": {
          "name": "Personal account"
        },
        "statusInfo": {
          "status": "Valid"
        }
      }
    }
  }
}