Update a capital deposit company

Update the company name and residency address linked to a capital deposit case with the API.

Prerequisites

All of the following conditions must be met:

1. The capital deposit case status is WaitingForInitialRequirements, PendingInternalReview, WaitingForAdditionalInformation, or the deprecated WaitingForRequirements.
2. The company onboarding is finalized.

Guide

1. Call the updateCapitalDepositCaseCompany mutation.
2. Add the capital deposit case ID.
3. Add the fields you want to update: companyName and/or residencyAddress.
4. Add the success payload and any information you'd like to receive.
5. Add rejections.

Automatic synchronization

Updating these fields automatically syncs the data across both the capital deposit case and the associated account holder.

Mutation

Open in API Explorer

mutation UpdateCompany {
  updateCapitalDepositCaseCompany(
    input: {
      capitalDepositCaseId: "$CAPITAL_DEPOSIT_CASE_ID"
      companyName: "Acme"
      residencyAddress: {
        addressLine1: "10 Rue de Rivoli"
        city: "Paris"
        postalCode: "75001"
        state: "Île-de-France"
        country: "FRA"
      }
    }
  ) {
    ... on UpdateCapitalDepositCaseCompanySuccessPayload {
      __typename
      capitalDepositCase {
        id
        companyName
        companyOnboarding {
          accountHolder {
            info {
              name
            }
            residencyAddress {
              addressLine1
              city
              postalCode
              country
            }
          }
        }
      }
    }
    ... on CapitalDepositCaseCanNotBeFoundRejection {
      __typename
      message
    }
    ... on CapitalDepositCaseCompanyCannotBeUpdatedRejection {
      __typename
      message
    }
    ... on BadRequestRejection {
      __typename
      message
    }
    ... on ValidationRejection {
      __typename
      message
    }
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on InternalErrorRejection {
      __typename
      message
    }
  }
}

Payload

{
  "data": {
    "updateCapitalDepositCaseCompany": {
      "__typename": "UpdateCapitalDepositCaseCompanySuccessPayload",
      "capitalDepositCase": {
        "id": "a4c9da36-56e1-4ed8-b0a1-2c9f3d7e8b12",
        "companyName": "Acme",
        "companyOnboarding": {
          "accountHolder": {
            "info": {
              "name": "Acme"
            },
            "residencyAddress": {
              "addressLine1": "10 Rue de Rivoli",
              "city": "Paris",
              "postalCode": "75001",
              "country": "FRA"
            }
          }
        }
      }
    }
  }
}