Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Inputs (Array of Persons to update)

in development2024-09-25

Name

Type

Description

Mandatory

Available from version

BrickId

Guid

This is the unique id of the person that should be updated

Yes


IsNaturalPerson

bool

Tells whether the legal entity is a natural person or not. (True = Natural person, False = Legal person). Replaces the Gender property.

Yes

2.14

IsApproved

Boolean

Change whether the person is approved or not



FirstName

string

New first name of person



MiddleNames

string

New middle names of person


2.10

LastName

string

New last name of person


2.10

Gender

string

Value should be Male, Female, Company


Removed from 2.14

Title

string

Value should be Miss, Mr, Ms, Dr, Mrs


Removed from 2.14

UserName

string

New username


2.10

Email

string

New Email of the person


2.10

Comment

string

New comment on the person


2.10

PhoneHome

string

New phone number to the persons home


2.10

PhoneMobile

string

New phone number to the persons mobile phone


2.10

PhoneWork

string

New phone number to the persons work


2.10

PassportNumber

string

The passport number of the Legal Entity



IsFundEntity

bool

If the Legal Entity is categorized as an investment fund. An investment fund can have a relationship to a fund company that manages the fund.



IsFundCompany

bool

If the Legal Entity is categorized as a fund company. A fund company can have a relationship to fund entities which it manages.



IsTaxPayer

bool

If true the Legal Entity will be subject to tax reporting and tax withholding


2.10

IsApprovedForStructs

bool

If the Legal Entity is approved for investing in structured products


2.10

IsVerified

bool

If the Legal Entity is verified according to Know Your Customer regulations


2.10

IsIssuer

bool

If the Legal Entity is categorized as issuer.



SectorNACE

string

Only used for Legal Entities that has IsIssuer set to true.



GroupCode

string

Only used for Legal Entities that has IsIssuer set to true.



ExternalRating

string

Only used for Legal Entities that has IsIssuer set to true.



RatingAgency

string

Only used for Legal Entities that has IsIssuer set to true.



InstrumentTypesString

int[]

Only used for Legal Entities that has IsIssuer set to true. This is the instrument types the issuer can issue. For information about which number to use: InstrumentTypes.



AddressStreet

string

The street of the persons address


2.10

AddressCity

string

The city in the persons address


2.10

AddressZip

string

The zip code in the persons address


2.10

AddressCO

string

The c/o of the persons address


2.10

Department

string

The name of the department of the person


2.10

Country

string

According to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2


2.10

TaxCountry

string

According to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2


2.10

PostageAddressStreet

string

The postage street of the persons address


2.10

PostageAddressCity

string

The postage city in the persons address


2.10

PostageAddressZip

string

The postage zip code in the persons address


2.10

PostageAddressCO

string

The postage c/o of the persons address


2.10

PostageAddressDepartment

string

The name of the postage department of the person


2.10

PostageAddressCountry

string

According to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2


2.10

ExternalReference

string

The external reference that can be used for a Legal Entity to for example link the Legal Entity to an external system with the id of the Legal Entity in the external system


2.10

CustomFields

object[]

CustomFields is an array of CustomField objects. Each CustomField consists of two strings, FieldName and Value. There are no datatypes associated with these properties, they are just a way for api-users to add custimized data to the object.



LEI

string

The Legal Entity Identifier that should be used for companies when performing TRS2 reporting


2.11

TRSId

string

The TRS identification code that should be used for natural persons when performing TRS2 reporting


2.11

TRSCountry

string

According to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, though only certain countries are available. See GetTRSCountries.


2.11

TRSIdType

string

The id type for TRS reporting regarding natural persons. Can be either NID, PASSPORT or CONCAT.


2.11

TRSManualHandling

bool

Tells whether the person should have Manual handling in the TRS reporting or not.


2.11

IsProfessional

bool

Tells whether the person is a professonal investor in the TRS reporting or not.


2.11

MifidOk

bool

Tells whether the person is compliant for MIFID II or not.


2.11

IsPEP

bool

Tells whether the person is a politically exposed person or not.


2.11

BranchCountry

string

According to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2


2.11

DefaultCompany

Guid

The company where the person is employed.


2.11

ResellerNo

string

Customer number of the reseller that is to be accosiated with the person


2.14

WhiteLabel

Guid

Id of WhiteLabel that person belong to



HasCustomerProtectionData

bool

True if customer has ProtectedData, in Mifid2 application


2.17

IsCounterParty

bool

True if Legal Entity is CounterParty


2.19

CustomerCashAccount

Guid

Used on Legal Entitys that is FundEntity


2.19

FundCompany

Guid

FundCompany for the person


2.19

PersonalNumber

string

Personal number for the person



KycDate

DateTime

The KycDate reflects the date when Know Your Customer information was captured from a LegalEntity


2.23

GIIN

string

GIIN (global intermediary identification number) of a Legal Entity


2.24

ResellerAccount

Guid

The BrickIds of the accounts used for the advisor to receive fees as described here /wiki/spaces/KB/pages/1211662482


2.25

RiskValue

decimal

RiskValue for the person


2.25

LegalJurisdiction

string

The LegalJurisdiction for the person.


2.28

BirthDate

DateTime

The BirthDate of the person.


2.28

ParentCompany

Guid

The BrickId of a relating LegalEntity that is a parent company. Both the related and the relating LegalEntity must be companies with "IsNaturalPerson = true".


2.30

IsCustodian

bool

Whether the person is a custodian or not.


2.31

TINs

TIN[]

Array of TIN objects. 

A TIN object has the following properties:

  • TINNumber (string)

  • TINCountryCode (string). The TINCountryCode is in the format of alpha-2 (SE, US etc).


2.41

IsTerminated

bool

Whether the person is deactivated or not.

2022-12-07

ForcePasswordReset

bool

True if the user has to change their password.

2024-04-03

TaxRate

double

Tax rate for the person

Status
colourBlue
title

Outputs

Name

Type

Description

Available from version

Entities

Array

All persons in the request is returned along with each persons BrickId, IsApproved, FirstName, IsFundEntity, IsFundCompany and array of Errors per person


...