Vasco GraphQL Documentation

Welcome to the Vasco API reference! This reference includes the complete set of GraphQL types, queries, mutations, and their parameters to interact with Vasco.

Feel free to contact our team if you need more informations regarding our API integration.

Contact

Support API

api@vasco.fund

License

Proprietary

API Endpoints
# Production - Api publique:
https://api.XXX_client_name_XXX.vasco.fund/public/graphql/
# Préproduction - Api publique:
https://api.preprod.XXX_client_name_XXX.vasco.fund/public/graphql/
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>

API GraphQL

The Vasco API is built respecting the GraphQL specifications.

Read more on : https://graphql.org/

Authentication

To authenticate you on the API, you need to provide a token in the Authorization header.

This token is a JWT. You can retrieve it by making a POST request to /auth/login

Body : 

{
  "username": "user@test.com",
  "password": "pass"
}

The response will contain a token in such a format:

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpXXXXXX.YYYYYY"
}

You have to make your next API calls using this Token in Authorization header:

POST /public/graphql/
            Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpXXXXXX.YYYYYY
            
            ....

Queries

GetAccountTypes

Response

Returns [AccountTypeDetailed]!

Example

Query
query GetAccountTypes {
  GetAccountTypes {
    code
    label
  }
}
Response
{
  "data": {
    "GetAccountTypes": [
      {
        "code": "IndividualAccount",
        "label": "abc123"
      }
    ]
  }
}
Queries

GetCmsBlock

Response

Returns a CmsBlock

Arguments
Name Description
cmsBlockId - ID!

Example

Query
query GetCmsBlock($cmsBlockId: ID!) {
  GetCmsBlock(cmsBlockId: $cmsBlockId) {
    id
    name
    content
  }
}
Variables
{"cmsBlockId": 4}
Response
{
  "data": {
    "GetCmsBlock": {
      "id": "abc123",
      "name": "abc123",
      "content": "xyz789"
    }
  }
}
Queries

GetConfiguration

Response

Returns a Configuration

Example

Query
query GetConfiguration {
  GetConfiguration {
    id
    partnerEmail
    partnerName
    emailPrimaryColor
    logoDarkUrl
    logoLightUrl
    faviconUrl
    injectedCss
    dealflowManagementUrl
    signInConfiguration
    minimumPasswordLength
    kycDistributorHasStep
    alertingCategory
    helpConfiguration
    helpUrl
    messageBlockConfiguration {
      id
      content
      localizedContent {
        locale
        value
      }
      enabled
      displayConditions
      segments {
        id
        name
        description
        type
        segmentType {
          ...SegmentTypeDetailedFragment
        }
        userSegments {
          ...UserSegmentConnectionFragment
        }
        usersNumber
        updatedAt
      }
    }
    displayableMessageBlock {
      id
      content
      localizedContent {
        locale
        value
      }
      enabled
      displayConditions
      segments {
        id
        name
        description
        type
        segmentType {
          ...SegmentTypeDetailedFragment
        }
        userSegments {
          ...UserSegmentConnectionFragment
        }
        usersNumber
        updatedAt
      }
    }
    supportedLocales {
      code
      label
    }
    defaultLocale {
      code
      label
    }
    usedBankAccountTypes {
      Investor {
        code
        label
      }
      Distributor {
        code
        label
      }
      DistributorNetwork {
        code
        label
      }
      Vehicle {
        code
        label
      }
    }
    isPreProd
    urlPreProd
    urlProd
    documentBatchAsynchronousThreshold
    documentBatchToggleVisibilityAsynchronousThreshold
    paginationDefaultResultsNumber
  }
}
Response
{
  "data": {
    "GetConfiguration": {
      "id": 4,
      "partnerEmail": "xyz789",
      "partnerName": "xyz789",
      "emailPrimaryColor": "abc123",
      "logoDarkUrl": "abc123",
      "logoLightUrl": "xyz789",
      "faviconUrl": "xyz789",
      "injectedCss": "abc123",
      "dealflowManagementUrl": "xyz789",
      "signInConfiguration": Array,
      "minimumPasswordLength": 123,
      "kycDistributorHasStep": false,
      "alertingCategory": "xyz789",
      "helpConfiguration": Array,
      "helpUrl": "xyz789",
      "messageBlockConfiguration": MessageBlock,
      "displayableMessageBlock": MessageBlock,
      "supportedLocales": [SupportedLocaleDetailed],
      "defaultLocale": SupportedLocaleDetailed,
      "usedBankAccountTypes": UsedBankAccountTypesByAccountPersona,
      "isPreProd": false,
      "urlPreProd": "abc123",
      "urlProd": "abc123",
      "documentBatchAsynchronousThreshold": 123,
      "documentBatchToggleVisibilityAsynchronousThreshold": 123,
      "paginationDefaultResultsNumber": 123
    }
  }
}
Queries

GetFeatureFlag

Response

Returns a FeatureFlag

Arguments
Name Description
featureFlagId - FeatureFlagId!

Example

Query
query GetFeatureFlag($featureFlagId: FeatureFlagId!) {
  GetFeatureFlag(featureFlagId: $featureFlagId) {
    id
    name
    description
    enabled
  }
}
Variables
{"featureFlagId": "FEATURE_2FA_ADMIN_REQUIRED"}
Response
{
  "data": {
    "GetFeatureFlag": {
      "id": "FEATURE_2FA_ADMIN_REQUIRED",
      "name": "abc123",
      "description": "xyz789",
      "enabled": true
    }
  }
}
Queries

GetFeatureFlags

Response

Returns [FeatureFlag]

Example

Query
query GetFeatureFlags {
  GetFeatureFlags {
    id
    name
    description
    enabled
  }
}
Response
{
  "data": {
    "GetFeatureFlags": [
      {
        "id": "FEATURE_2FA_ADMIN_REQUIRED",
        "name": "abc123",
        "description": "xyz789",
        "enabled": false
      }
    ]
  }
}
Queries

GetPasswordToken

Response

Returns a PasswordToken!

Arguments
Name Description
token - String!

Example

Query
query GetPasswordToken($token: String!) {
  GetPasswordToken(token: $token) {
    token
    needTosAcknowledged
  }
}
Variables
{"token": "xyz789"}
Response
{
  "data": {
    "GetPasswordToken": {
      "token": "4",
      "needTosAcknowledged": false
    }
  }
}

Mutations

CreateUser

Description

This mutation is used to create a user. If you are not authenticated, it will be like a user asking access. If you are authenticated as a distributor, the created user will be linked to you. If you are authenticated as a distributor network, the created user will be linked to the distributor you give in $distributorId, which must be one of your network

Response

Returns a CreatedUser!

Arguments
Name Description
firstName - String!
lastName - String!
mobile - String!
email - String!
persona - Persona!
firstAccountInformation - NewUserAccountInformationInput!
active - Boolean Activate the access without review. Default = false
withEmail - Boolean Send an email to the user when activating the access. Default = false
tosAcknowledged - Boolean Default = false
distributorAdvisorId - ID
locale - SupportedLocale
signupUrl - String

Example

Query
mutation CreateUser(
  $firstName: String!,
  $lastName: String!,
  $mobile: String!,
  $email: String!,
  $persona: Persona!,
  $firstAccountInformation: NewUserAccountInformationInput!,
  $active: Boolean,
  $withEmail: Boolean,
  $tosAcknowledged: Boolean,
  $distributorAdvisorId: ID,
  $locale: SupportedLocale,
  $signupUrl: String
) {
  CreateUser(
    firstName: $firstName,
    lastName: $lastName,
    mobile: $mobile,
    email: $email,
    persona: $persona,
    firstAccountInformation: $firstAccountInformation,
    active: $active,
    withEmail: $withEmail,
    tosAcknowledged: $tosAcknowledged,
    distributorAdvisorId: $distributorAdvisorId,
    locale: $locale,
    signupUrl: $signupUrl
  ) {
    id
    active
    email
    persona
    firstName
    lastName
  }
}
Variables
{
  "firstName": "abc123",
  "lastName": "abc123",
  "mobile": "abc123",
  "email": "abc123",
  "persona": "ADMIN",
  "firstAccountInformation": NewUserAccountInformationInput,
  "active": false,
  "withEmail": false,
  "tosAcknowledged": false,
  "distributorAdvisorId": "4",
  "locale": "fr_FR",
  "signupUrl": "abc123"
}
Response
{
  "data": {
    "CreateUser": {
      "id": "4",
      "active": false,
      "email": "xyz789",
      "persona": "ADMIN",
      "firstName": "abc123",
      "lastName": "xyz789"
    }
  }
}
Mutations

RequestPasswordReset

Response

Returns a Boolean!

Arguments
Name Description
email - String!

Example

Query
mutation RequestPasswordReset($email: String!) {
  RequestPasswordReset(email: $email)
}
Variables
{"email": "xyz789"}
Response
{"data": {"RequestPasswordReset": false}}
Mutations

ResetPassword

Response

Returns a ResetPasswordSucceed!

Arguments
Name Description
token - String!
newPassword - String!
tosAcknowledged - Boolean

Example

Query
mutation ResetPassword(
  $token: String!,
  $newPassword: String!,
  $tosAcknowledged: Boolean
) {
  ResetPassword(
    token: $token,
    newPassword: $newPassword,
    tosAcknowledged: $tosAcknowledged
  ) {
    token
  }
}
Variables
{
  "token": "abc123",
  "newPassword": "xyz789",
  "tosAcknowledged": false
}
Response
{
  "data": {
    "ResetPassword": {"token": "abc123"}
  }
}

Types

Account

Fields
Field Name Description
id - ID!
createdAt - DateTime!
documentControls - [AccountDocumentControl]
mostRecentVialinkControl - VialinkControl
label - String!
type - AccountType! Use accountType
accountType - AccountTypeDetailed!
lcbftLevel - LcbftLevelDetailed! Use investorInfo.lcbftLevel instead
kycExpirationDate - DateTime
kycStatus - KycStatus! use kycStatusDetailed instead
kycStatusDetailed - KycStatusDetailed!
kycRefusedComment - String
investorInfo - InvestorInfo!
user - User
Arguments
userId - ID

Optional user ID to return instead of the account's default user
canValidateKyc - Boolean
kycAnalysisResult - Array
accountDocuments - [AccountDocument]
bankAccounts - [BankAccount]
bankAccountByBankAccountType - BankAccount
Arguments
bankAccountType - BankAccountType!
fallbackToDefault - Boolean

If true, will return the default bank account if no bank account of the given type is found
accountSecurityContracts - [AccountSecurityContract]
investmentsAndTransfers - [Transaction]
Arguments
securityId - ID
transactionMoneyMovementState - TransactionMoneyMovementState
investments - [Investment]
Arguments
operationStates - [OperationState]
cessions - [Cession]
Arguments
securityId - ID
countryRisk - LcbftLevelDetailed!
activitySectorRisk - LcbftLevelDetailed!
relationshipRisk - LcbftLevelDetailed!
ppeRisk - LcbftLevelDetailed!
sanctionsRisk - LcbftLevelDetailed!
adequate - Boolean
distributedByAdvisor - DistributorAdvisor
signedDocuments - [AccountDocumentControl]
signersStatuses - [SignerStatus!]!
history - [AccountLogHistory]!
Arguments
type - String!

One of 'account', 'kyc' or 'lcbft'
kycStep - ConfigurableFormStep
accountComments - [AccountComment]
accountPersona - AccountPersonaDetailed!
suggestedExpirationDate - DateTime
portfolio - Portfolio
Arguments
visualizationDate - Date

The portfolio will be rendered as the state it was at this date
Possible Types
Account Types

CompanyAccount

CorporateAccount
Example
{
  "id": 4,
  "createdAt": "2007-12-03T10:15:30Z",
  "documentControls": [AccountDocumentControl],
  "mostRecentVialinkControl": VialinkControl,
  "label": "xyz789",
  "type": "IndividualAccount",
  "accountType": AccountTypeDetailed,
  "lcbftLevel": LcbftLevelDetailed,
  "kycExpirationDate": "2007-12-03T10:15:30Z",
  "kycStatus": "TO_COMPLETE",
  "kycStatusDetailed": KycStatusDetailed,
  "kycRefusedComment": "xyz789",
  "investorInfo": InvestorInfo,
  "user": User,
  "canValidateKyc": true,
  "kycAnalysisResult": Array,
  "accountDocuments": [AccountDocument],
  "bankAccounts": [BankAccount],
  "bankAccountByBankAccountType": BankAccount,
  "accountSecurityContracts": [AccountSecurityContract],
  "investmentsAndTransfers": [Transaction],
  "investments": [Investment],
  "cessions": [Cession],
  "countryRisk": LcbftLevelDetailed,
  "activitySectorRisk": LcbftLevelDetailed,
  "relationshipRisk": LcbftLevelDetailed,
  "ppeRisk": LcbftLevelDetailed,
  "sanctionsRisk": LcbftLevelDetailed,
  "adequate": false,
  "distributedByAdvisor": DistributorAdvisor,
  "signedDocuments": [AccountDocumentControl],
  "signersStatuses": [SignerStatus],
  "history": [AccountLogHistory],
  "kycStep": ConfigurableFormStep,
  "accountComments": [AccountComment],
  "accountPersona": AccountPersonaDetailed,
  "suggestedExpirationDate": "2007-12-03T10:15:30Z",
  "portfolio": Portfolio
}
Types

AccountComment

Description

An Account comment

Fields
Field Name Description
id - ID!
content - String!
account - Account!
userCreator - String!
lastEditor - String
createdAt - DateTime!
Example
{
  "id": 4,
  "content": "xyz789",
  "account": Account,
  "userCreator": "abc123",
  "lastEditor": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z"
}
Types

AccountDocument

Description

An Account document

Fields
Field Name Description
visibleByInvestor - Boolean!
id - ID!
document - Document!
account - Account!
Example
{
  "visibleByInvestor": true,
  "id": "4",
  "document": Document,
  "account": Account
}
Types

AccountDocumentControl

Description

A document control enriched with the account KycQuestion

Fields
Field Name Description
id - ID
documentControl - DocumentControl
required - Boolean!
label - String!
kycQuestion - ConfigurableFormQuestion
Example
{
  "id": "4",
  "documentControl": DocumentControl,
  "required": true,
  "label": "xyz789",
  "kycQuestion": ConfigurableFormQuestion
}
Types

AccountLogHistory

Fields
Field Name Description
id - ID!
event - String!
authorName - String
authorPersona - String
date - DateTime
ownerId - ID
accountId - ID
Example
{
  "id": "4",
  "event": "xyz789",
  "authorName": "abc123",
  "authorPersona": "xyz789",
  "date": "2007-12-03T10:15:30Z",
  "ownerId": "4",
  "accountId": 4
}
Types

AccountPersona

Values
Enum Value Description

Investor

Distributor

DistributorNetwork

Vehicle

Target
Example
"Investor"
Types

AccountPersonaDetailed

Fields
Field Name Description
code - AccountPersona!
label - String!
Example
{"code": "Investor", "label": "xyz789"}
Types

AccountSecurityContract

Description

An Account security contract

Fields
Field Name Description
id - ID!
account - Account!
security - Security!
pledges - [Pledge]
redeemableSecuritiesNumber - Float
currentWithdrawalPrice - Amount
Example
{
  "id": "4",
  "account": Account,
  "security": Security,
  "pledges": [Pledge],
  "redeemableSecuritiesNumber": 123.45,
  "currentWithdrawalPrice": Amount
}
Types

AccountType

Values
Enum Value Description

IndividualAccount

CorporateAccount

JointAccount
Example
"IndividualAccount"
Types

AccountTypeDetailed

Fields
Field Name Description
code - AccountType!
label - String!
Example
{
  "code": "IndividualAccount",
  "label": "xyz789"
}
Types

ActiveParticipation

Description

An Active Portfolio Participation

Fields
Field Name Description
id - ID
lastOperation - Operation
issuerId - String
issuerName - String
issuerLogo - Document
issuerRisk - Int
targetActivity - String
targetPmsSector - PmsSector
investedCapital - Amount
engagedCapital - Amount
remainingCapital - Amount
repaidCapital - Amount
calledCapital - Amount
remainingToCallCapital - Amount
repaidGainRaw - Amount
collectedTaxation - Amount
repaidGainNet - Amount
repaidRaw - Amount
repaidNet - Amount
generatedGainRaw - Amount
currentIrr - Float
currentMultiple - Float!
estimatedEndDate - Date
unrealizedGainRaw - Amount
totalValue - Amount
dpi - Float
rvpi - Float
tvpi - Float
percentageOfPortfolio - Float!
percentageOwned - Float
lastValue - Amount!
security - Security!
firstInvestmentDate - Date!
detentionPeriodInMonths - Int!
account - Account
remainingSecuritiesCount - Float!
recallableAmount - Amount
Example
{
  "id": 4,
  "lastOperation": Operation,
  "issuerId": "abc123",
  "issuerName": "abc123",
  "issuerLogo": Document,
  "issuerRisk": 987,
  "targetActivity": "abc123",
  "targetPmsSector": PmsSector,
  "investedCapital": Amount,
  "engagedCapital": Amount,
  "remainingCapital": Amount,
  "repaidCapital": Amount,
  "calledCapital": Amount,
  "remainingToCallCapital": Amount,
  "repaidGainRaw": Amount,
  "collectedTaxation": Amount,
  "repaidGainNet": Amount,
  "repaidRaw": Amount,
  "repaidNet": Amount,
  "generatedGainRaw": Amount,
  "currentIrr": 123.45,
  "currentMultiple": 123.45,
  "estimatedEndDate": "2007-12-03",
  "unrealizedGainRaw": Amount,
  "totalValue": Amount,
  "dpi": 987.65,
  "rvpi": 987.65,
  "tvpi": 987.65,
  "percentageOfPortfolio": 987.65,
  "percentageOwned": 123.45,
  "lastValue": Amount,
  "security": Security,
  "firstInvestmentDate": "2007-12-03",
  "detentionPeriodInMonths": 123,
  "account": Account,
  "remainingSecuritiesCount": 123.45,
  "recallableAmount": Amount
}
Types

ActivitySector

Fields
Field Name Description
id - ID!
label - String!
Example
{"id": 4, "label": "xyz789"}
Types

Address

Fields
Field Name Description
id - ID!
street - String
city - String
postalCode - String
country - Country
Example
{
  "id": "4",
  "street": "abc123",
  "city": "xyz789",
  "postalCode": "abc123",
  "country": Country
}
Types

Algorithm

Fields
Field Name Description
id - ID!
technicalCode - AlgorithmTechnicalCodeDetailed
label - String!
algorithm - String!
type - AlgorithmTypeDetailed!
category - AlgorithmCategoryDetailed!
Example
{
  "id": 4,
  "technicalCode": AlgorithmTechnicalCodeDetailed,
  "label": "xyz789",
  "algorithm": "abc123",
  "type": AlgorithmTypeDetailed,
  "category": AlgorithmCategoryDetailed
}
Types

AlgorithmCategory

Values
Enum Value Description

DOCUMENT_FILTER

STEP_FILTER

CessionDistributionAmountComputeStrategy

DocumentVariables

Kpi
Example
"DOCUMENT_FILTER"
Types

AlgorithmCategoryDetailed

Fields
Field Name Description
code - AlgorithmCategory!
label - String!
Example
{
  "code": "DOCUMENT_FILTER",
  "label": "abc123"
}
Types

AlgorithmTechnicalCode

Values
Enum Value Description

AmountComputeMaximumDispatchableAmount

AmountComputeMaximumDispatchableAmountByEffectiveDays

AmountComputePriceBySecurity

AmountComputePriceBySecurityByEffectiveDays

KycAnalysis

KycExpirationDate

RetrocessionInvoiceNumber

SamlUserFactory

DismembermentDurationStrategyForContracts

DismembermentEndDateComputation
Example
"AmountComputeMaximumDispatchableAmount"
Types

AlgorithmTechnicalCodeDetailed

Fields
Field Name Description
code - AlgorithmTechnicalCode!
label - String!
Example
{
  "code": "AmountComputeMaximumDispatchableAmount",
  "label": "xyz789"
}
Types

AlgorithmType

Values
Enum Value Description

ExpressionLanguage

Twig

Sql
Example
"ExpressionLanguage"
Types

AlgorithmTypeDetailed

Fields
Field Name Description
code - AlgorithmType!
label - String!
Example
{
  "code": "ExpressionLanguage",
  "label": "xyz789"
}
Types

Amount

Example
Amount
Types

Any

Example
Any
Types

Array

Example
Array
Types

AsynchronousOperation

Fields
Field Name Description
id - ID!
status - AsynchronousOperationState
type - AsynchronousOperationType
createdAt - Date!
updatedAt - Date!
startedAt - Date
endedAt - Date
authorName - String
authorEmail - String
executionCount - Int
securityOperation - SecurityOperation
Example
{
  "id": "4",
  "status": "Created",
  "type": "ConveneGeneralAssembly",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "startedAt": "2007-12-03",
  "endedAt": "2007-12-03",
  "authorName": "xyz789",
  "authorEmail": "abc123",
  "executionCount": 987,
  "securityOperation": SecurityOperation
}
Types

AsynchronousOperationState

Values
Enum Value Description

Created

Started

Failed

Done

Retryable
Example
"Created"
Types

AsynchronousOperationType

Values
Enum Value Description

ConveneGeneralAssembly

CustomExport

DocumentBatchDocumentToggleVisibility

ExportDataTable

GenerateDocumentBatch

SecurityOperationDistributionCreateDistribution

SecurityOperationDistributionDownloadCreditTransferSepaFile

SecurityOperationDistributionResetTransactionMoneyMovementsExportedState

SecurityOperationDistributionSetPaymentDate

UpdateAttendanceGeneralAssembly
Example
"ConveneGeneralAssembly"
Types

BankAccount

Fields
Field Name Description
id - ID!
account - Account
iban - String
bic - String
holderName - String
bankName - String
status - BankAccountStatusDetailed
documentControl - DocumentControl
bankAccountType - BankAccountTypeDetailed!
countryLocation - Country
countryRisk - LcbftLevelDetailed
customProperties - [BankAccountCustomProperty]
externalProvider - ProviderTypeDetailed
externalId - String
activeExternalProvider - Boolean
Example
{
  "id": "4",
  "account": Account,
  "iban": "xyz789",
  "bic": "xyz789",
  "holderName": "abc123",
  "bankName": "abc123",
  "status": BankAccountStatusDetailed,
  "documentControl": DocumentControl,
  "bankAccountType": BankAccountTypeDetailed,
  "countryLocation": Country,
  "countryRisk": LcbftLevelDetailed,
  "customProperties": [BankAccountCustomProperty],
  "externalProvider": ProviderTypeDetailed,
  "externalId": "xyz789",
  "activeExternalProvider": true
}
Types

BankAccountCustomProperty

Fields
Field Name Description
entityProperty - EntityProperty
value - Array
Example
{
  "entityProperty": EntityProperty,
  "value": Array
}
Types

BankAccountStatus

Values
Enum Value Description

Valid

Invalid
Example
"Valid"
Types

BankAccountStatusDetailed

Fields
Field Name Description
code - BankAccountStatus!
label - String!
Example
{"code": "Valid", "label": "abc123"}
Types

BankAccountType

Values
Enum Value Description

AccountCreditTransfer

AccountDirectDebit

AccountRetrocessionDebit

AccountPea

AccountPeaPme

OperationBankAccount

BrokerageAccount
Example
"AccountCreditTransfer"
Types

BankAccountTypeDetailed

Fields
Field Name Description
code - BankAccountType!
label - String!
Example
{
  "code": "AccountCreditTransfer",
  "label": "abc123"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

Cession

Description

A Cession

Fields
Field Name Description
id - ID
type - TransactionType! Use transactionType instead
transactionType - TransactionTypeDetailed!
securitiesNumber - Float!
unpledgedSecuritiesNumber - Float!
transactionDocuments - [TransactionDocument]
transactionMoneyMovement - TransactionMoneyMovement
transactionFees - [TransactionFee]
priceBySecurity - Float!
amount - Amount!
rawAmount - Amount!
securityOperation - SecurityOperation Use transactionSecurity.securityOperation
transactionSecurity - TransactionSecurity
fromAccount - Account
toAccount - Account
transactionNumberings - [TransactionNumbering]
dismembermentType - DismembermentTypeDetailed
documentsZipFileUrl - String! URL to download the zip file containing all transaction documents. Only for Investments and CapitalCalls
distributionType - DistributionTypeDetailed!
distributionTaxation - DistributionTaxationDetailed!
reinvestmentPercentage - Float
reinvestmentAmount - Amount
rawGainAmount - Amount
rawCapitalAmount - Amount
taxationAmount - Amount
taxationDetails - Array
endEffectiveDate - Date
Example
{
  "id": "4",
  "type": "INVESTMENT",
  "transactionType": TransactionTypeDetailed,
  "securitiesNumber": 123.45,
  "unpledgedSecuritiesNumber": 123.45,
  "transactionDocuments": [TransactionDocument],
  "transactionMoneyMovement": TransactionMoneyMovement,
  "transactionFees": [TransactionFee],
  "priceBySecurity": 987.65,
  "amount": Amount,
  "rawAmount": Amount,
  "securityOperation": SecurityOperation,
  "transactionSecurity": TransactionSecurity,
  "fromAccount": Account,
  "toAccount": Account,
  "transactionNumberings": [TransactionNumbering],
  "dismembermentType": DismembermentTypeDetailed,
  "documentsZipFileUrl": "xyz789",
  "distributionType": DistributionTypeDetailed,
  "distributionTaxation": DistributionTaxationDetailed,
  "reinvestmentPercentage": 123.45,
  "reinvestmentAmount": Amount,
  "rawGainAmount": Amount,
  "rawCapitalAmount": Amount,
  "taxationAmount": Amount,
  "taxationDetails": Array,
  "endEffectiveDate": "2007-12-03"
}
Types

CmsBlock

Fields
Field Name Description
id - String!
name - String!
content - String
Example
{
  "id": "abc123",
  "name": "abc123",
  "content": "abc123"
}
Types

Communication

Fields
Field Name Description
id - ID!
title - String!
localizedTitle - [LocalizedString]!
issuer - Company!
communicationType - CommunicationTypeDetailed!
period - Date!
htmlContent - String
localizedHtmlContent - [LocalizedString]!
state - CommunicationStateDetailed! State of the communication
publishDate - DateTime
CommunicationDocuments - [CommunicationDocument] Use 'communicationDocuments' instead
communicationDocuments - [CommunicationDocument]
Example
{
  "id": 4,
  "title": "abc123",
  "localizedTitle": [LocalizedString],
  "issuer": Company,
  "communicationType": CommunicationTypeDetailed,
  "period": "2007-12-03",
  "htmlContent": "abc123",
  "localizedHtmlContent": [LocalizedString],
  "state": CommunicationStateDetailed,
  "publishDate": "2007-12-03T10:15:30Z",
  "CommunicationDocuments": [CommunicationDocument],
  "communicationDocuments": [CommunicationDocument]
}
Types

CommunicationDocument

Fields
Field Name Description
id - ID!
communication - Communication!
document - Document!
Example
{
  "id": "4",
  "communication": Communication,
  "document": Document
}
Types

CommunicationState

Values
Enum Value Description

Draft

Published

Unpublished
Example
"Draft"
Types

CommunicationStateDetailed

Fields
Field Name Description
code - CommunicationState!
label - String!
Example
{"code": "Draft", "label": "abc123"}
Types

CommunicationType

Values
Enum Value Description

Reporting

News
Example
"Reporting"
Types

CommunicationTypeDetailed

Fields
Field Name Description
code - CommunicationType!
label - String!
Example
{"code": "Reporting", "label": "abc123"}
Types

Company

Description

A Company

Fields
Field Name Description
id - ID!
corporateAccount - CompanyAccount!
securities - [Security]
risk - Int
logo - Document
companyDocuments - [CompanyDocument]
communications - [Communication]
Example
{
  "id": "4",
  "corporateAccount": CompanyAccount,
  "securities": [Security],
  "risk": 987,
  "logo": Document,
  "companyDocuments": [CompanyDocument],
  "communications": [Communication]
}
Types

CompanyAccount

Fields
Field Name Description
id - ID!
createdAt - DateTime!
documentControls - [AccountDocumentControl]
mostRecentVialinkControl - VialinkControl
label - String!
type - AccountType! Use accountType
accountType - AccountTypeDetailed!
lcbftLevel - LcbftLevelDetailed! Use investorInfo.lcbftLevel instead
kycExpirationDate - DateTime
kycStatus - KycStatus! use kycStatusDetailed instead
kycStatusDetailed - KycStatusDetailed!
kycRefusedComment - String
investorInfo - InvestorInfo!
user - User
Arguments
userId - ID

Optional user ID to return instead of the account's default user
canValidateKyc - Boolean
kycAnalysisResult - Array
accountDocuments - [AccountDocument]
bankAccounts - [BankAccount]
bankAccountByBankAccountType - BankAccount
Arguments
bankAccountType - BankAccountType!
fallbackToDefault - Boolean

If true, will return the default bank account if no bank account of the given type is found
accountSecurityContracts - [AccountSecurityContract]
investmentsAndTransfers - [Transaction]
Arguments
securityId - ID
transactionMoneyMovementState - TransactionMoneyMovementState
investments - [Investment]
Arguments
operationStates - [OperationState]
cessions - [Cession]
Arguments
securityId - ID
countryRisk - LcbftLevelDetailed!
activitySectorRisk - LcbftLevelDetailed!
relationshipRisk - LcbftLevelDetailed!
ppeRisk - LcbftLevelDetailed!
sanctionsRisk - LcbftLevelDetailed!
adequate - Boolean
distributedByAdvisor - DistributorAdvisor
signedDocuments - [AccountDocumentControl]
signersStatuses - [SignerStatus!]!
history - [AccountLogHistory]!
Arguments
type - String!

One of 'account', 'kyc' or 'lcbft'
kycStep - ConfigurableFormStep
accountComments - [AccountComment]
accountPersona - AccountPersonaDetailed!
suggestedExpirationDate - DateTime
portfolio - Portfolio
Arguments
visualizationDate - Date

The portfolio will be rendered as the state it was at this date
corporateInfo - CorporateInfo!
representativeLegalInfo - LegalInfo
taxationType - CorporateAccountTaxationTypeDetailed
possibleTaxationTypes - [CorporateAccountTaxationTypeDetailed]
company - Company!
distributor - Distributor
distributorNetwork - DistributorNetwork
Example
{
  "id": 4,
  "createdAt": "2007-12-03T10:15:30Z",
  "documentControls": [AccountDocumentControl],
  "mostRecentVialinkControl": VialinkControl,
  "label": "abc123",
  "type": "IndividualAccount",
  "accountType": AccountTypeDetailed,
  "lcbftLevel": LcbftLevelDetailed,
  "kycExpirationDate": "2007-12-03T10:15:30Z",
  "kycStatus": "TO_COMPLETE",
  "kycStatusDetailed": KycStatusDetailed,
  "kycRefusedComment": "abc123",
  "investorInfo": InvestorInfo,
  "user": User,
  "canValidateKyc": false,
  "kycAnalysisResult": Array,
  "accountDocuments": [AccountDocument],
  "bankAccounts": [BankAccount],
  "bankAccountByBankAccountType": BankAccount,
  "accountSecurityContracts": [AccountSecurityContract],
  "investmentsAndTransfers": [Transaction],
  "investments": [Investment],
  "cessions": [Cession],
  "countryRisk": LcbftLevelDetailed,
  "activitySectorRisk": LcbftLevelDetailed,
  "relationshipRisk": LcbftLevelDetailed,
  "ppeRisk": LcbftLevelDetailed,
  "sanctionsRisk": LcbftLevelDetailed,
  "adequate": false,
  "distributedByAdvisor": DistributorAdvisor,
  "signedDocuments": [AccountDocumentControl],
  "signersStatuses": [SignerStatus],
  "history": [AccountLogHistory],
  "kycStep": ConfigurableFormStep,
  "accountComments": [AccountComment],
  "accountPersona": AccountPersonaDetailed,
  "suggestedExpirationDate": "2007-12-03T10:15:30Z",
  "portfolio": Portfolio,
  "corporateInfo": CorporateInfo,
  "representativeLegalInfo": LegalInfo,
  "taxationType": CorporateAccountTaxationTypeDetailed,
  "possibleTaxationTypes": [
    CorporateAccountTaxationTypeDetailed
  ],
  "company": Company,
  "distributor": Distributor,
  "distributorNetwork": DistributorNetwork
}
Types

CompanyCorporateAccountRepresentativeCorporateInput

Fields
Input Field Description
representativeCorporateName - String!
Example
{"representativeCorporateName": "xyz789"}
Types

CompanyCorporateAccountRepresentativeInput

Fields
Input Field Description
representativePersonal - CompanyCorporateAccountRepresentativePersonalInput
representativeCorporate - CompanyCorporateAccountRepresentativeCorporateInput
Example
{
  "representativePersonal": CompanyCorporateAccountRepresentativePersonalInput,
  "representativeCorporate": CompanyCorporateAccountRepresentativeCorporateInput
}
Types

CompanyCorporateAccountRepresentativePersonalInput

Fields
Input Field Description
representativeFirstName - String!
representativeLastName - String!
Example
{
  "representativeFirstName": "abc123",
  "representativeLastName": "xyz789"
}
Types

CompanyDocument

Description

A Company document

Fields
Field Name Description
id - ID!
document - Document!
createdBy - User!
createdAt - DateTime!
Example
{
  "id": 4,
  "document": Document,
  "createdBy": User,
  "createdAt": "2007-12-03T10:15:30Z"
}
Types

ComplianceControl

Fields
Field Name Description
id - ID!
viaLinkControl - VialinkControl!
documentControl - DocumentControl
level - ComplianceControlLevelDetailed!
source - String!
comment - String
failedData - Array! Use failedChecks
failedChecks - [ComplianceControlCheck]!
user - User!
isAlert - Boolean!
Example
{
  "id": "4",
  "viaLinkControl": VialinkControl,
  "documentControl": DocumentControl,
  "level": ComplianceControlLevelDetailed,
  "source": "abc123",
  "comment": "xyz789",
  "failedData": Array,
  "failedChecks": [ComplianceControlCheck],
  "user": User,
  "isAlert": true
}
Types

ComplianceControlCheck

Fields
Field Name Description
code - String!
label - String!
value - Mixed
Example
{
  "code": "xyz789",
  "label": "xyz789",
  "value": Mixed
}
Types

ComplianceControlLevel

Values
Enum Value Description

Level0

Level1

Level2
Example
"Level0"
Types

ComplianceControlLevelDetailed

Fields
Field Name Description
code - ComplianceControlLevel!
label - String!
Example
{"code": "Level0", "label": "xyz789"}
Types

ConfigurableForm

Fields
Field Name Description
id - ID!
technicalCode - ConfigurableFormTechnicalCode
label - String!
configurableFormType - ConfigurableFormTypeDetailed!
configurableFormHasSteps - [ConfigurableFormHasStep]
Example
{
  "id": "4",
  "technicalCode": "KycInvestor",
  "label": "xyz789",
  "configurableFormType": ConfigurableFormTypeDetailed,
  "configurableFormHasSteps": [ConfigurableFormHasStep]
}
Types

ConfigurableFormHasStep

Fields
Field Name Description
id - ID!
configurableForm - ConfigurableForm!
configurableFormStep - ConfigurableFormStep!
sortIndex - Int!
Example
{
  "id": 4,
  "configurableForm": ConfigurableForm,
  "configurableFormStep": ConfigurableFormStep,
  "sortIndex": 123
}
Types

ConfigurableFormQuestion

Fields
Field Name Description
id - ID!
formDefinition - Array!
applicable - String! Define if the field is applicable upon current step data. Syntax in twig
validations - Array!
sortIndex - Int!
technicalCode - String!
configurableFormStep - ConfigurableFormStep!
dataStrategy - FormQuestionDataStrategyDetailed!
dataNormalizer - FormQuestionDataNormalizerDetailed!
dataStrategyDefinition - Mixed
entityPropertyContext - FormQuestionDataStrategyDefinitionDetailed
dataNormalizerDefinition - Mixed
phpApplicable - String!
entityProperty - EntityProperty Use ConfigurableFormQuestionEntityProperties or FirstEntityProperty instead
firstEntityProperty - EntityProperty
configurableFormQuestionEntityProperties - [ConfigurableFormQuestionEntityProperty]
extendedValidations - Array!
label - String
tooltip - String
placeholder - String
helpText - String
totalLabel - String
append - String
content - String
width - Int
Example
{
  "id": 4,
  "formDefinition": Array,
  "applicable": "xyz789",
  "validations": Array,
  "sortIndex": 123,
  "technicalCode": "abc123",
  "configurableFormStep": ConfigurableFormStep,
  "dataStrategy": FormQuestionDataStrategyDetailed,
  "dataNormalizer": FormQuestionDataNormalizerDetailed,
  "dataStrategyDefinition": Mixed,
  "entityPropertyContext": FormQuestionDataStrategyDefinitionDetailed,
  "dataNormalizerDefinition": Mixed,
  "phpApplicable": "xyz789",
  "entityProperty": EntityProperty,
  "firstEntityProperty": EntityProperty,
  "configurableFormQuestionEntityProperties": [
    ConfigurableFormQuestionEntityProperty
  ],
  "extendedValidations": Array,
  "label": "xyz789",
  "tooltip": "abc123",
  "placeholder": "xyz789",
  "helpText": "xyz789",
  "totalLabel": "abc123",
  "append": "xyz789",
  "content": "abc123",
  "width": 123
}
Types

ConfigurableFormQuestionEntityProperty

Fields
Field Name Description
id - ID!
configurableFormQuestion - ConfigurableFormQuestion!
entityProperty - EntityProperty!
sortIndex - Int!
label - String
tooltip - String
placeholder - String
helpText - String
Example
{
  "id": 4,
  "configurableFormQuestion": ConfigurableFormQuestion,
  "entityProperty": EntityProperty,
  "sortIndex": 123,
  "label": "abc123",
  "tooltip": "abc123",
  "placeholder": "abc123",
  "helpText": "abc123"
}
Types

ConfigurableFormStep

Fields
Field Name Description
id - ID!
technicalCode - String!
label - String!
stepFilterAlgorithm - Algorithm
sortIndex - Int! Use sortIndex on ConfigurableFormHasStep instead
questions - [ConfigurableFormQuestion]
Example
{
  "id": "4",
  "technicalCode": "abc123",
  "label": "xyz789",
  "stepFilterAlgorithm": Algorithm,
  "sortIndex": 123,
  "questions": [ConfigurableFormQuestion]
}
Types

ConfigurableFormTechnicalCode

Values
Enum Value Description

KycInvestor

KycDistributor

KycDistributorNetwork

KycVehicle

KycTarget
Example
"KycInvestor"
Types

ConfigurableFormType

Values
Enum Value Description

Kyc

InvestmentModalities
Example
"Kyc"
Types

ConfigurableFormTypeDetailed

Fields
Field Name Description
code - ConfigurableFormType!
label - String!
Example
{"code": "Kyc", "label": "xyz789"}
Types

Configuration

Fields
Field Name Description
id - ID!
partnerEmail - String!
partnerName - String!
emailPrimaryColor - String!
logoDarkUrl - String!
logoLightUrl - String!
faviconUrl - String!
injectedCss - String!
dealflowManagementUrl - String
signInConfiguration - Array!
minimumPasswordLength - Int!
kycDistributorHasStep - Boolean!
alertingCategory - String
helpConfiguration - Array!
helpUrl - String An http link or a mailto:xxx link
messageBlockConfiguration - MessageBlock The data to configure the message block
displayableMessageBlock - MessageBlock The message block to display conditionally
supportedLocales - [SupportedLocaleDetailed]!
defaultLocale - SupportedLocaleDetailed!
usedBankAccountTypes - UsedBankAccountTypesByAccountPersona!
isPreProd - Boolean! Whether this is a pre-production environment
urlPreProd - String! PreProduction url
urlProd - String! Production url
documentBatchAsynchronousThreshold - Int!
documentBatchToggleVisibilityAsynchronousThreshold - Int!
paginationDefaultResultsNumber - Int! Default number of results per page for paginated queries
Example
{
  "id": 4,
  "partnerEmail": "abc123",
  "partnerName": "abc123",
  "emailPrimaryColor": "xyz789",
  "logoDarkUrl": "xyz789",
  "logoLightUrl": "abc123",
  "faviconUrl": "abc123",
  "injectedCss": "abc123",
  "dealflowManagementUrl": "abc123",
  "signInConfiguration": Array,
  "minimumPasswordLength": 123,
  "kycDistributorHasStep": false,
  "alertingCategory": "xyz789",
  "helpConfiguration": Array,
  "helpUrl": "abc123",
  "messageBlockConfiguration": MessageBlock,
  "displayableMessageBlock": MessageBlock,
  "supportedLocales": [SupportedLocaleDetailed],
  "defaultLocale": SupportedLocaleDetailed,
  "usedBankAccountTypes": UsedBankAccountTypesByAccountPersona,
  "isPreProd": false,
  "urlPreProd": "abc123",
  "urlProd": "xyz789",
  "documentBatchAsynchronousThreshold": 987,
  "documentBatchToggleVisibilityAsynchronousThreshold": 123,
  "paginationDefaultResultsNumber": 123
}
Types

ConsolidatedTransaction

Description

A consolidated transaction build from multiple transactions

Fields
Field Name Description
id - ID!
fromAccount - Account Make it nullable due to permission returning null if we are not granted to display account
toAccount - Account Make it nullable due to permission returning null if we are not granted to display account
type - TransactionTypeDetailed!
dismembermentType - DismembermentTypeDetailed
transactionSecurity - TransactionSecurity!
amount - Amount!
rawAmount - Amount!
taxationAmount - Amount!
gainAmount - Amount!
reinvestmentAmount - Amount!
distributedAmount - Amount!
recallableAmount - Amount!
definitiveAmount - Amount!
securitiesNumber - Float!
viewerActingLike - TransferViewerActingLike
transactions - [Transaction]!
Example
{
  "id": 4,
  "fromAccount": Account,
  "toAccount": Account,
  "type": TransactionTypeDetailed,
  "dismembermentType": DismembermentTypeDetailed,
  "transactionSecurity": TransactionSecurity,
  "amount": Amount,
  "rawAmount": Amount,
  "taxationAmount": Amount,
  "gainAmount": Amount,
  "reinvestmentAmount": Amount,
  "distributedAmount": Amount,
  "recallableAmount": Amount,
  "definitiveAmount": Amount,
  "securitiesNumber": 987.65,
  "viewerActingLike": "Investment",
  "transactions": [Transaction]
}
Types

CorporateAccount

Fields
Field Name Description
id - ID!
createdAt - DateTime!
documentControls - [AccountDocumentControl]
mostRecentVialinkControl - VialinkControl
label - String!
type - AccountType! Use accountType
accountType - AccountTypeDetailed!
lcbftLevel - LcbftLevelDetailed! Use investorInfo.lcbftLevel instead
kycExpirationDate - DateTime
kycStatus - KycStatus! use kycStatusDetailed instead
kycStatusDetailed - KycStatusDetailed!
kycRefusedComment - String
investorInfo - InvestorInfo!
user - User
Arguments
userId - ID

Optional user ID to return instead of the account's default user
canValidateKyc - Boolean
kycAnalysisResult - Array
accountDocuments - [AccountDocument]
bankAccounts - [BankAccount]
bankAccountByBankAccountType - BankAccount
Arguments
bankAccountType - BankAccountType!
fallbackToDefault - Boolean

If true, will return the default bank account if no bank account of the given type is found
accountSecurityContracts - [AccountSecurityContract]
investmentsAndTransfers - [Transaction]
Arguments
securityId - ID
transactionMoneyMovementState - TransactionMoneyMovementState
investments - [Investment]
Arguments
operationStates - [OperationState]
cessions - [Cession]
Arguments
securityId - ID
countryRisk - LcbftLevelDetailed!
activitySectorRisk - LcbftLevelDetailed!
relationshipRisk - LcbftLevelDetailed!
ppeRisk - LcbftLevelDetailed!
sanctionsRisk - LcbftLevelDetailed!
adequate - Boolean
distributedByAdvisor - DistributorAdvisor
signedDocuments - [AccountDocumentControl]
signersStatuses - [SignerStatus!]!
history - [AccountLogHistory]!
Arguments
type - String!

One of 'account', 'kyc' or 'lcbft'
kycStep - ConfigurableFormStep
accountComments - [AccountComment]
accountPersona - AccountPersonaDetailed!
suggestedExpirationDate - DateTime
portfolio - Portfolio
Arguments
visualizationDate - Date

The portfolio will be rendered as the state it was at this date
corporateInfo - CorporateInfo!
representativeLegalInfo - LegalInfo
taxationType - CorporateAccountTaxationTypeDetailed
possibleTaxationTypes - [CorporateAccountTaxationTypeDetailed]
company - Company
distributor - Distributor
distributorNetwork - DistributorNetwork
Example
{
  "id": "4",
  "createdAt": "2007-12-03T10:15:30Z",
  "documentControls": [AccountDocumentControl],
  "mostRecentVialinkControl": VialinkControl,
  "label": "xyz789",
  "type": "IndividualAccount",
  "accountType": AccountTypeDetailed,
  "lcbftLevel": LcbftLevelDetailed,
  "kycExpirationDate": "2007-12-03T10:15:30Z",
  "kycStatus": "TO_COMPLETE",
  "kycStatusDetailed": KycStatusDetailed,
  "kycRefusedComment": "abc123",
  "investorInfo": InvestorInfo,
  "user": User,
  "canValidateKyc": false,
  "kycAnalysisResult": Array,
  "accountDocuments": [AccountDocument],
  "bankAccounts": [BankAccount],
  "bankAccountByBankAccountType": BankAccount,
  "accountSecurityContracts": [AccountSecurityContract],
  "investmentsAndTransfers": [Transaction],
  "investments": [Investment],
  "cessions": [Cession],
  "countryRisk": LcbftLevelDetailed,
  "activitySectorRisk": LcbftLevelDetailed,
  "relationshipRisk": LcbftLevelDetailed,
  "ppeRisk": LcbftLevelDetailed,
  "sanctionsRisk": LcbftLevelDetailed,
  "adequate": false,
  "distributedByAdvisor": DistributorAdvisor,
  "signedDocuments": [AccountDocumentControl],
  "signersStatuses": [SignerStatus],
  "history": [AccountLogHistory],
  "kycStep": ConfigurableFormStep,
  "accountComments": [AccountComment],
  "accountPersona": AccountPersonaDetailed,
  "suggestedExpirationDate": "2007-12-03T10:15:30Z",
  "portfolio": Portfolio,
  "corporateInfo": CorporateInfo,
  "representativeLegalInfo": LegalInfo,
  "taxationType": CorporateAccountTaxationTypeDetailed,
  "possibleTaxationTypes": [
    CorporateAccountTaxationTypeDetailed
  ],
  "company": Company,
  "distributor": Distributor,
  "distributorNetwork": DistributorNetwork
}
Types

CorporateAccountTaxationType

Values
Enum Value Description

IR

IS
Example
"IR"
Types

CorporateAccountTaxationTypeDetailed

Fields
Field Name Description
code - CorporateAccountTaxationType!
label - String!
Example
{"code": "IR", "label": "abc123"}
Types

CorporateInfo

Fields
Field Name Description
id - ID!
address - Address
corporateName - String
registrationId - String
legalStatus - LegalStatus
socialCapital - Float
cityRegistration - String
representativeQuality - String
activitySector - ActivitySector
customProperties - [CorporateInfoCustomProperty]
Example
{
  "id": 4,
  "address": Address,
  "corporateName": "abc123",
  "registrationId": "xyz789",
  "legalStatus": LegalStatus,
  "socialCapital": 987.65,
  "cityRegistration": "xyz789",
  "representativeQuality": "abc123",
  "activitySector": ActivitySector,
  "customProperties": [CorporateInfoCustomProperty]
}
Types

CorporateInfoCustomProperty

Fields
Field Name Description
entityProperty - EntityProperty
value - Array
Example
{
  "entityProperty": EntityProperty,
  "value": Array
}
Types

Country

Fields
Field Name Description
id - ID!
country - String!
countryCode - String!
countryShort - String!
sortIndex - Int!
countryRiskCode - CountryRiskCodeDetailed!
Example
{
  "id": 4,
  "country": "xyz789",
  "countryCode": "abc123",
  "countryShort": "abc123",
  "sortIndex": 123,
  "countryRiskCode": CountryRiskCodeDetailed
}
Types

CountryRiskCode

Values
Enum Value Description

High

Low

Maximum

Medium

Minimum
Example
"High"
Types

CountryRiskCodeDetailed

Fields
Field Name Description
code - CountryRiskCode!
label - String!
Example
{"code": "High", "label": "abc123"}
Types

CreatedUser

Description

A User which is just created

Fields
Field Name Description
id - ID
active - Boolean
email - String!
persona - Persona!
firstName - String!
lastName - String!
Example
{
  "id": 4,
  "active": true,
  "email": "xyz789",
  "persona": "ADMIN",
  "firstName": "xyz789",
  "lastName": "xyz789"
}
Types

Date

Example
"2007-12-03"
Types

DateTime

Example
"2007-12-03T10:15:30Z"
Types

Decimal

Example
Decimal
Types

DismembermentType

Values
Enum Value Description

FullOwnership

BareOwnership

Usufruct

LifeBareOwnership

LifeUsufruct

ExpiredUsufruct
Example
"FullOwnership"
Types

DismembermentTypeDetailed

Fields
Field Name Description
code - DismembermentType!
label - String!
needDuration - Boolean!
needUsufructuaryAge - Boolean!
Example
{
  "code": "FullOwnership",
  "label": "xyz789",
  "needDuration": false,
  "needUsufructuaryAge": true
}
Types

DistributionDetail

Fields
Field Name Description
distributionType - DistributionTypeDetailed!
distributionTaxation - DistributionTaxationDetailed!
reinvestmentPercentage - Float
reinvestmentAmount - Amount
Possible Types
DistributionDetail Types

Cession
Example
{
  "distributionType": DistributionTypeDetailed,
  "distributionTaxation": DistributionTaxationDetailed,
  "reinvestmentPercentage": 987.65,
  "reinvestmentAmount": Amount
}
Types

DistributionPeriodicity

Values
Enum Value Description

MONTHLY

QUARTERLY

BIANNUAL

ANNUAL

IN_FINE

VARIABLE
Example
"MONTHLY"
Types

DistributionPeriodicityDetailed

Fields
Field Name Description
code - DistributionPeriodicity!
label - String!
Example
{"code": "MONTHLY", "label": "abc123"}
Types

DistributionTaxation

Values
Enum Value Description

None

FrFlatTax
Example
"None"
Types

DistributionTaxationDetailed

Fields
Field Name Description
code - DistributionTaxation!
label - String!
Example
{"code": "None", "label": "abc123"}
Types

DistributionType

Values
Enum Value Description

LandCapitalGain

FinancialIncome

LandIncome

RecallableDistribution
Example
"LandCapitalGain"
Types

DistributionTypeDetailed

Fields
Field Name Description
code - DistributionType!
label - String!
Example
{
  "code": "LandCapitalGain",
  "label": "abc123"
}
Types

Distributor

Description

A Distributor

Fields
Field Name Description
id - ID
corporateAccount - CorporateAccount
vatPercentage - Float
distributorNetwork - DistributorNetwork
specificSecurityFeePatterns - [SecurityFeePattern!]!
lastInvoiceNumber - String
Example
{
  "id": 4,
  "corporateAccount": CorporateAccount,
  "vatPercentage": 987.65,
  "distributorNetwork": DistributorNetwork,
  "specificSecurityFeePatterns": [SecurityFeePattern],
  "lastInvoiceNumber": "xyz789"
}
Types

DistributorAdvisor

Description

A Distributor advisor

Fields
Field Name Description
id - ID!
user - User!
distributor - Distributor!
Example
{
  "id": 4,
  "user": User,
  "distributor": Distributor
}
Types

DistributorNetwork

Description

A Distributor network

Fields
Field Name Description
id - ID
corporateAccount - CorporateAccount
Example
{
  "id": "4",
  "corporateAccount": CorporateAccount
}
Types

Document

Description

A document

Fields
Field Name Description
id - ID!
contentType - String
signedUrl - String!
name - String!
displayedName - String
createdAt - DateTime!
documentGenerated - DocumentGenerated Use documentsGenerated
documentsGenerated - [DocumentGenerated]
accountDocuments - [AccountDocument]
documentControl - DocumentControl
Example
{
  "id": 4,
  "contentType": "abc123",
  "signedUrl": "abc123",
  "name": "abc123",
  "displayedName": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "documentGenerated": DocumentGenerated,
  "documentsGenerated": [DocumentGenerated],
  "accountDocuments": [AccountDocument],
  "documentControl": DocumentControl
}
Types

DocumentControl

Description

A document control

Fields
Field Name Description
id - ID!
status - DocumentControlStatusDetailed!
document - Document
vialinkData - Array
complianceControls - [ComplianceControl]
activeComplianceControl - ComplianceControl
Arguments
accountId - ID!
accountLinked - Account
expiresOn - DateTime
signatureDateTime - DateTime
Example
{
  "id": "4",
  "status": DocumentControlStatusDetailed,
  "document": Document,
  "vialinkData": Array,
  "complianceControls": [ComplianceControl],
  "activeComplianceControl": ComplianceControl,
  "accountLinked": Account,
  "expiresOn": "2007-12-03T10:15:30Z",
  "signatureDateTime": "2007-12-03T10:15:30Z"
}
Types

DocumentControlStatus

Values
Enum Value Description

TO_COMPLETE

COMPLETED

VALIDATED

REFUSED

Expired
Example
"TO_COMPLETE"
Types

DocumentControlStatusDetailed

Fields
Field Name Description
code - DocumentControlStatus!
label - String!
Example
{"code": "TO_COMPLETE", "label": "abc123"}
Types

DocumentGenerated

Description

A generated document

Fields
Field Name Description
id - ID!
document - Document
documentTemplate - DocumentTemplate
signatureDateTime - DateTime
yousignSignatureRequestId - String
Example
{
  "id": "4",
  "document": Document,
  "documentTemplate": DocumentTemplate,
  "signatureDateTime": "2007-12-03T10:15:30Z",
  "yousignSignatureRequestId": "abc123"
}
Types

DocumentTemplate

Description

A Document Template

Fields
Field Name Description
id - ID
name - String
localizedName - [LocalizedString]
type - DocumentTypeDetailed
fields - Array
Example
{
  "id": 4,
  "name": "xyz789",
  "localizedName": [LocalizedString],
  "type": DocumentTypeDetailed,
  "fields": Array
}
Types

DocumentType

Values
Enum Value Description

MISSION_LETTER

SUBSCRIPTION_FORM

GENERAL_MEETING_MINUTES

SIGNATURE_CERTIFICATE

ENTERED_INTO_ACCOUNT

TAX_REDUCTION_IR_ATTESTATION

ELIGIBILITY_PEA

ELIGIBILITY_PEAPME

ELIGIBILITY_APPORT_CESSION

INVESTOR_CATEGORIZATION

KYC_DOCUMENT

CESSION_ATTESTATION

DISTRIBUTION_ATTESTATION

TRANSFER_ATTESTATION

CAPITAL_CALL_NOTICE

PAYMENT_ATTESTATION

VESTING_CONTRACT

ADEQUACY_REPORT

Invoice

PledgeAgreement

PledgeReleaseAgreement

GeneralAssemblyConvening

GeneralAssemblyMandate

FUNDS_ORIGIN

Other

PROOF_OF_ADDRESS

COSUBSCRIBER_PROOF_OF_ADDRESS

AUTOMATIC_DEBIT_RIB

DIVIDEND_RIB

DISTRIBUTION_AGREEMENT
Example
"MISSION_LETTER"
Types

DocumentTypeDetailed

Fields
Field Name Description
code - DocumentType!
label - String!
Example
{
  "code": "MISSION_LETTER",
  "label": "xyz789"
}
Types

DocumentVisibilityForInvestor

Fields
Field Name Description
visibleByInvestor - Boolean!
Possible Types
DocumentVisibilityForInvestor Types

AccountDocument

TransactionDocument

TransactionMoneyMovementDocument
Example
{"visibleByInvestor": false}
Types

EffectiveDateState

Values
Enum Value Description

Waiting

Pending

Validated
Example
"Waiting"
Types

EffectiveDateStateDetailed

Fields
Field Name Description
code - EffectiveDateState!
label - String!
Example
{"code": "Waiting", "label": "xyz789"}
Types

EntityName

Values
Enum Value Description

Account

AccountComment

AccountCustomProperty

AccountDocument

AccountDocumentType

AccountDocumentTypeTranslation

AccountKycAdditionalAnswer

AccountMoneyMovement

AccountSecurityContract

AccountSecurityContractDocument

AccountingRecord

ActivitySector

ActivitySectorTranslation

Address

Algorithm

AlgorithmTranslation

AsynchronousOperation

AutomaticDistributionReinvestmentContract

BankAccount

BankAccountCustomProperty

CapitalCall

Cession

City

CmsBlock

CmsBlockTranslation

Communication

CommunicationTranslation

CommunicationDocument

Company

CompanyDocument

ComplianceControl

ConfigurableForm

ConfigurableFormHasStep

ConfigurableFormQuestion

ConfigurableFormQuestionTranslation

ConfigurableFormQuestionEntityProperty

ConfigurableFormQuestionEntityPropertyTranslation

ConfigurableFormStep

ConfigurableFormStepTranslation

Configuration

ConvertibleObligation

CorporateAccount

CorporateInfo

CorporateInfoCustomProperty

Country

CustomExport

DataTable

DataTableColumn

DataTableColumnTranslation

Dismemberment

Distribution

Distributor

DistributorAdvisor

DistributorCustomProperty

DistributorDocumentControl

DistributorNetwork

DmsDocument

Document

DocumentBatch

DocumentBatchIncludedSegment

DocumentControl

DocumentGenerated

DocumentTemplate

DocumentTemplateTranslation

DocumentTemplateAlgorithm

DocumentTemplateContentHtml

DocumentTemplateFillablePdf

EntityProperty

EntityPropertyAddress

EntityPropertyAmount

EntityPropertyBoolean

EntityPropertyChoiceMultiple

EntityPropertyChoiceUnique

EntityPropertyCityEnriched

EntityPropertyCityName

EntityPropertyDate

EntityPropertyDocument

EntityPropertyDocumentToSign

EntityPropertyNumber

EntityPropertyPhone

EntityPropertyRanking

EntityPropertyRankingBacklog

EntityPropertyReferential

EntityPropertyText

Export

ExternalId

FeatureFlag

Fund

FundShare

GeneralAssembly

GeneralAssemblyAccount

GeneralAssemblyResolution

GeneralAssemblyVote

IdempotentCall

IndividualAccount

Investment

InvestmentAdditionalAnswer

InvestmentCustomProperty

InvestorInfo

InvestorInfoCustomProperty

InvestorLoanInfo

InvestorRiskInfo

Invoice

InvoicedAccount

JointAccount

Kpi

LegalInformation

LegalInformationDocumentControl

LegalStatus

LegalStatusTranslation

LogHistory

Menu

MenuItem

MenuItemTranslation

MessageBlock

MessageBlockTranslation

MessageBlockSegment

NotificationType

NotificationTypeTranslation

Obligation

OnboardingImportedId

Operation

OperationDocument

OperationExcludedSegment

OperationFinancingInfo

OperationFinancingInfoTranslation

OperationIncludedSegment

OperationTranslation

PersonalInfo

PersonalInfoCustomProperty

Pledge

PmsSector

PmsSectorTranslation

RecurrenceContract

ReferentialChoice

ReferentialChoiceTranslation

ScpiShare

ScpiShareDismembermentKey

Security

SecurityFee

SecurityFeeConsultancy

SecurityFeeEntry

SecurityFeeManagement

SecurityFeePattern

SecurityFeePatternBase

SecurityFeePatternDistributor

SecurityFeePremiumSubscription

SecurityFeeTranslation

SecurityOperation

SecurityOperationCapitalCall

SecurityOperationCession

SecurityOperationDismemberment

SecurityOperationDistribution

SecurityOperationDocument

SecurityOperationInvestment

SecurityOperationInvestmentExcludedSegment

SecurityOperationInvestmentIncludedSegment

SecurityOperationTransfer

SecurityValue

Segment

Share

Shareholder

ShareholderCustomProperty

ShouldBeNullQuery

Stake

SynchronizationDataBuilder

SynchronizationService

SynchronizationServiceContext

SynchronizationServiceContextDataBuilderLink

Target

ThirdPartySigner

Transaction

TransactionDocument

TransactionFee

TransactionMoneyMovement

TransactionMoneyMovementDocument

TransactionNumbering

TransactionSecurity

Transfer

User

UserAccountPermission

UserSegment

Vehicle

VialinkControl

VirtualIban
Example
"Account"
Types

EntityNameDetailed

Fields
Field Name Description
code - EntityName!
label - String!
Example
{"code": "Account", "label": "abc123"}
Types

EntityProperty

Description

Custom properties for this entity

Fields
Field Name Description
id - ID!
type - EntityPropertyTypeDetailed!
entityName - EntityNameDetailed!
technicalCode - String!
code - String! Use technicalCode
name - String!
dataStrategy - EntityPropertyDataStrategyDetailed!
dataStrategyDefinition - String
createdBy - String!
createdAt - DateTime!
editable - Boolean!
specificTreatment - EntityPropertySpecificTreatmentDetailed
Example
{
  "id": "4",
  "type": EntityPropertyTypeDetailed,
  "entityName": EntityNameDetailed,
  "technicalCode": "abc123",
  "code": "abc123",
  "name": "xyz789",
  "dataStrategy": EntityPropertyDataStrategyDetailed,
  "dataStrategyDefinition": "abc123",
  "createdBy": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "editable": true,
  "specificTreatment": EntityPropertySpecificTreatmentDetailed
}
Types

EntityPropertyDataStrategy

Values
Enum Value Description

ExistingField

CustomProperty
Example
"ExistingField"
Types

EntityPropertyDataStrategyDetailed

Fields
Field Name Description
code - EntityPropertyDataStrategy!
label - String!
Example
{"code": "ExistingField", "label": "xyz789"}
Types

EntityPropertySpecificTreatment

Values
Enum Value Description

InvestmentAmountRecompute
Example
"InvestmentAmountRecompute"
Types

EntityPropertySpecificTreatmentDetailed

Fields
Field Name Description
code - EntityPropertySpecificTreatment!
Example
{"code": "InvestmentAmountRecompute"}
Types

EntityPropertyType

Values
Enum Value Description

Text

Boolean

Number

Amount

Date

Address

ChoiceUnique

ChoiceMultiple

Document

Phone

Ranking

RankingBacklog

CityName

CityEnriched

DocumentToSign
Example
"Text"
Types

EntityPropertyTypeDetailed

Fields
Field Name Description
code - EntityPropertyType!
label - String!
Example
{"code": "Text", "label": "abc123"}
Types

FeatureFlag

Fields
Field Name Description
id - FeatureFlagId!
name - String!
description - String!
enabled - Boolean!
Example
{
  "id": "FEATURE_2FA_ADMIN_REQUIRED",
  "name": "abc123",
  "description": "xyz789",
  "enabled": false
}
Types

FeatureFlagId

Values
Enum Value Description

FEATURE_2FA_ADMIN_REQUIRED

FEATURE_2FA_USERS_REQUIRED

FEATURE_CAN_CHOOSE_SECURITY_OPERATION_INVESTMENT

FEATURE_CAN_PUBLICLY_CREATE_ACTIVE_USERS

FEATURE_CAN_PUBLICLY_CREATE_USERS

FEATURE_KYC_ANALYZER_VIALINK

FEATURE_RISK

FEATURE_SCPI

FEATURE_FEES_STRUCTURE

FEATURE_FEES_PATTERNS

FEATURE_SELF_BILLING

FEATURE_JOINT_ACCOUNT

FeatureCorporateAsRepresentative

FeatureDisplayKycToFinalizeAlert

FeatureDisplayKydToFinalizeAlert

FeatureGotenberg

FEATURE_LOCALE_CHOSER

FeatureDismembermentOperation

FeatureFlowMatchingMemobank

FeatureI18nAdmin

FeatureVascopilotAdmin

FeatureVascopilotDistributor

FeatureVascopilotInvestor

FeatureLoginLink

FeatureComplexDistributionExtractorVariables

FeatureComplexCapitalCallExtractorVariables

FeatureShowTimezones

FeatureKycReviewBeforeSignature

FeatureFirstKycSignerNotifiedByEmail

FeatureFirstInvestmentSignerNotifiedByEmail

MODULE_AUTOMATIC_FLOW_MATCHING

MODULE_DASHBOARD_AND_CONTROL_PANELS

MODULE_DEALFLOW_MANAGMENT

MODULE_DIGITAL_SUBSCRIPTION

MODULE_INTERMEDIATED_INVESTMENT

MODULE_KYC_LCB_FT

MODULE_PORTFOLIO_MANAGMENT_SYSTEM

MODULE_REPORTING_SCHEDULE_AG

MODULE_SECURITY_OPERATIONS

MODULE_SI_TOOLS_CONNECTION

MODULE_VEHICLES_AND_INSTRUMENT_MANAGMENT

ModuleGeneralAssembly

MigrationExposeAdditionalAnswer

MigrationAgGridDocuments

MigrationAccountNN

TEST
Example
"FEATURE_2FA_ADMIN_REQUIRED"
Types

FeeCalculationBasis

Values
Enum Value Description

AmountSubscribed

MaturityValuation
Example
"AmountSubscribed"
Types

FeeCalculationBasisDetailed

Fields
Field Name Description
code - FeeCalculationBasis!
label - String!
Example
{
  "code": "AmountSubscribed",
  "label": "abc123"
}
Types

FeeCalculationPeriodicity

Values
Enum Value Description

Once

Monthly

Quarterly

Biannual

Annual
Example
"Once"
Types

FeeCalculationPeriodicityDetailed

Fields
Field Name Description
code - FeeCalculationPeriodicity!
label - String!
Example
{"code": "Once", "label": "abc123"}
Types

FeeCalculationType

Values
Enum Value Description

OnTop

Included
Example
"OnTop"
Types

FeeCalculationTypeDetailed

Fields
Field Name Description
code - FeeCalculationType!
label - String!
Example
{"code": "OnTop", "label": "abc123"}
Types

FeeType

Values
Enum Value Description

CONSULTANCY_FEES

ENTRY_FEES

MANAGEMENT_FEES

PREMIUM_SUBSCRIPTION_FEES
Example
"CONSULTANCY_FEES"
Types

FeeTypeDetailed

Fields
Field Name Description
code - FeeType!
label - String!
Example
{
  "code": "CONSULTANCY_FEES",
  "label": "xyz789"
}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

FormQuestionDataNormalizer

Values
Enum Value Description

Noop

Value

Address

DocumentControlUploadedFile

DocumentUploadedFile

Shareholders

Entity
Example
"Noop"
Types

FormQuestionDataNormalizerDetailed

Fields
Field Name Description
code - FormQuestionDataNormalizer!
label - String!
Example
{"code": "Noop", "label": "xyz789"}
Types

FormQuestionDataStrategy

Values
Enum Value Description

Noop

ExistingField

ExpressionLanguage

AccountKycAdditionalAnswer

InvestmentAdditionalAnswer

InvestmentAmountRecompute

TransactionDocument

DocumentsToSign

EntityProperty
Example
"Noop"
Types

FormQuestionDataStrategyDefinition

Values
Enum Value Description

CorporateInfo

RepresentativeLegalInfo

Distributor

InvestorInfo

PersonalInfo

SecondPersonalInfo

SignerPersonalInfo

Account

Investment

BankAccountCreditTransfer

BankAccountDirectDebit

BankAccountRetrocessionDebit

BankAccountPea

BankAccountPeaPme
Example
"CorporateInfo"
Types

FormQuestionDataStrategyDefinitionDetailed

Fields
Field Name Description
code - FormQuestionDataStrategyDefinition!
label - String!
Example
{"code": "CorporateInfo", "label": "xyz789"}
Types

FormQuestionDataStrategyDetailed

Fields
Field Name Description
code - FormQuestionDataStrategy!
label - String!
Example
{"code": "Noop", "label": "abc123"}
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
4
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

Investment

Fields
Field Name Description
id - ID
type - TransactionType! Use transactionType instead
transactionType - TransactionTypeDetailed!
securitiesNumber - Float!
unpledgedSecuritiesNumber - Float!
transactionDocuments - [TransactionDocument]
transactionMoneyMovement - TransactionMoneyMovement
transactionFees - [TransactionFee]
priceBySecurity - Float!
amount - Amount!
rawAmount - Amount!
securityOperation - SecurityOperationInvestment! Use transactionSecurity.securityOperation
transactionSecurity - TransactionSecurity
fromAccount - Account
toAccount - Account
transactionNumberings - [TransactionNumbering]
dismembermentType - DismembermentTypeDetailed
documentsZipFileUrl - String! URL to download the zip file containing all transaction documents. Only for Investments and CapitalCalls
effectiveDate - Date
effectiveDateState - EffectiveDateStateDetailed
actualDismembermentType - DismembermentType Use investmentActualDismembermentType instead
investmentActualDismembermentType - DismembermentTypeDetailed
dismembermentDurationInYears - Int
dismembermentEndAt - Date
valuationDiscount - Float
initialAmountWithoutOnTopFees - Amount!
initialAmount - Amount!
hasCoSigner - Boolean
capitalCallPercentage - Float
signed - Boolean!
distributedByAdvisor - DistributorAdvisor
distributedToAccountLabel - String
signatureDate - Date
signersStatuses - [SignerStatus!]!
reference - String
status - TransactionState! Use investmentStatus instead
investmentStatus - TransactionStateDetailed!
yousignSignatureRequestId - String
taxationType - TaxationType Use taxationTypeDetailed
taxationTypeDetailed - TaxationTypeDetailed
taxationAccountNumber - String
subscriptionStep - SubscriptionStep
modalitiesStep - ConfigurableFormStep
interestDate - Date
paymentInformation - PaymentInformation
signatureLink - SignatureLink The link provided has an expiration. Ask it just before giving it to the end user
customProperties - [InvestmentCustomProperty]
distributorBankAccountStatus - BankAccountStatusDetailed!
operation - Operation
investorAcceptedRiskAtSignDate - Int
issuerSrriAtSignDate - Int
adequate - Boolean
createdAt - DateTime!
source - InvestmentSourceDetailed
possessedSecuritiesNumber - Float
securityFeePattern - SecurityFeePattern
canUpdateAmount - Boolean!
modalitiesStatusDetailed - InvestmentModalitiesStatusDetailed!
modalitiesRefusedComment - String
validationDate - Date
hasSubscriptionPackBeenReset - Boolean!
Example
{
  "id": "4",
  "type": "INVESTMENT",
  "transactionType": TransactionTypeDetailed,
  "securitiesNumber": 987.65,
  "unpledgedSecuritiesNumber": 123.45,
  "transactionDocuments": [TransactionDocument],
  "transactionMoneyMovement": TransactionMoneyMovement,
  "transactionFees": [TransactionFee],
  "priceBySecurity": 987.65,
  "amount": Amount,
  "rawAmount": Amount,
  "securityOperation": SecurityOperationInvestment,
  "transactionSecurity": TransactionSecurity,
  "fromAccount": Account,
  "toAccount": Account,
  "transactionNumberings": [TransactionNumbering],
  "dismembermentType": DismembermentTypeDetailed,
  "documentsZipFileUrl": "abc123",
  "effectiveDate": "2007-12-03",
  "effectiveDateState": EffectiveDateStateDetailed,
  "actualDismembermentType": "FullOwnership",
  "investmentActualDismembermentType": DismembermentTypeDetailed,
  "dismembermentDurationInYears": 987,
  "dismembermentEndAt": "2007-12-03",
  "valuationDiscount": 987.65,
  "initialAmountWithoutOnTopFees": Amount,
  "initialAmount": Amount,
  "hasCoSigner": true,
  "capitalCallPercentage": 123.45,
  "signed": true,
  "distributedByAdvisor": DistributorAdvisor,
  "distributedToAccountLabel": "abc123",
  "signatureDate": "2007-12-03",
  "signersStatuses": [SignerStatus],
  "reference": "abc123",
  "status": "ExportedPayment",
  "investmentStatus": TransactionStateDetailed,
  "yousignSignatureRequestId": "abc123",
  "taxationType": "PEA",
  "taxationTypeDetailed": TaxationTypeDetailed,
  "taxationAccountNumber": "xyz789",
  "subscriptionStep": "Account",
  "modalitiesStep": ConfigurableFormStep,
  "interestDate": "2007-12-03",
  "paymentInformation": PaymentInformation,
  "signatureLink": SignatureLink,
  "customProperties": [InvestmentCustomProperty],
  "distributorBankAccountStatus": BankAccountStatusDetailed,
  "operation": Operation,
  "investorAcceptedRiskAtSignDate": 123,
  "issuerSrriAtSignDate": 123,
  "adequate": false,
  "createdAt": "2007-12-03T10:15:30Z",
  "source": InvestmentSourceDetailed,
  "possessedSecuritiesNumber": 987.65,
  "securityFeePattern": SecurityFeePattern,
  "canUpdateAmount": false,
  "modalitiesStatusDetailed": InvestmentModalitiesStatusDetailed,
  "modalitiesRefusedComment": "abc123",
  "validationDate": "2007-12-03",
  "hasSubscriptionPackBeenReset": false
}
Types

InvestmentCustomProperty

Fields
Field Name Description
entityProperty - EntityProperty!
value - Array
Example
{
  "entityProperty": EntityProperty,
  "value": Array
}
Types

InvestmentModalitiesStatus

Values
Enum Value Description

ToComplete

Validated

Completed

Refused
Example
"ToComplete"
Types

InvestmentModalitiesStatusDetailed

Fields
Field Name Description
code - InvestmentModalitiesStatus!
label - String!
Example
{"code": "ToComplete", "label": "xyz789"}
Types

InvestmentSource

Values
Enum Value Description

ExternalApi

Admin

DistributionReinvestment

Distributor

Import

Investor

ScheduledSubscription
Example
"ExternalApi"
Types

InvestmentSourceDetailed

Fields
Field Name Description
code - InvestmentSource!
label - String!
Example
{"code": "ExternalApi", "label": "xyz789"}
Types

InvestorInfo

Description

An Investor info

Fields
Field Name Description
id - ID!
lcbftLevel - LcbftLevelDetailed
specificRelationship - Boolean!
relationshipComment - String
relationshipRisk - LcbftLevelDetailed
customProperties - [InvestorInfoCustomProperty]
Example
{
  "id": 4,
  "lcbftLevel": LcbftLevelDetailed,
  "specificRelationship": false,
  "relationshipComment": "abc123",
  "relationshipRisk": LcbftLevelDetailed,
  "customProperties": [InvestorInfoCustomProperty]
}
Types

InvestorInfoCustomProperty

Fields
Field Name Description
entityProperty - EntityProperty!
value - Array
Example
{
  "entityProperty": EntityProperty,
  "value": Array
}
Types

Invoice

Fields
Field Name Description
id - ID!
number - String!
issueDate - Date!
subject - String!
invoicerAccount - Account!
invoicer - Array!
invoicedAccount - Account!
invoiced - Array!
documentGenerated - DocumentGenerated
transactionFees - [TransactionFee]!
transactionMoneyMovement - TransactionMoneyMovement
amountAte - Amount!
amountAti - Amount!
Example
{
  "id": "4",
  "number": "abc123",
  "issueDate": "2007-12-03",
  "subject": "xyz789",
  "invoicerAccount": Account,
  "invoicer": Array,
  "invoicedAccount": Account,
  "invoiced": Array,
  "documentGenerated": DocumentGenerated,
  "transactionFees": [TransactionFee],
  "transactionMoneyMovement": TransactionMoneyMovement,
  "amountAte": Amount,
  "amountAti": Amount
}
Types

IssuerCompany

Description

A public representation of a company

Fields
Field Name Description
id - ID!
label - String!
Example
{
  "id": "4",
  "label": "xyz789"
}
Types

Kpi

Fields
Field Name Description
id - ID!
label - String!
unit - String!
Example
{
  "id": 4,
  "label": "xyz789",
  "unit": "abc123"
}
Types

KpiValue

Fields
Field Name Description
kpi - Kpi!
value - Any
Example
{"kpi": Kpi, "value": Any}
Types

KycStatus

Values
Enum Value Description

TO_COMPLETE

COMPLETED

VALIDATED

REFUSED

Expired
Example
"TO_COMPLETE"
Types

KycStatusDetailed

Fields
Field Name Description
code - KycStatus!
label - String!
Example
{"code": "TO_COMPLETE", "label": "xyz789"}
Types

LabelValue

Fields
Field Name Description
label - String!
value - String!
Example
{
  "label": "abc123",
  "value": "xyz789"
}
Types

LcbftLevel

Values
Enum Value Description

MINIMUM_RISK

LOW_RISK

MEDIUM_RISK

HIGH_RISK

MAXIMUM_RISK
Example
"MINIMUM_RISK"
Types

LcbftLevelDetailed

Fields
Field Name Description
code - LcbftLevel!
label - String!
Example
{"code": "MINIMUM_RISK", "label": "abc123"}
Types

LegalInfo

Fields
Field Name Description
id - ID!
address - Address
Possible Types
LegalInfo Types

CorporateInfo
Example
{
  "id": "4",
  "address": Address
}
Types

LegalStatus

Fields
Field Name Description
id - ID!
label - String!
isFund - Boolean!
isPersonal - Boolean!
isDisplayed - Boolean!
Example
{
  "id": "4",
  "label": "xyz789",
  "isFund": true,
  "isPersonal": true,
  "isDisplayed": false
}
Types

LocalizedOperationFinancingInfoIndicator

Fields
Field Name Description
locale - SupportedLocale!
value - [OperationFinancingInfoIndicator]
Example
{
  "locale": "fr_FR",
  "value": [OperationFinancingInfoIndicator]
}
Types

LocalizedString

Fields
Field Name Description
locale - SupportedLocale!
value - String!
Example
{"locale": "fr_FR", "value": "xyz789"}
Types

MessageBlock

Fields
Field Name Description
id - ID!
content - String
localizedContent - [LocalizedString]!
enabled - Boolean!
displayConditions - [MessageBlockDisplayCondition]!
segments - [Segment]
Example
{
  "id": "4",
  "content": "abc123",
  "localizedContent": [LocalizedString],
  "enabled": false,
  "displayConditions": ["NoOperation"],
  "segments": [Segment]
}
Types

MessageBlockDisplayCondition

Values
Enum Value Description

NoOperation

HasOperation
Example
"NoOperation"
Types

Mixed

Example
Mixed
Types

NewUserAccountInformationInput

Fields
Input Field Description
firstAccountType - AccountType!
corporateAccountInformation - NewUserCorporateAccountInput
jointAccountInformation - NewUserJointAccountInput
Example
{
  "firstAccountType": "IndividualAccount",
  "corporateAccountInformation": NewUserCorporateAccountInput,
  "jointAccountInformation": NewUserJointAccountInput
}
Types

NewUserCorporateAccountInput

Fields
Input Field Description
corporateName - String!
representative - CompanyCorporateAccountRepresentativeInput!
Example
{
  "corporateName": "abc123",
  "representative": CompanyCorporateAccountRepresentativeInput
}
Types

NewUserJointAccountInput

Fields
Input Field Description
secondaryFirstName - String!
secondaryLastName - String!
secondaryEmail - String!
secondaryMobile - String!
Example
{
  "secondaryFirstName": "abc123",
  "secondaryLastName": "xyz789",
  "secondaryEmail": "xyz789",
  "secondaryMobile": "xyz789"
}
Types

Operation

Description

An Operation

Fields
Field Name Description
id - ID!
name - String!
state - OperationStateDetailed!
operationFinancingInfo - OperationFinancingInfo!
operationDocuments - [OperationDocument]
collectedAmount - Amount!
description - String
descriptionState - OperationDescriptionState Use operationDescriptionState instead
localizedDescription - [LocalizedString]
operationDescriptionState - OperationDescriptionStateDetailed
thumbnail - Document
subscriptionSignedByDistributor - Boolean
securityOperationInvestmentWithoutDocuments - Boolean!
securityOperationInvestments - [SecurityOperationInvestment]
openedSecurityOperationInvestmentsSimpleSubscription - [SecurityOperationInvestment]
openedSecurityOperationInvestments - [SecurityOperationInvestment]
kycStatusForSignature - KycStatus
openedToCosubscription - Boolean
subscriptionSignedByThirdParty - Boolean!
subscriptionSignerThirdPartyFirstName - String
subscriptionSignerThirdPartyLastName - String
subscriptionSignerThirdPartyEmail - String
subscriptionSignerThirdPartyMobile - String
subscriptionSignedBySecondThirdParty - Boolean!
subscriptionSignerSecondThirdPartyFirstName - String
subscriptionSignerSecondThirdPartyLastName - String
subscriptionSignerSecondThirdPartyEmail - String
subscriptionSignerSecondThirdPartyMobile - String
subscriptionForm - ConfigurableForm Use modalitiesForm
modalitiesForm - ConfigurableForm
hasModalitiesForm - Boolean!
hasConsultancyFees - Boolean!
kpiValues - [KpiValue]
needsValidation - Boolean
subscribedAtUnknownNav - Boolean!
includedSegments - [OperationIncludedSegment]
excludedSegments - [OperationExcludedSegment]
preferredSignatureMethod - SignatureMethodDetailed
alternativeSignatureMethods - [SignatureMethodDetailed]
Example
{
  "id": "4",
  "name": "xyz789",
  "state": OperationStateDetailed,
  "operationFinancingInfo": OperationFinancingInfo,
  "operationDocuments": [OperationDocument],
  "collectedAmount": Amount,
  "description": "xyz789",
  "descriptionState": "Hidden",
  "localizedDescription": [LocalizedString],
  "operationDescriptionState": OperationDescriptionStateDetailed,
  "thumbnail": Document,
  "subscriptionSignedByDistributor": true,
  "securityOperationInvestmentWithoutDocuments": true,
  "securityOperationInvestments": [
    SecurityOperationInvestment
  ],
  "openedSecurityOperationInvestmentsSimpleSubscription": [
    SecurityOperationInvestment
  ],
  "openedSecurityOperationInvestments": [
    SecurityOperationInvestment
  ],
  "kycStatusForSignature": "TO_COMPLETE",
  "openedToCosubscription": true,
  "subscriptionSignedByThirdParty": true,
  "subscriptionSignerThirdPartyFirstName": "abc123",
  "subscriptionSignerThirdPartyLastName": "abc123",
  "subscriptionSignerThirdPartyEmail": "abc123",
  "subscriptionSignerThirdPartyMobile": "abc123",
  "subscriptionSignedBySecondThirdParty": false,
  "subscriptionSignerSecondThirdPartyFirstName": "xyz789",
  "subscriptionSignerSecondThirdPartyLastName": "abc123",
  "subscriptionSignerSecondThirdPartyEmail": "abc123",
  "subscriptionSignerSecondThirdPartyMobile": "xyz789",
  "subscriptionForm": ConfigurableForm,
  "modalitiesForm": ConfigurableForm,
  "hasModalitiesForm": true,
  "hasConsultancyFees": true,
  "kpiValues": [KpiValue],
  "needsValidation": true,
  "subscribedAtUnknownNav": true,
  "includedSegments": [OperationIncludedSegment],
  "excludedSegments": [OperationExcludedSegment],
  "preferredSignatureMethod": SignatureMethodDetailed,
  "alternativeSignatureMethods": [SignatureMethodDetailed]
}
Types

OperationDescriptionState

Values
Enum Value Description

Hidden

Visible
Example
"Hidden"
Types

OperationDescriptionStateDetailed

Fields
Field Name Description
code - OperationDescriptionState!
label - String!
Example
{"code": "Hidden", "label": "xyz789"}
Types

OperationDocument

Fields
Field Name Description
id - ID!
document - Document
Example
{
  "id": "4",
  "document": Document
}
Types

OperationExcludedSegment

Description

An Operation excluded Segment

Fields
Field Name Description
id - ID!
operation - Operation!
segment - Segment!
Example
{
  "id": 4,
  "operation": Operation,
  "segment": Segment
}
Types

OperationFinancingInfo

Description

An Operation Financing Info

Fields
Field Name Description
id - ID!
type - OperationType!
operationType - OperationTypeDetailed!
issuer - Company!
targetAmount - Amount!
issuedSecurities - Int!
taxation - [String]
indicators - [LabelValue]
localizedIndicators - [LocalizedOperationFinancingInfoIndicator]
minimumSubscriptionAmount - Amount! Compute the minimum subscription upon specified user, account or on general basis
Arguments
accountId - ID
userId - ID
paymentMethods - [PaymentMethod]
bankWireReference - String
urmReference - String
checkOrder - String
bankAccount - BankAccount
operation - Operation!
Example
{
  "id": 4,
  "type": "ACTIF_DE_FONCIERE",
  "operationType": OperationTypeDetailed,
  "issuer": Company,
  "targetAmount": Amount,
  "issuedSecurities": 987,
  "taxation": ["xyz789"],
  "indicators": [LabelValue],
  "localizedIndicators": [
    LocalizedOperationFinancingInfoIndicator
  ],
  "minimumSubscriptionAmount": Amount,
  "paymentMethods": ["CreditTransfer"],
  "bankWireReference": "xyz789",
  "urmReference": "xyz789",
  "checkOrder": "xyz789",
  "bankAccount": BankAccount,
  "operation": Operation
}
Types

OperationFinancingInfoIndicator

Fields
Field Name Description
label - String!
value - String!
Example
{
  "label": "xyz789",
  "value": "abc123"
}
Types

OperationIncludedSegment

Description

An Operation included Segment

Fields
Field Name Description
id - ID!
operation - Operation!
segment - Segment!
Example
{
  "id": "4",
  "operation": Operation,
  "segment": Segment
}
Types

OperationState

Values
Enum Value Description

BEFORE_LAUNCH

PRE_SUBSCRIPTION_OPENED

SUBSCRIPTION_OPEN

SUBSCRIPTION_ENDED
Example
"BEFORE_LAUNCH"
Types

OperationStateDetailed

Fields
Field Name Description
code - OperationState!
label - String!
Example
{"code": "BEFORE_LAUNCH", "label": "xyz789"}
Types

OperationType

Values
Enum Value Description

ACTIF_DE_FONCIERE

ASSURANCE_VIE_FRANCAISE

ASSURANCE_VIE_LUXEMBOURGEOISE

CLUB_DEAL_IMMOBILIER

CLUB_DEAL_VC

FOND_INVESTISSEMENT

MARCHE_SECONDAIRE

SCPI
Example
"ACTIF_DE_FONCIERE"
Types

OperationTypeDetailed

Fields
Field Name Description
code - OperationType!
label - String!
Example
{
  "code": "ACTIF_DE_FONCIERE",
  "label": "xyz789"
}
Types

PageInfo

Description

Information about pagination in a connection.

Fields
Field Name Description
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
startCursor - String When paginating backwards, the cursor to continue.
endCursor - String When paginating forwards, the cursor to continue.
Example
{
  "hasNextPage": true,
  "hasPreviousPage": true,
  "startCursor": "abc123",
  "endCursor": "abc123"
}
Types

PasswordToken

Fields
Field Name Description
token - ID! The request password token
needTosAcknowledged - Boolean! The terms of service must be acknowledged
Example
{"token": 4, "needTosAcknowledged": false}
Types

PaymentInformation

Fields
Field Name Description
paymentMethod - PaymentMethod
paymentMethodDetailed - PaymentMethodDetailed
Example
{
  "paymentMethod": "CreditTransfer",
  "paymentMethodDetailed": PaymentMethodDetailed
}
Types

PaymentMethod

Values
Enum Value Description

CreditTransfer

DirectDebit

BankCheck
Example
"CreditTransfer"
Types

PaymentMethodDetailed

Fields
Field Name Description
code - PaymentMethod!
label - String!
Example
{
  "code": "CreditTransfer",
  "label": "xyz789"
}
Types

Persona

Values
Enum Value Description

ADMIN

CUSTOMER

DISTRIBUTOR

DistributorAdvisor

DistributorNetwork

DISTRIBUTED_CUSTOMER

HYPER_ADMIN

SUPER_ADMIN
Example
"ADMIN"
Types

PersonaDetailed

Fields
Field Name Description
code - Persona!
label - String!
isAdmin - Boolean!
isDistributorAdvisor - Boolean!
isDistributor - Boolean!
isDistributorNetwork - Boolean!
isVasco - Boolean!
isCustomer - Boolean!
isDistributedCustomer - Boolean!
Example
{
  "code": "ADMIN",
  "label": "xyz789",
  "isAdmin": true,
  "isDistributorAdvisor": false,
  "isDistributor": true,
  "isDistributorNetwork": false,
  "isVasco": true,
  "isCustomer": false,
  "isDistributedCustomer": false
}
Types

Pledge

Fields
Field Name Description
id - ID!
transaction - Transaction!
security - Security!
securityTypeDetailed - SecurityTypeDetailed!
numberingStart - Float!
numberingEnd - Float!
securitiesNumber - Float!
status - PledgeStateDetailed!
numberOfDecimals - Int
bankName - String
bankAddress - Address
agreementDocument - Document
releaseDocument - Document
startDate - Date
initialEndDate - Date
actualEndDate - Date
Example
{
  "id": "4",
  "transaction": Transaction,
  "security": Security,
  "securityTypeDetailed": SecurityTypeDetailed,
  "numberingStart": 123.45,
  "numberingEnd": 987.65,
  "securitiesNumber": 987.65,
  "status": PledgeStateDetailed,
  "numberOfDecimals": 123,
  "bankName": "xyz789",
  "bankAddress": Address,
  "agreementDocument": Document,
  "releaseDocument": Document,
  "startDate": "2007-12-03",
  "initialEndDate": "2007-12-03",
  "actualEndDate": "2007-12-03"
}
Types

PledgeState

Values
Enum Value Description

Pending

Active

Released
Example
"Pending"
Types

PledgeStateDetailed

Fields
Field Name Description
code - PledgeState!
label - String!
Example
{"code": "Pending", "label": "abc123"}
Types

PmsSector

Fields
Field Name Description
id - ID!
label - String!
isDisplayed - Boolean!
Example
{
  "id": "4",
  "label": "abc123",
  "isDisplayed": true
}
Types

Portfolio

Description

A Portfolio

Fields
Field Name Description
pending - [PortfolioPendingTransaction]
active - [ActiveParticipation]
sold - [SoldParticipation]
pendingParticipationsKpisValues - [KpiValue]
Arguments
datatableTechnicalCode - String
additionalData - Array
activeParticipationsKpisValues - [KpiValue]
Arguments
datatableTechnicalCode - String
additionalData - Array
soldParticipationsKpisValues - [KpiValue]
Arguments
datatableTechnicalCode - String
additionalData - Array
Example
{
  "pending": [PortfolioPendingTransaction],
  "active": [ActiveParticipation],
  "sold": [SoldParticipation],
  "pendingParticipationsKpisValues": [KpiValue],
  "activeParticipationsKpisValues": [KpiValue],
  "soldParticipationsKpisValues": [KpiValue]
}
Types

PortfolioPendingTransaction

Description

A Portfolio Pending Transaction

Fields
Field Name Description
id - ID
lastOperation - Operation
issuerId - String
issuerName - String
issuerLogo - Document
investedCapital - Amount
subscriptionDateTime - DateTime
paymentDateTime - DateTime
calledCapitalAmount - Amount
remainingToBeCalledAmount - Amount
transactionState - TransactionState
percentageOwned - Float
lastValue - Amount!
effectiveDate - DateTime
account - Account
remainingSecuritiesCount - Float
security - Security!
Example
{
  "id": "4",
  "lastOperation": Operation,
  "issuerId": "xyz789",
  "issuerName": "xyz789",
  "issuerLogo": Document,
  "investedCapital": Amount,
  "subscriptionDateTime": "2007-12-03T10:15:30Z",
  "paymentDateTime": "2007-12-03T10:15:30Z",
  "calledCapitalAmount": Amount,
  "remainingToBeCalledAmount": Amount,
  "transactionState": "ExportedPayment",
  "percentageOwned": 987.65,
  "lastValue": Amount,
  "effectiveDate": "2007-12-03T10:15:30Z",
  "account": Account,
  "remainingSecuritiesCount": 987.65,
  "security": Security
}
Types

PreciseAmount

Example
PreciseAmount
Types

ProviderType

Values
Enum Value Description

MemoBank
Example
"MemoBank"
Types

ProviderTypeDetailed

Fields
Field Name Description
code - ProviderType!
label - String!
Example
{"code": "MemoBank", "label": "xyz789"}
Types

RemainingParticipation

Fields
Field Name Description
id - ID!
account - Account!
remainingSecurities - Float!
cumulatedSecuritiesNumber - Float The cumulated value is available only when remaining participations are not filtered
firstPaymentDate - Date!
firstEffectiveDate - Date!
Example
{
  "id": 4,
  "account": Account,
  "remainingSecurities": 123.45,
  "cumulatedSecuritiesNumber": 123.45,
  "firstPaymentDate": "2007-12-03",
  "firstEffectiveDate": "2007-12-03"
}
Types

RemainingParticipationConnection

Description

A connection to a list of items.

Fields
Field Name Description
totalCount - Int!
pageInfo - PageInfo! Information to aid in pagination.
edges - [RemainingParticipationEdge] Information to aid in pagination.
Example
{
  "totalCount": 987,
  "pageInfo": PageInfo,
  "edges": [RemainingParticipationEdge]
}
Types

RemainingParticipationEdge

Description

An edge in a connection.

Fields
Field Name Description
node - RemainingParticipation The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": RemainingParticipation,
  "cursor": "abc123"
}
Types

ResetPasswordSucceed

Fields
Field Name Description
token - String JWT token to authenticate the user just after the password reset
Example
{"token": "abc123"}
Types

RetrocessionState

Values
Enum Value Description

Paid

InvoiceGenerated

ToInvoice

NoEffectiveDate
Example
"Paid"
Types

RetrocessionStateDetailed

Fields
Field Name Description
code - RetrocessionState!
label - String!
Example
{"code": "Paid", "label": "xyz789"}
Types

Security

Description

A Security

Fields
Field Name Description
id - ID!
type - SecurityType!
securityType - SecurityType! Use type
securityTypeDetailed - SecurityTypeDetailed!
name - String!
stakes - [Stake]!
company - Company!
nominalValue - Amount!
distributionPeriodicity - DistributionPeriodicityDetailed!
securityFeePatterns - [SecurityFeePattern!]!
defaultSecurityFeePattern - SecurityFeePattern
numberOfDecimals - Float!
latestValue - SecurityValue
remainingParticipations - RemainingParticipationConnection
Arguments
resultsPerPage - Int
page - Int
search - String

Term to search in id, firstname, lastname, email or mobile

excludeUsufruct - Boolean

Flag to define whether the usufruct participations should be returned or not
securityValues - [SecurityValue]
engagedInvestmentAmount - Amount
movements - TransactionMoneyMovementConnection
Arguments
resultsPerPage - Int
page - Int
transactionTypes - [TransactionType!]
search - String

Term to search in id, firstname, lastname, email or mobile

sortingFields - [SortingField]
Example
{
  "id": 4,
  "type": "OBLIGATION",
  "securityType": "OBLIGATION",
  "securityTypeDetailed": SecurityTypeDetailed,
  "name": "xyz789",
  "stakes": [Stake],
  "company": Company,
  "nominalValue": Amount,
  "distributionPeriodicity": DistributionPeriodicityDetailed,
  "securityFeePatterns": [SecurityFeePattern],
  "defaultSecurityFeePattern": SecurityFeePattern,
  "numberOfDecimals": 987.65,
  "latestValue": SecurityValue,
  "remainingParticipations": RemainingParticipationConnection,
  "securityValues": [SecurityValue],
  "engagedInvestmentAmount": Amount,
  "movements": TransactionMoneyMovementConnection
}
Types

SecurityFee

Fields
Field Name Description
id - ID!
securityFeePattern - SecurityFeePattern!
type - String!
feeType - FeeTypeDetailed!
label - String!
name - String!
localizedName - [LocalizedString]!
calculationType - FeeCalculationTypeDetailed
calculationBasis - FeeCalculationBasisDetailed
calculationPeriodicity - FeeCalculationPeriodicityDetailed
Example
{
  "id": 4,
  "securityFeePattern": SecurityFeePattern,
  "type": "abc123",
  "feeType": FeeTypeDetailed,
  "label": "xyz789",
  "name": "abc123",
  "localizedName": [LocalizedString],
  "calculationType": FeeCalculationTypeDetailed,
  "calculationBasis": FeeCalculationBasisDetailed,
  "calculationPeriodicity": FeeCalculationPeriodicityDetailed
}
Types

SecurityFeePattern

Fields
Field Name Description
id - ID!
name - String!
securityFees - [SecurityFee]!
security - Security!
isDefault - Boolean!
isDeleted - Boolean!
Example
{
  "id": 4,
  "name": "xyz789",
  "securityFees": [SecurityFee],
  "security": Security,
  "isDefault": true,
  "isDeleted": false
}
Types

SecurityOperation

Description

A Security Operation

Fields
Field Name Description
id - ID!
securityOperationDocuments - [SecurityOperationDocument]
name - String
status - SecurityOperationStatus Use securityOperationStatus instead
securityOperationStatus - SecurityOperationStatusDetailed
type - SecurityOperationType!
securityOperationType - SecurityOperationTypeDetailed!
transactions - TransactionConnection
Arguments
resultsPerPage - Int
page - Int
search - String
moneyMovements - TransactionMoneyMovementConnection
Arguments
resultsPerPage - Int
page - Int
search - String
filter - TransactionMoneyMovementFiltersInput
kpiValues - [KpiValue]
asynchronousOperations - [AsynchronousOperation]
Possible Types
SecurityOperation Types

SecurityOperationInvestment
Example
{
  "id": 4,
  "securityOperationDocuments": [
    SecurityOperationDocument
  ],
  "name": "abc123",
  "status": "Opened",
  "securityOperationStatus": SecurityOperationStatusDetailed,
  "type": "SecurityOperationInvestment",
  "securityOperationType": SecurityOperationTypeDetailed,
  "transactions": TransactionConnection,
  "moneyMovements": TransactionMoneyMovementConnection,
  "kpiValues": [KpiValue],
  "asynchronousOperations": [AsynchronousOperation]
}
Types

SecurityOperationDocument

Description

A Security Operation Document

Fields
Field Name Description
id - ID
documentFilterAlgorithm - Algorithm
documentTemplate - DocumentTemplate
generationTrigger - SecurityOperationDocumentGenerationTrigger!
securityOperationDocumentGenerationTrigger - SecurityOperationDocumentGenerationTriggerDetailed!
sortIndex - Int!
defaultVisibilityByInvestor - Boolean!
Example
{
  "id": "4",
  "documentFilterAlgorithm": Algorithm,
  "documentTemplate": DocumentTemplate,
  "generationTrigger": "Manual",
  "securityOperationDocumentGenerationTrigger": SecurityOperationDocumentGenerationTriggerDetailed,
  "sortIndex": 987,
  "defaultVisibilityByInvestor": false
}
Types

SecurityOperationDocumentGenerationTrigger

Values
Enum Value Description

Manual

PostSignature

PostPayment

PostEffectiveDate

SubscriptionPack
Example
"Manual"
Types

SecurityOperationDocumentGenerationTriggerDetailed

Fields
Field Name Description
code - SecurityOperationDocumentGenerationTrigger!
label - String!
Example
{"code": "Manual", "label": "xyz789"}
Types

SecurityOperationInvestment

Description

A Security Operation Investment

Fields
Field Name Description
id - ID!
securityOperationDocuments - [SecurityOperationDocument]
name - String
status - SecurityOperationStatus Use securityOperationStatus instead
securityOperationStatus - SecurityOperationStatusDetailed
type - SecurityOperationType!
securityOperationType - SecurityOperationTypeDetailed!
transactions - TransactionConnection
Arguments
resultsPerPage - Int
page - Int
search - String
moneyMovements - TransactionMoneyMovementConnection
Arguments
resultsPerPage - Int
page - Int
search - String
filter - TransactionMoneyMovementFiltersInput
kpiValues - [KpiValue]
asynchronousOperations - [AsynchronousOperation]
transactionSecurity - TransactionSecurity!
operation - Operation
security - Security!
issuerCompany - IssuerCompany!
collectedAmount - Amount!
securityOperationInvestmentType - SecurityOperationInvestmentTypeDetailed
capitalCallPercentage - Float!
issuedSecurities - Int
initialMinimalSubscriptionSecurityCount - Float!
nextMinimalSubscriptionSecurityCount - Float!
includedSegments - [SecurityOperationInvestmentIncludedSegment]
excludedSegments - [SecurityOperationInvestmentExcludedSegment]
Example
{
  "id": "4",
  "securityOperationDocuments": [
    SecurityOperationDocument
  ],
  "name": "abc123",
  "status": "Opened",
  "securityOperationStatus": SecurityOperationStatusDetailed,
  "type": "SecurityOperationInvestment",
  "securityOperationType": SecurityOperationTypeDetailed,
  "transactions": TransactionConnection,
  "moneyMovements": TransactionMoneyMovementConnection,
  "kpiValues": [KpiValue],
  "asynchronousOperations": [AsynchronousOperation],
  "transactionSecurity": TransactionSecurity,
  "operation": Operation,
  "security": Security,
  "issuerCompany": IssuerCompany,
  "collectedAmount": Amount,
  "securityOperationInvestmentType": SecurityOperationInvestmentTypeDetailed,
  "capitalCallPercentage": 987.65,
  "issuedSecurities": 987,
  "initialMinimalSubscriptionSecurityCount": 987.65,
  "nextMinimalSubscriptionSecurityCount": 123.45,
  "includedSegments": [
    SecurityOperationInvestmentIncludedSegment
  ],
  "excludedSegments": [
    SecurityOperationInvestmentExcludedSegment
  ]
}
Types

SecurityOperationInvestmentExcludedSegment

Description

A Security Operation Investment excluded Segment

Fields
Field Name Description
id - ID!
securityOperationInvestment - SecurityOperationInvestment!
segment - Segment!
Example
{
  "id": "4",
  "securityOperationInvestment": SecurityOperationInvestment,
  "segment": Segment
}
Types

SecurityOperationInvestmentIncludedSegment

Description

A Security Operation Investment included Segment

Fields
Field Name Description
id - ID!
securityOperationInvestment - SecurityOperationInvestment!
segment - Segment!
Example
{
  "id": "4",
  "securityOperationInvestment": SecurityOperationInvestment,
  "segment": Segment
}
Types

SecurityOperationInvestmentType

Values
Enum Value Description

SimpleSubscriptions

ScheduledSubscriptionsFullOwnership

ScheduledSubscriptionsBareOwnership

DistributionsReinvestment
Example
"SimpleSubscriptions"
Types

SecurityOperationInvestmentTypeDetailed

Fields
Field Name Description
code - SecurityOperationInvestmentType!
label - String!
Example
{
  "code": "SimpleSubscriptions",
  "label": "xyz789"
}
Types

SecurityOperationStatus

Values
Enum Value Description

Opened

Closed

AsynchronousCreation

AsynchronousSetPaymentDate

AsynchronousExportPayment
Example
"Opened"
Types

SecurityOperationStatusDetailed

Fields
Field Name Description
code - SecurityOperationStatus!
label - String!
Example
{"code": "Opened", "label": "abc123"}
Types

SecurityOperationType

Values
Enum Value Description

SecurityOperationInvestment

SecurityOperationCession

SecurityOperationDistribution

SecurityOperationCapitalCall

SecurityOperationTransfer

SecurityOperationDismemberment
Example
"SecurityOperationInvestment"
Types

SecurityOperationTypeDetailed

Fields
Field Name Description
code - SecurityOperationType!
label - String!
Example
{
  "code": "SecurityOperationInvestment",
  "label": "xyz789"
}
Types

SecurityOperationWithOneTransactionSecurity

Description

A Security Operation

Fields
Field Name Description
id - ID!
securityOperationDocuments - [SecurityOperationDocument]
name - String
status - SecurityOperationStatus Use securityOperationStatus instead
securityOperationStatus - SecurityOperationStatusDetailed
type - SecurityOperationType!
securityOperationType - SecurityOperationTypeDetailed!
transactions - TransactionConnection
Arguments
resultsPerPage - Int
page - Int
search - String
moneyMovements - TransactionMoneyMovementConnection
Arguments
resultsPerPage - Int
page - Int
search - String
filter - TransactionMoneyMovementFiltersInput
kpiValues - [KpiValue]
asynchronousOperations - [AsynchronousOperation]
transactionSecurity - TransactionSecurity!
Possible Types
SecurityOperationWithOneTransactionSecurity Types

SecurityOperationInvestment
Example
{
  "id": 4,
  "securityOperationDocuments": [
    SecurityOperationDocument
  ],
  "name": "abc123",
  "status": "Opened",
  "securityOperationStatus": SecurityOperationStatusDetailed,
  "type": "SecurityOperationInvestment",
  "securityOperationType": SecurityOperationTypeDetailed,
  "transactions": TransactionConnection,
  "moneyMovements": TransactionMoneyMovementConnection,
  "kpiValues": [KpiValue],
  "asynchronousOperations": [AsynchronousOperation],
  "transactionSecurity": TransactionSecurity
}
Types

SecurityType

Values
Enum Value Description

OBLIGATION

FUND_SHARE

SCPI_SHARE

SHARE

CONVERTIBLE_OBLIGATION
Example
"OBLIGATION"
Types

SecurityTypeDetailed

Fields
Field Name Description
code - SecurityType!
label - String!
Example
{"code": "OBLIGATION", "label": "xyz789"}
Types

SecurityValue

Description

A Security value

Fields
Field Name Description
id - ID!
price - PreciseAmount!
valueAt - DateTime!
security - Security
Example
{
  "id": "4",
  "price": PreciseAmount,
  "valueAt": "2007-12-03T10:15:30Z",
  "security": Security
}
Types

Segment

Fields
Field Name Description
id - ID!
name - String!
description - String
type - SegmentType! Use segmentType
segmentType - SegmentTypeDetailed!
userSegments - UserSegmentConnection
Arguments
resultsPerPage - Int
page - Int
search - String

Term to search in id, firstname, lastname, email or mobile
usersNumber - Int!
updatedAt - DateTime!
Example
{
  "id": "4",
  "name": "xyz789",
  "description": "xyz789",
  "type": "STATIC",
  "segmentType": SegmentTypeDetailed,
  "userSegments": UserSegmentConnection,
  "usersNumber": 987,
  "updatedAt": "2007-12-03T10:15:30Z"
}
Types

SegmentType

Values
Enum Value Description

STATIC

DYNAMIC
Example
"STATIC"
Types

SegmentTypeDetailed

Fields
Field Name Description
code - SegmentType!
label - String!
Example
{"code": "STATIC", "label": "xyz789"}
Types

SignatureMethod

Values
Enum Value Description

Electronic

Manual
Example
"Electronic"
Types

SignatureMethodDetailed

Fields
Field Name Description
code - SignatureMethod!
label - String!
Example
{"code": "Electronic", "label": "xyz789"}
Types

SignerStatus

Description

A SignerStatus

Fields
Field Name Description
signerId - String Might be null in case of manual subscription
type - SignerType!
email - String
firstName - String
lastName - String
phone - String
status - String!
manual - Boolean
Example
{
  "signerId": "xyz789",
  "type": "INVESTOR",
  "email": "xyz789",
  "firstName": "abc123",
  "lastName": "xyz789",
  "phone": "abc123",
  "status": "abc123",
  "manual": true
}
Types

SignerType

Values
Enum Value Description

INVESTOR

COSUBSCRIBER

DISTRIBUTOR

THIRD_PARTY

SECOND_THIRD_PARTY
Example
"INVESTOR"
Types

SoldParticipation

Description

A Portfolio Sold Asset

Fields
Field Name Description
id - ID
security - Security
lastOperation - Operation
issuerId - String
issuerName - String
issuerLogo - Document
investedCapital - Amount
engagedCapital - Amount
repaidCapital - Amount
repaidGainRaw - Amount
collectedTaxation - Amount
repaidGainNet - Amount
realizedIrr - Float
realizedMultiple - Float
totalValue - Amount
dpi - Float!
tvpi - Float!
firstInvestmentDate - Date!
detentionPeriodInMonths - Int!
account - Account
recallableAmount - Amount
Example
{
  "id": 4,
  "security": Security,
  "lastOperation": Operation,
  "issuerId": "abc123",
  "issuerName": "abc123",
  "issuerLogo": Document,
  "investedCapital": Amount,
  "engagedCapital": Amount,
  "repaidCapital": Amount,
  "repaidGainRaw": Amount,
  "collectedTaxation": Amount,
  "repaidGainNet": Amount,
  "realizedIrr": 987.65,
  "realizedMultiple": 987.65,
  "totalValue": Amount,
  "dpi": 123.45,
  "tvpi": 123.45,
  "firstInvestmentDate": "2007-12-03",
  "detentionPeriodInMonths": 987,
  "account": Account,
  "recallableAmount": Amount
}
Types

SortingField

Fields
Input Field Description
field - String!
direction - String
Example
{
  "field": "xyz789",
  "direction": "xyz789"
}
Types

Stake

Description

A Stake

Fields
Field Name Description
id - ID!
stakerName - String!
securitiesNumber - Float!
Example
{
  "id": "4",
  "stakerName": "xyz789",
  "securitiesNumber": 987.65
}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

SubscriptionStep

Values
Enum Value Description

Account

Kyc

Modalities
Example
"Account"
Types

SupportedLocale

Values
Enum Value Description

fr_FR

en_US
Example
"fr_FR"
Types

SupportedLocaleDetailed

Fields
Field Name Description
code - SupportedLocale!
label - String!
Example
{"code": "fr_FR", "label": "abc123"}
Types

TaxationType

Values
Enum Value Description

PEA

PEA_PME

APPORT_CESSION

COMPTE_TITRES

ASSURANCE_VIE_LUXEMBOURGEOISE

IR

NONE
Example
"PEA"
Types

TaxationTypeDetailed

Fields
Field Name Description
code - TaxationType!
label - String!
Example
{"code": "PEA", "label": "abc123"}
Types

Transaction

Fields
Field Name Description
id - ID
type - TransactionType! Use transactionType instead
transactionType - TransactionTypeDetailed!
securitiesNumber - Float!
unpledgedSecuritiesNumber - Float!
transactionDocuments - [TransactionDocument]
transactionMoneyMovement - TransactionMoneyMovement
transactionFees - [TransactionFee]
priceBySecurity - Float!
amount - Amount!
rawAmount - Amount!
securityOperation - SecurityOperation Use transactionSecurity.securityOperation
transactionSecurity - TransactionSecurity
fromAccount - Account
toAccount - Account
transactionNumberings - [TransactionNumbering]
dismembermentType - DismembermentTypeDetailed
documentsZipFileUrl - String! URL to download the zip file containing all transaction documents. Only for Investments and CapitalCalls
Possible Types
Transaction Types

Investment

Cession
Example
{
  "id": 4,
  "type": "INVESTMENT",
  "transactionType": TransactionTypeDetailed,
  "securitiesNumber": 123.45,
  "unpledgedSecuritiesNumber": 987.65,
  "transactionDocuments": [TransactionDocument],
  "transactionMoneyMovement": TransactionMoneyMovement,
  "transactionFees": [TransactionFee],
  "priceBySecurity": 123.45,
  "amount": Amount,
  "rawAmount": Amount,
  "securityOperation": SecurityOperation,
  "transactionSecurity": TransactionSecurity,
  "fromAccount": Account,
  "toAccount": Account,
  "transactionNumberings": [TransactionNumbering],
  "dismembermentType": DismembermentTypeDetailed,
  "documentsZipFileUrl": "xyz789"
}
Types

TransactionConnection

Description

A connection to a list of items.

Fields
Field Name Description
totalCount - Int!
pageInfo - PageInfo! Information to aid in pagination.
edges - [TransactionEdge] Information to aid in pagination.
Example
{
  "totalCount": 123,
  "pageInfo": PageInfo,
  "edges": [TransactionEdge]
}
Types

TransactionDocument

Description

A transaction document

Fields
Field Name Description
visibleByInvestor - Boolean!
id - ID!
transaction - Transaction!
documentGenerated - DocumentGenerated!
type - DocumentTypeDetailed!
Example
{
  "visibleByInvestor": true,
  "id": 4,
  "transaction": Transaction,
  "documentGenerated": DocumentGenerated,
  "type": DocumentTypeDetailed
}
Types

TransactionEdge

Description

An edge in a connection.

Fields
Field Name Description
node - Transaction The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": Transaction,
  "cursor": "xyz789"
}
Types

TransactionFee

Fields
Field Name Description
id - ID!
feeType - FeeType!
feeYearOffset - Int!
amountAte - Int!
amountAti - Int!
vatPercentage - Decimal!
retrocessionAmountAte - Int
retrocessionAmountAti - Int
percentageAte - Decimal!
percentageAti - Decimal!
retrocessionPercentageAte - Decimal
retrocessionPercentageAti - Decimal
transaction - Transaction
retrocessionInvoice - Invoice
retrocessionStatus - RetrocessionStateDetailed
name - String!
calculationType - FeeCalculationTypeDetailed!
isOnTop - Boolean
Example
{
  "id": 4,
  "feeType": "CONSULTANCY_FEES",
  "feeYearOffset": 123,
  "amountAte": 123,
  "amountAti": 987,
  "vatPercentage": Decimal,
  "retrocessionAmountAte": 123,
  "retrocessionAmountAti": 987,
  "percentageAte": Decimal,
  "percentageAti": Decimal,
  "retrocessionPercentageAte": Decimal,
  "retrocessionPercentageAti": Decimal,
  "transaction": Transaction,
  "retrocessionInvoice": Invoice,
  "retrocessionStatus": RetrocessionStateDetailed,
  "name": "xyz789",
  "calculationType": FeeCalculationTypeDetailed,
  "isOnTop": false
}
Types

TransactionMoneyMovement

Description

A transaction money movement

Fields
Field Name Description
id - ID!
status - TransactionMoneyMovementState!
transactionMoneyMovementStatus - TransactionMoneyMovementStateDetailed
date - Date
transactions - [Transaction]
consolidatedTransaction - ConsolidatedTransaction!
invoice - Invoice
paymentMethod - PaymentMethodDetailed
exportedAt - DateTime
transactionMoneyMovementDocuments - [TransactionMoneyMovementDocument]!
Example
{
  "id": "4",
  "status": "Authorized",
  "transactionMoneyMovementStatus": TransactionMoneyMovementStateDetailed,
  "date": "2007-12-03",
  "transactions": [Transaction],
  "consolidatedTransaction": ConsolidatedTransaction,
  "invoice": Invoice,
  "paymentMethod": PaymentMethodDetailed,
  "exportedAt": "2007-12-03T10:15:30Z",
  "transactionMoneyMovementDocuments": [
    TransactionMoneyMovementDocument
  ]
}
Types

TransactionMoneyMovementConnection

Description

A connection to a list of items.

Fields
Field Name Description
totalCount - Int!
pageInfo - PageInfo! Information to aid in pagination.
edges - [TransactionMoneyMovementEdge] Information to aid in pagination.
Example
{
  "totalCount": 123,
  "pageInfo": PageInfo,
  "edges": [TransactionMoneyMovementEdge]
}
Types

TransactionMoneyMovementDocument

Description

A transaction money movement document

Fields
Field Name Description
visibleByInvestor - Boolean!
id - ID!
documentGenerated - DocumentGenerated!
type - DocumentTypeDetailed!
Example
{
  "visibleByInvestor": false,
  "id": 4,
  "documentGenerated": DocumentGenerated,
  "type": DocumentTypeDetailed
}
Types

TransactionMoneyMovementEdge

Description

An edge in a connection.

Fields
Field Name Description
node - TransactionMoneyMovement The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": TransactionMoneyMovement,
  "cursor": "xyz789"
}
Types

TransactionMoneyMovementFiltersInput

Fields
Input Field Description
bankAccountStatus - BankAccountStatus
transactionMoneyMovementState - String Available values are: TransactionMoneyMovementState::Blocked, TransactionMoneyMovementState::Succeeded, TransactionMoneyMovementState::Created, Exported
Example
{
  "bankAccountStatus": "Valid",
  "transactionMoneyMovementState": "abc123"
}
Types

TransactionMoneyMovementState

Description

Enum mapped from App\Enum\TransactionMoneyMovementState

Values
Enum Value Description

Authorized

Canceled

Blocked

Created

Dismembered

Exported

Partial

Recalled

Refused

Succeeded

CREATED

 "Created" should be used instead.

REFUSED

 "Refused" should be used instead.

SUCCEEDED

 "Succeeded" should be used instead.
Example
"Authorized"
Types

TransactionMoneyMovementStateDetailed

Fields
Field Name Description
code - TransactionMoneyMovementState!
label - String!
Example
{"code": "Authorized", "label": "xyz789"}
Types

TransactionNumbering

Fields
Field Name Description
id - ID!
start - Float!
end - Float!
Example
{"id": 4, "start": 987.65, "end": 987.65}
Types

TransactionSecurity

Fields
Field Name Description
id - ID!
priceBySecurity - Float
securityOperation - SecurityOperation!
security - Security!
issuerCompany - IssuerCompany!
operation - Operation
Example
{
  "id": 4,
  "priceBySecurity": 987.65,
  "securityOperation": SecurityOperation,
  "security": Security,
  "issuerCompany": IssuerCompany,
  "operation": Operation
}
Types

TransactionState

Values
Enum Value Description

ExportedPayment

Paid

PaymentRefused

PendingPayment

PendingSignature

PendingValidation

SignedAndPaid

SignedButPaymentRefused
Example
"ExportedPayment"
Types

TransactionStateDetailed

Fields
Field Name Description
code - TransactionState!
label - String!
Example
{
  "code": "ExportedPayment",
  "label": "xyz789"
}
Types

TransactionType

Values
Enum Value Description

INVESTMENT

CESSION

DISTRIBUTION

CAPITAL_CALL

TRANSFER

Dismemberment
Example
"INVESTMENT"
Types

TransactionTypeDetailed

Fields
Field Name Description
code - TransactionType!
label - String!
Example
{"code": "INVESTMENT", "label": "abc123"}
Types

TransferViewerActingLike

Values
Enum Value Description

Investment

Cession

Both
Example
"Investment"
Types

UrlParameters

Description

Url parameters as query string and parsed value

Fields
Field Name Description
queryString - String
parsed - Array
Example
{
  "queryString": "abc123",
  "parsed": Array
}
Types

UsedBankAccountTypesByAccountPersona

Fields
Field Name Description
Investor - [BankAccountTypeDetailed]!
Distributor - [BankAccountTypeDetailed]!
DistributorNetwork - [BankAccountTypeDetailed]!
Vehicle - [BankAccountTypeDetailed]!
Example
{
  "Investor": [BankAccountTypeDetailed],
  "Distributor": [BankAccountTypeDetailed],
  "DistributorNetwork": [BankAccountTypeDetailed],
  "Vehicle": [BankAccountTypeDetailed]
}
Types

User

Description

A User

Fields
Field Name Description
id - ID
active - Boolean
email - String!
lastLogin - DateTime
mobile - String
firstName - String!
lastName - String!
persona - Persona!
personaDetailed - PersonaDetailed!
accounts - [Account]!
roles - [String]
emailsInCopy - [String]
isPasswordDefined - Boolean
portfolio - Portfolio
Arguments
visualizationDate - Date

The portfolio will be rendered as the state it was at this date

accountId - ID

The account Id
unactiveComment - String
acceptedAt - DateTime
createdAt - DateTime
userSegments - [UserSegment]
segments - [Segment]
distributedByAdvisor - DistributorAdvisor The advisor is now on the Account object
distributedBy - Distributor The advisor is now on the Account object
representedDistributorNetwork - DistributorNetwork
tosAcknowledgedAt - DateTime
locale - SupportedLocale
localeDetailed - SupportedLocaleDetailed
signupUrlParameters - UrlParameters
Example
{
  "id": "4",
  "active": false,
  "email": "abc123",
  "lastLogin": "2007-12-03T10:15:30Z",
  "mobile": "xyz789",
  "firstName": "xyz789",
  "lastName": "abc123",
  "persona": "ADMIN",
  "personaDetailed": PersonaDetailed,
  "accounts": [Account],
  "roles": ["xyz789"],
  "emailsInCopy": ["xyz789"],
  "isPasswordDefined": false,
  "portfolio": Portfolio,
  "unactiveComment": "xyz789",
  "acceptedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "userSegments": [UserSegment],
  "segments": [Segment],
  "distributedByAdvisor": DistributorAdvisor,
  "distributedBy": Distributor,
  "representedDistributorNetwork": DistributorNetwork,
  "tosAcknowledgedAt": "2007-12-03T10:15:30Z",
  "locale": "fr_FR",
  "localeDetailed": SupportedLocaleDetailed,
  "signupUrlParameters": UrlParameters
}
Types

UserSegment

Fields
Field Name Description
id - ID!
segment - Segment!
user - User!
Example
{
  "id": "4",
  "segment": Segment,
  "user": User
}
Types

UserSegmentConnection

Description

A connection to a list of items.

Fields
Field Name Description
totalCount - Int!
pageInfo - PageInfo! Information to aid in pagination.
edges - [UserSegmentEdge] Information to aid in pagination.
Example
{
  "totalCount": 987,
  "pageInfo": PageInfo,
  "edges": [UserSegmentEdge]
}
Types

UserSegmentEdge

Description

An edge in a connection.

Fields
Field Name Description
node - UserSegment The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": UserSegment,
  "cursor": "xyz789"
}
Types

VialinkControl

Fields
Field Name Description
id - ID!
control - Array!
generatedReportDocument - Document
activeComplianceControls - [ComplianceControl]
activeAlerts - [ComplianceControl]
account - Account!
Example
{
  "id": 4,
  "control": Array,
  "generatedReportDocument": Document,
  "activeComplianceControls": [ComplianceControl],
  "activeAlerts": [ComplianceControl],
  "account": Account
}