Update a company onboarding

Update company onboardings using the API.

Updating UBO fields

Fields about an ultimate beneficial owner (UBO) can't be updated incrementally. If you need to update UBO 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

To test updating a company onboarding, change the language.

1. First, retrieve the ID for the onboarding you need to update.
2. Call the updateCompanyOnboarding mutation.
3. Enter the onboarding ID retrieved in step 1.
4. Check the box for language, then enter 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.
   • Recommendation: Inside the UpdateCompanyOnboardingSuccessPayload option, add onboardingState and statusInfo > status to confirm the onboarding is still ongoing and valid after making the update.

Mutation

Open in API Explorer

mutation UpdateCompanyOnboarding {
  updateCompanyOnboarding(
    input: {
      onboardingId: "$ONBOARDING_ID"
      language: "fr"
    }
  ) {
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on InternalErrorRejection {
      __typename
      message
    }
    ... on UpdateCompanyOnboardingSuccessPayload {
      __typename
      onboarding {
        language
        onboardingState
        statusInfo {
          status
        }
      }
    }
    ... on ValidationRejection {
      __typename
      message
      fields {
        message
      }
    }
  }
}

Payload

{
  "data": {
    "updateCompanyOnboarding": {
      "__typename": "UpdateCompanyOnboardingSuccessPayload",
      "onboarding": {
        "language": "fr",
        "onboardingState": "Ongoing",
        "statusInfo": {
          "status": "Valid"
      }
    }
  }
}