Account Management

This guide covers the most common account-related workflows: creating an account (as part of user creation), retrieving account data, and managing portal access.

Before you start

Read the Account concept guide to understand Account types, KYC statuses, and the Account/User relationship.

Creating an Account

When creating a User, you must provide firstAccountInformation which specifies the type of account to create.

For individual investors:

mutation CreateIndividualInvestor {
  CreateUser(
    firstName: "Alice"
    lastName: "Dupont"
    email: "alice.dupont@example.com"
    mobile: "+33612345678"
    persona: customer
    firstAccountInformation: {
      firstAccountType: individualAccount
    }
    active: false
    withEmail: false
  ) {
      id
      active
      email
      firstName
      lastName
      locale
      # ...Other User fields
  }
}

→ Type reference: User

For a corporate account, provide corporate details:

mutation CreateCorporateInvestor {
  CreateUser(
    firstName: "Jean"
    lastName: "Martin"
    email: "jean.martin@company.fr"
    mobile: "+33698765432"
    persona: customer
    firstAccountInformation: {
      firstAccountType: corporateAccount
      corporateAccountInformation: {
        corporateName: "Martin Investissements SAS"
        representative: {
          representativePersonal: {
            representativeFirstName: "Jean"
            representativeLastName: "Martin"
          }
        }
      }
    }
  ) {
      id
      active
      email
      firstName
      lastName
      locale
      # ...Other User fields
  }
}

→ Type reference: User

info

active: false keeps the user in a pending state (requires admin review before they can log in). Set active: true to auto-approve.

Retrieving an Account

By ID

Fetch a specific account with its KYC status and basic investor information:

query GetInvestorAccount {
  GetAccount(id: "123") {
    id
    label
    accountType { 
      code
      label
    }
    kycStatusDetailed { 
      code
      label
    }
    kycExpirationDate
    investorInfo {
      lcbftLevelDetailed { 
        code
        label
      }
    }
    user {
      id
      email
      firstName
      lastName
    }
    bankAccounts {
      id
      iban
      bic
    }
    # ...Other Account fields
  }
}

→ Type reference: Account

Listing Accounts with Filters

Use GetAccounts to paginate and filter:

query ListValidatedAccounts {
  GetAccounts(
    filters: { kycStatus: validated }
    accountPersonas: [Investor]
    search: "Dupont"
    sortingColumns: [{ column: "createdAt", direction: DESC }]
    resultsPerPage: 20
    page: 1
  ) {
    edges {
      node {
        id
        label
        kycStatusDetailed { value }
        createdAt
        user {
          email
        }
        # ...Other Account fields
      }
    }
    totalCount
  }
}

→ Type reference: Account

Listing Accounts Pending KYC Review

To get a queue of accounts waiting for compliance review (requires ROLE_ADMIN):

query PendingKycQueue {
  GetKycsToReview(
    search: ""
    resultsPerPage: 50
    page: 1
  ) {
    edges {
      node {
        id
        label
        kycStatusDetailed { 
          code
          label
        }
        kycExpirationDate
        user {
          email
          firstName
          lastName
        }
        # ...Other Account fields
      }
    }
    totalCount
  }
}

→ Type reference: Account

Managing Account Access

Checking Portal Access

The portalAccess field indicates whether the user linked to an account can access the investor portal:

query CheckPortalAccess {
  GetAccount(id: "123") {
    id
    label
    user {
      id
      active
      acceptedAt
    }
    portalAccess {
      id
      active
      acceptedAt
      # ...Other User fields
    }
  }
}

→ Type reference: User

• user.active: true + user.acceptedAt not null → access is enabled
• user.active: false → access is disabled

Retrieving Account Documents

Fetch all documents associated with an account and filter by type using GetAccountDocumentTypes:

query AccountDocuments {
  GetAccount(id: "123") {
    id
    accountDocuments {
      id
      document {
        id
        name
        mimeType
        url
      }
    }
    kycArchiveUrl    # URL to download the full KYC archive PDF
    adequacyReportUrl  # URL to download the adequacy report PDF
    # ...Other Account fields
  }
}

→ Type reference: Account

Retrieving Available Document Types

To know which document types can be attached to an account (requires ROLE_CAN_ACCESS_CONFIGURATION_PROPERTIES):

query {
  GetAccountDocumentTypes {
    id
    code
    label
  }
}

→ Reference: GetAccountDocumentTypes

Related Reference

Operation	Reference
Fetch a single account	GetAccount
List all accounts	GetAccounts
List accounts pending KYC review	GetKycsToReview
Create a user (and first account)	CreateUser
List account document types	GetAccountDocumentTypes
Set KYC status	SetAccountKycStatus