Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Filter inputs

NameTypeDescription
BrickIdGuid[]Filter by array of BrickIds. BrickId is the internal id of a legal entity
CustomerNosString[]Filter by array of Customer Numbers
UserNameStringFilter by single Username
PersonalNumbersString[]Filter by array of tax identification numbers
ResellerNoStringFilter by single Reseller Number
IsFundEntityBoolFilter by Legal Entities that are set as investment funds
ExternalReferencesString[]Filter by array of External References

Response rows (Array) inherits from EntityBase

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 
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 
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. 
GenderstringValue should be Male, Female, Company 
TitlestringValue should be Miss, Mr, Ms, Dr, Mrs 
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. 

Code examples

C# - Get all legal entities from a BFS instance
//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);
}

 

Blog Posts

 

  • No labels