Filter inputsFilter inputs
Name | Type | Description | Mandatory | Available from version |
---|---|---|---|---|
BrickId | Guid[] | Filter by array of BrickIds. BrickId is the internal id of a legal entity | ||
CustomerNos | String[] | Filter by array of Customer Numbers | ||
UserName | String | Filter by single Username | ||
UserNames | String[] | Filter by array of Usernames | 2.02.20160506 | |
PersonalNumbers | String[] | Filter by array of tax identification numbers | ||
ResellerNo | String | Filter by single Reseller Number | ||
ResellerNos | String[] | Filter by multiple Reseller Numbers | ||
IsFundEntity | Bool | Filter by Legal Entities that are set as investment funds | ||
IsIssuer | Bool | Filter by Legal Entities that are set as Issuer | ||
ExternalReferences | String[] | Filter by array of External References | ||
CreatedDateFrom | DateTime | When used, both from date and to date should be provided in the request | 2.02.20160506 | |
CreatedDateTo | DateTime | 2.02.20160506 | ||
LastLoginDateFrom | DateTime | When used, both from date and to date should be provided in the request | 2.02.20160506 | |
LastLoginDateTo | DateTime | 2.02.20160506 | ||
Cities | String[] | Filter by cities for the LegalEntity | 2.02.20160506 | |
Countries | String[] | Filter by countries for the LegalEntity | 2.02.20160506 | |
Emails | String[] | Filter by e-mails for the LegalEntity | 2.02.20160506 | |
PostalCodes | String[] | Filter by postalcodes for the LegalEntity | 2.02.20160506 | |
TaxCountries | String[] | Filter by tax countries for the LegalEntity | 2.02.20160506 | |
StreetAddresses | String[] | Filter by street addresses for the LegalEntity | 2.02.20160506 | |
UserDomains | String[] | Filter by the type of user, available values are:
| 2.02.20160701 | |
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 | |
TRSCountries | 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 | |
BranchCountries | 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 |
Response rows (Array) inherits from EntityBase
Name | Type | Description | MandatoryAvailable from version | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
BrickId | Guid | []Filter by array of BrickIds. BrickId is the internal id of a legal entity | CustomerNos | String[] | Filter by array of Customer Numbers | UserName | String | Filter by single Username | UserNames | String[] | Filter by array of Usernames | The BrickId of the Legal Entity | ||||||||||||||||||||||||||||||||||||||||||||||
CreatedDate | DateTime | The date when the person was created | 2.02.20160506PersonalNumbers | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirstName | String[] | Filter by array of tax identification numbers | ResellerNo | String | Filter by single Reseller Number | ResellerNos | String[] | Filter by multiple Reseller Numbers | IsFundEntity | Bool | Filter by Legal Entities that are set as investment funds | IsIssuer | Bool | Filter by Legal Entities that are set as Issuer | ExternalReferences | String[] | Filter by array of External References | CreatedDateFrom | DateTime | When used, both from date and to date should be provided in the request | 2.02.20160506 | CreatedDateTo | DateTime | 2.02.20160506 | LastLoginDateFrom | DateTime | When used, both from date and to date should be provided in the request | 2.02.20160506 | LastLoginDateTo | DateTime | 2.02.20160506 | Cities | String[] | Filter by cities for the LegalEntity | 2.02.20160506 | Countries | String[] | Filter by countries for the LegalEntity | 2.02.20160506 | Emails | String[] | Filter by e-mails for the LegalEntity | 2.02.20160506 | PostalCodes | String[] | Filter by postalcodes for the LegalEntity | 2.02.20160506 | TaxCountries | String[] | Filter by tax countries for the LegalEntity | 2.02.20160506 | StreetAddresses | String[] | Filter by street addresses for the LegalEntity | 2.02.20160506 | UserDomains | String[] | 2.02.20160701 |
Response rows (Array) inherits from EntityBase
Name | Type | Description | Available from version | BrickId | Guid | The BrickId of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CreatedDate | DateTime | The date when the person was created | 2.02.20160506 | FirstName | string | The first name of the Legal Entity | LastName | string | The last name of the Legal Entity | MiddleNames | string | The middle name of the Legal Entity | UserName | string | The username of the Legal Entity | string | The email of the Legal Entity | PersonalNumber | string | The tax identification number of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BirthDate | DateTime | The date of person's birth. | 2.04 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResellerNo | string | The reseller number of the Legal Entity | ResellerId | Guid | The reseller id of the Legal Entity | IsApproved | bool | If true the Legal Entity is approved (activated) in the BFS instance and can login | AddressCity | string | The name of the city where the Legal Entity resides | AddressStreet | string | The name of the street where the Legal Entity resides | AddressZip | string | The postal code where the Legal Entity resides | Comment | string | A free text comment that can be used for a Legal Entity | ExternalReference | string | An 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 | PassportNumber | string | The passport number of the Legal Entity | PhoneHome | string | The phone number of the Legal Entity | PhoneWork | string | The work phone number of the Legal Entity | IsTaxPayer | bool | If true the Legal Entity will be subject to tax reporting and tax withholding | IsInsuranceCompany | bool | If the Legal Entity is categorized as an insurance company | IsInsuranceProductSupplier | bool | If the Legal Entity is categorized as a product supplier for insurance products | IsApprovedForStructs | bool | If the Legal Entity is approved for investing in structured products | IsVerified | bool | If the Legal Entity is verified according to Know Your Customer regulations | 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. | 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 | string | 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: InstrumentTypes. | Gender | string | Value should be Male, Female, Company | Title | string | Value should be Miss, Mr, Ms, Dr, Mrs | Country | string | According to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 | TaxCountrystring | The first name of the Legal Entity | |
LastName | string | The last name of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
MiddleNames | string | The middle name of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UserName | string | The username of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
string | The email of the Legal Entity | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PersonalNumber | string | The tax identification number of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BirthDate | DateTime | The date of person's birth. | 2.04 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResellerNo | string | The reseller number of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ResellerId | Guid | The reseller id of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IsApproved | bool | If true the Legal Entity is approved (activated) in the BFS instance and can login | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddressCity | string | The name of the city where the Legal Entity resides | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddressStreet | string | The name of the street where the Legal Entity resides | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AddressZip | string | The postal code where the Legal Entity resides | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comment | string | A free text comment that can be used for a Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ExternalReference | string | An 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PassportNumber | string | The passport number of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PhoneHome | string | The phone number of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PhoneWork | string | The work phone number of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IsTaxPayer | bool | If true the Legal Entity will be subject to tax reporting and tax withholding | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IsInsuranceCompany | bool | If the Legal Entity is categorized as an insurance company | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IsInsuranceProductSupplier | bool | If the Legal Entity is categorized as a product supplier for insurance products | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IsApprovedForStructs | bool | If the Legal Entity is approved for investing in structured products | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
IsVerified | bool | If the Legal Entity is verified according to Know Your Customer regulations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | string | 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: InstrumentTypes. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Gender | string | Value should be Male, Female, Company | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Title | string | Value should be Miss, Mr, Ms, Dr, Mrs | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Country | string | According to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TaxCountry | string | According to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CustomerNo | string | The customer number of the Legal Entity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BIC | string | A Legal Entity can have a BIC code associated to it which is returned in this field. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LastLoginDate | DateTime | The timestamp of the last login for the user | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UserDomain | string | The type of user, available values are:
| 2.02.20160701 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressStreet | string | The postage address street of the Legal Entity | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressCO | string | The postage address of the Legal Entity | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressZip | string | The postage zip of the Legal Entity | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressCity | string | The postage city of the Legal Entity | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressCountry | string | According to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressDepartment | string | The postage department of the Legal Entity | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | CustomerNo | string | The customer number of the Legal Entity | BIC | string | A Legal Entity can have a BIC code associated to it which is returned in this field. | LastLoginDate | DateTime | The timestamp of the last login for the user | UserDomain | string | 2.02.20160701 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressStreet | string | The postage address street of the Legal Entity | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressCO | string | The postage address of the Legal Entity | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressZip | string | The postage zip of the Legal Entity | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressCity | string | The postage city of the Legal Entity | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressCountry, 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.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PostageAddressDepartment | string | The postage department of the Legal Entity | 2.09 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 object11 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DefaultCompany | Guid | The company where the person is employed. | 2.0911 |
Code examples
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
//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); } |
...