Create your capital deposit case

Use the createCapitalDepositCase mutation to create your capital deposit case.

Multi-step process

This page explains step 1 of a multi-step process. Refer to the France guide for the whole process.

Guide

1. Call the createCapitalDepositCase mutation.
   • By default, objects are added to the API Explorer in the following order:
     1. companyName
     2. companyShareholders
     3. individualShareholders
     4. totalCapitalDepositAmount
     5. onboardingCapitalDepositCompany
2. companyName: Enter the name of the future company (line 4).
3. companyShareholders: Add required information about company shareholders (starts on line 5).
   1. Add the onboardingInfo object to prefill onboarding information for individualUltimateBeneficialOwners (starts on line 8).
   2. You can also prefill information about the company (starts on line 33).
4. individualShareholders: Add required information about individual shareholders (starts on line 50).
5. totalCapitalDepositAmount: Add the combined capital deposit amount from all company and individual shareholders (line 69).
6. onboardingCapitalDepositCompany: Add the company onboarding object to start creating the future company account (starts on line 70).
   • Note that individualUltimateBeneficialOwners and company information should match the information entered in step 3.
7. Add the CreateCapitalDepositCaseSuccessPayload (starts on line 107). Consider adding several pieces of important information, such as:
   1. companyOnboarding > id.
   2. documents > type, statusInfo > status, and id.
   3. shareholders information, including onboarding > id.
8. Add rejections in case the mutation doesn't succeed (start on line 161).

Mutation

🔎 Open the mutation in API Explorer

mutation createCase {
  createCapitalDepositCase(
    input: {
      companyName: "MyBrand"
      companyShareholders: {
        capitalDepositAmount: { value: "10000", currency: "EUR" }
        name: "Company shareholder"
        onboardingInfo: {
          individualUltimateBeneficialOwners: [
            {
              type: LegalRepresentative
              birthCity: "Paris"
              birthCityPostalCode: "75000"
              birthCountryCode: "FRA"
              birthDate: "1988-02-25"
              direct: false
              firstName: "Jules"
              lastName: "Fleury"
              totalCapitalPercentage: 51
            }
            {
              type: HasCapital
              birthCity: "Paris"
              birthCityPostalCode: "75000"
              birthCountryCode: "FRA"
              birthDate: "1988-02-25"
              direct: false
              firstName: "Malika"
              lastName: "Ngoma"
              totalCapitalPercentage: 26
            }
          ]
          accountName: "MyBrand company account"
          businessActivity: Arts
          businessActivityDescription: "Description required"
          companyType: Company
          email: "bonjour@mybrand.fr"
          isRegistered: false
          language: "fr"
          monthlyPaymentVolume: Between50000And100000
          name: "Company shareholder"
          residencyAddress: {
            addressLine1: "123 avenue de Paris"
            city: "Paris"
            country: "FRA"
            postalCode: "75000"
          }
        }
      }
      individualShareholders: {
        firstName: "Henri"
        lastName: "Dupont"
        birthDate: "1988-02-25"
        nationality: "FRA"
        capitalDepositAmount: { value: "500", currency: "EUR" }
        onboardingInfo: {
          email: "henri.dupont@mybrand.fr"
          language: "fr"
          employmentStatus: Employee
          monthlyIncome: Between1500And3000
          residencyAddress: {
            addressLine1: "1 rue de la Paix"
            city: "Paris"
            country: "FRA"
            postalCode: "75000"
          }
        }
      }
      totalCapitalDepositAmount: { value: "10500", currency: "EUR" }
      onboardingCapitalDepositCompany: {
        individualUltimateBeneficialOwners: [
          {
            type: LegalRepresentative
            birthCity: "Paris"
            birthCityPostalCode: "75000"
            birthCountryCode: "FRA"
            birthDate: "1988-02-25"
            direct: false
            firstName: "Jules"
            lastName: "Fleury"
            totalCapitalPercentage: 51
          }
          {
            type: HasCapital
            birthCity: "Paris"
            birthCityPostalCode: "75000"
            birthCountryCode: "FRA"
            birthDate: "1988-02-25"
            direct: false
            firstName: "Malika"
            lastName: "Ngoma"
            totalCapitalPercentage: 26
          }
        ]
        accountName: "MyBrand company account"
        accountCountry: FRA
        businessActivity: Arts
        businessActivityDescription: "Description required"
        companyType: Company
        email: "bonjour@mybrand.fr"
        isRegistered: false
        language: "fr"
        monthlyPaymentVolume: Between10000And50000
      }
    }
  ) {
    ... on CreateCapitalDepositCaseSuccessPayload {
      capitalDepositCase {
        companyName
        id
        companyOnboarding {
          id
          createdAt
          info {
            type
          }
          statusInfo {
            status
          }
        }
        documents {
          type
          statusInfo {
            status
          }
        }
        shareholders {
          info {
            ... on IndividualShareholder {
              __typename
              firstName
              lastName
            }
            ... on CompanyShareholder {
              __typename
              name
            }
          }
          id
          onboarding {
            id
            statusInfo {
              status
            }
          }
          documents {
            type
            id
            statusInfo {
              status
            }
          }
        }
        totalCapitalDepositAmount {
          currency
          value
        }
        updatedAt
      }
    }
    ... on ForbiddenRejection {
      __typename
      message
    }
    ... on BadRequestRejection {
      __typename
      message
    }
    ... on InternalErrorRejection {
      __typename
      message
    }
    ... on ValidationRejection {
      __typename
      message
      fields {
        code
        message
        path
      }
    }
  }
}

Payload

The options selected in the mutation example produce the following success payload. Note several pieces of key information:

1. Your capital deposit case id (line 6).
2. Your company onboarding id (line 8).
3. Information about required documents (starts on line 14).
4. Information about shareholders (starts on line 31), including:
   • Onboarding id (individual: line 38, company: line 60)
   • Document id (individual: line 45, company: line 65)
5. Status of the entire capital deposit case (line 82).

Queries

This information can help you complete your capital deposit.

If needed, use the capitalDepositCase query to get information about an individual case, or the capitalDepositCases query for information about all ongoing capital deposit cases.

{
  "data": {
    "createCapitalDepositCase": {
      "capitalDepositCase": {
        "companyName": "MyBrand",
        "id": "$CAPITAL_DEPOSIT_CASE_ID",
        "companyOnboarding": {
          "id": "$COMPANY_ONBOARDING_ID",
          "createdAt": "2024-07-18T14:12:40.633Z",
          "info": {
            "type": "Company"
          }
        },
        "documents": [
          {
            "type": "ArticlesOfIncorporation"
          },
          {
            "type": "CompanyLeaseAgreement"
          },
          {
            "type": "PowerOfAttorney"
          },
          {
            "type": "CapitalShareDepositCertificate"
          },
          {
            "type": "RegisterExtract"
          }
        ],
        "shareholders": [
          {
            "info": {
              "__typename": "IndividualShareholder",
              "firstName": "Henri",
              "lastName": "Dupont"
            },
            "id": "$INDIVIDUAL_SHAREHOLDER_ID",
            "onboarding": {
              "id": "$INDIVIDUAL_SHAREHOLDER_ONBOARDING_ID"
            },
            "documents": [
              {
                "type": "ProofOfIndividualAddress",
                "id": "$INDIVIDUAL_SHAREHOLDER_DOCUMENT_ID"
              },
              {
                "type": "ProofOfIdentity",
                "id": "$INDIVIDUAL_SHAREHOLDER_DOCUMENT_ID"
              }
            ]
          },
          {
            "info": {
              "__typename": "CompanyShareholder",
              "name": "Company shareholder"
            },
            "id": "$COMPANY_SHAREHOLDER_ID",
            "onboarding": {
              "id": "$COMPANY_SHAREHOLDER_ONBOARDING_ID"
            },
            "documents": [
              {
                "type": "RegisterExtract",
                "id": "$COMPANY_SHAREHOLDER_DOCUMENT_ID"
              },
              {
                "type": "ArticlesOfIncorporation",
                "id": "$COMPANY_SHAREHOLDER_DOCUMENT_ID"
              },
              {
                "type": "CorporateIncomeTaxReturn",
                "id": "$COMPANY_SHAREHOLDER_DOCUMENT_ID"
              },
              {
                "type": "ProofOfIdentity",
                "id": "$COMPANY_SHAREHOLDER_DOCUMENT_ID"
              }
            ]
          }
        ],
        "status": "WaitingForRequirements",
        "totalCapitalDepositAmount": {
          "currency": "EUR",
          "value": "10500"
        },
        "updatedAt": "2024-07-18T14:12:40.672Z"
      }
    }
  }
}