Skip to end of metadata
Go to start of metadata

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
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

UserNamesString[]Filter by array of Usernames
2.02.20160506
PersonalNumbersString[]Filter by array of tax identification numbers

ResellerNoStringFilter by single Reseller Number

ResellerNosString[]Filter by multiple Reseller Numbers

IsFundEntityBoolFilter by Legal Entities that are set as investment funds


IsIssuerBoolFilter by Legal Entities that are set as Issuer

ExternalReferencesString[]Filter by array of External References

CreatedDateFromDateTimeWhen used, both from date and to date should be provided in the request
2.02.20160506
CreatedDateToDateTime
2.02.20160506
LastLoginDateFromDateTimeWhen used, both from date and to date should be provided in the request
2.02.20160506
LastLoginDateToDateTime
2.02.20160506
CitiesString[]Filter by cities for the LegalEntity
2.02.20160506
CountriesString[]Filter by countries for the LegalEntity
2.02.20160506
EmailsString[]Filter by e-mails for the LegalEntity
2.02.20160506
PostalCodesString[]Filter by postalcodes for the LegalEntity
2.02.20160506
TaxCountriesString[]Filter by tax countries for the LegalEntity
2.02.20160506
StreetAddressesString[]Filter by street addresses for the LegalEntity
2.02.20160506
UserDomainsString[]

Filter by the type of user, available values are:

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



2.02.20160701

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
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
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: InstrumentTypes.


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.
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

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);
}
C# - Filter legal entities on last login date
//Use the GetPersons method 
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  

    Args = new BFSServiceReference.GetPersonArgs()
    {
        LastLoginDateFrom = TimeZoneInfo.ConvertTimeToUtc(DateTime.Today.AddDays(-5)),
        LastLoginDateTo = TimeZoneInfo.ConvertTimeToUtc(DateTime.Now),
        
    },

    Fields = new BFSServiceReference.GetPersonFields()
    {
        BrickId = true,
        UserName = true,
        FirstName = true,
        LastName = true,
        LastLoginDate = true,
    },
});

foreach (var c in persons.Result)
{
    Console.WriteLine(c.BrickId + "," + c.FirstName + "," + c.LastName + "," + c.LastLoginDate);
}
C# - Filter legal entities on user domain
//Use the GetPersons method 
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  

    Args = new BFSServiceReference.GetPersonArgs()
    {
        LastLoginDateFrom = TimeZoneInfo.ConvertTimeToUtc(DateTime.Today.AddDays(-5)),
        LastLoginDateTo = TimeZoneInfo.ConvertTimeToUtc(DateTime.Now),
        UserDomains = new []
        {
			"Admin",
        }

    },

    Fields = new BFSServiceReference.GetPersonFields()
    {
        BrickId = true,
        UserName = true,
        FirstName = true,
        LastName = true,
        LastLoginDate = true,
        UserDomain = true,
    },
});

foreach (var c in persons.Result)
{
    Console.WriteLine(c.BrickId + "," + c.FirstName + "," + c.LastName + "," + c.LastLoginDate + "," + c.UserDomain);
}


Blog Posts