Versions Compared

Key

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

...

NameTypeDescriptionAvailable from version
BrickIdGuidThe BrickId of the Legal Entity
CreatedDateDateTimeThe date when the person was created2.02.20160506
FirstNamestringThe first name of the Legal Entity
LastNamestringThe last name of the Legal Entity
MiddleNamesstringThe middle name of the Legal Entity
UserNamestringThe username of the Legal Entity
EmailstringThe email of the Legal Entity
PersonalNumberstringThe tax identification number of the Legal Entity
BirthDateDateTimeThe date of person's birth.2.04
ResellerNostringThe reseller number of the Legal Entity
ResellerIdGuidThe reseller id of the Legal Entity
IsApprovedboolIf true the Legal Entity is approved (activated) in the BFS instance and can login
AddressCitystringThe name of the city where the Legal Entity resides
AddressStreetstringThe name of the street where the Legal Entity resides
AddressZipstringThe postal code where the Legal Entity resides
CommentstringA free text comment that can be used for a Legal Entity
ExternalReferencestringAn 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
PassportNumberstringThe passport number of the Legal Entity
PhoneHomestringThe phone number of the Legal Entity
PhoneWorkstringThe work phone number of the Legal Entity
PhoneMobilestringThe mobile phone number of the Legal Entity
IsTaxPayerboolIf true the Legal Entity will be subject to tax reporting and tax withholding
IsInsuranceCompanyboolIf the Legal Entity is categorized as an insurance company
IsInsuranceProductSupplierboolIf the Legal Entity is categorized as a product supplier for insurance products
IsApprovedForStructsboolIf the Legal Entity is approved for investing in structured products
IsVerifiedboolIf the Legal Entity is verified according to Know Your Customer regulations
IsFundEntityboolIf the Legal Entity is categorized as an investment fund. An investment fund can have a relationship to a fund company that manages the fund.
IsFundCompanyboolIf the Legal Entity is categorized as a fund company. A fund company can have a relationship to fund entities which it manages.
IsIssuerboolIf the Legal Entity is categorized as issuer.
SectorNACEstringOnly used for Legal Entities that has IsIssuer set to true.
GroupCode

string

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

Only used for Legal Entities that has IsIssuer set to true. This is the instrument types the issuer can issue. Value should be a comma separated string with numbers.

For example: "1,2". For information about which number to use: /wiki/spaces/IKB/pages/54198393.


GenderstringValue should be Male, Female, CompanyRemoved from 2.14
TitlestringValue should be Miss, Mr, Ms, Dr, MrsRemoved from 2.14
CountrystringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
TaxCountrystringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
CustomerNostringThe customer number of the Legal Entity
BICstringA Legal Entity can have a BIC code associated to it which is returned in this field.
LastLoginDateDateTimeThe timestamp of the last login for the user
UserDomainstring

The type of user, available values are:

  • bricknode (Front)
  • bricknodepartner (Partner)
  • bricknodeadmin (Admin)
  • inactive


2.02.20160701
PostageAddressStreetstringThe postage address street of the Legal Entity2.09
PostageAddressCOstringThe postage address of the Legal Entity2.09
PostageAddressZipstringThe postage zip of the Legal Entity2.09
PostageAddressCitystringThe postage city of the Legal Entity2.09
PostageAddressCountrystringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-22.09
PostageAddressDepartmentstringThe postage department of the Legal Entity2.09
CustomFieldsobject[]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.2.09
LEIstringThe Legal Entity Identifier that should be used for companies when performing TRS2 reporting2.11
TRSIdstringThe TRS identification code that should be used for legal entities when performing TRS2 reporting2.11
TRSCountrystringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2, though only certain countries are available. See GetTRSCountries.2.11
TRSIdTypestringThe id type for TRS reporting regarding legal entities. Can be either NID, PASSPORT or CONCAT.2.11
TRSManualHandlingboolTells whether the legal entity should have Manual handling in the TRS reporting or not.2.11
IsProfessionalboolTells whether the person is a professonal investor in the TRS reporting or not.2.11
MifidOkboolTells whether the person is compliant for MIFID II or not.2.11
IsPEPboolTells whether the person is a politically exposed person or not.2.11
BranchCountrystringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-22.11
DefaultCompanyGuidThe company where the person is employed.2.11
AccessLevelintThe access level of the user, usually value 10 or 1002.13
IsNaturalPersonboolTells whether the legal entity is a natural person or not. (True = Natural person, False = Legal person). Replaces the Gender property.2.14
WhiteLabelGuidId of WhiteLabel that person belong to2.16
HasCustomerProtectionDataboolTrue if customer has ProtectedData, in Mifid2 application2.17
IsCounterPartyboolTrue if Legal Entity is CounterParty2.19
CustomerCashAccountGuidUsed on Legal Entitys that is FundEntity2.19
FundCompanyGuidFundCompany for the person2.19
IsTerminatedboolTrue if Person is terminated2.20
KycDateDateTimeThe KycDate reflects the date when Know Your Customer information was captured from a LegalEntity2.23
GIINstringGIIN (global intermediary identification number) of a Legal Entity2.24
ResellerAccountGuidThe BrickIds of the accounts used for the advisor to receive fees as described here How to work with advisors and fees2.25
RiskValuedecimalRiskValue for the person
LegalJurisdictionstringThe LegalJurisdiction for the person.2.28
ParentCompanyGuidThe BrickId of a relating LegalEntity that is a parent company.2.30
IsCustodianboolWhether the person is a custodian or not.2.31
LastUpdatedDateDateTime

The date when the person was updated.

2.33
TINsTIN[]Returns an array of TIN objects. A TIN object has the properties "TINNumber" (string) and "TINCountryCode" (string). The TINCountryCode is in the format of alpha-2 (SE, US etc)2.38

Code examples

Code Block
languagec#
themeRDark
titleC# - Get all legal entities from a BFS instance
linenumberstrue
collapsetrue
//Use the GetPersons method to get all LegalEntities in the BFS instance and write
//the BrickId's and names in the console
var client = new BFSServiceReference.bfsapiSoapClient();
var credentials = new BFSServiceReference.Credentials()
{
    UserName = bfsusername, //Username of administrative user in your instance of BFS
    Password = bfspassword, //Password of the administrative user in your instance of BFS
};
var persons = client.GetPersons(new BFSServiceReference.GetPersonRequest()
{
    Credentials = credentials,
    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
   
    Fields = new BFSServiceReference.GetPersonFields()
    {
        BrickId = true,
        UserName = true,
        FirstName = true,
        LastName = true,
    },
});
foreach (var c in persons.Result)
{
    Console.WriteLine(c.BrickId + "," + c.FirstName + "," + c.LastName);
}

...