Inputs (Array of Persons) inherits from EntityBase

Name	Type	Description	Mandatory	Available from version

Name	Type	Description	Mandatory	Available from version
BrickId	Guid	Not used.
FirstName	string	The first name of the Legal Entity (Empty string is not allowed)	True
LastName	string	The last name of the Legal Entity (Empty string is not allowed)	True
MiddleNames	string	The middle name of the Legal Entity
UserName	string	The username of the Legal Entity (Empty string is not allowed)	True
Password	string	The password of the Legal Entity (Empty string is not allowed)	True
Email	string	The email of the Legal Entity	True
PersonalNumber	string	The tax identification number of the Legal Entity
BirthDate	DateTime	The date of person's birth		2.04
ResellerNo	string	The customer number (CustomerNo) of the reseller. A reseller is a Legal Entity that belongs to the Domain called Partner so it is simply the CustomerNo for a Partner user that should be entered here.
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
Department	string	The name of the department of the Legal Entity
BIC	string	BIC code of the Legal Entity
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
PhoneMobile	string	The mobile 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
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.
IsVerified	bool	If the Legal Entity is verified according to Know Your Customer regulations
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: Instrument
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
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
Domain	Domain	Available Domains: Admin, Partner, Front
PostageAddressStreet	string	The name of the postage street of the Legal Entity		2.09
PostageAddressCO	string	The name of the postage address of the Legal Entity		2.09
PostageAddressZip	string	The name of the postage zip the of Legal Entity		2.09
PostageAddressCity	string	The name of 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 name of 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, 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
IsNaturalPerson	bool	Tells whether the Legal Entity is a natural person or not. (True = Natural person, False = Legal person). Replaces the Gender property.	True	2.14
WhiteLabel	Guid	Id of WhiteLabel that person belong to		2.16
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
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
SendWelcomeMail	bool	If true, a welcome-mail will be sent to customer		2.25
ResellerAccount	Guid	The BrickIds of the accounts used for the advisor to receive fees as described here How to work with advisors and fees		2.25
RiskValue	decimal	RiskValue for the person		2.25
LegalJurisdiction	string	The LegalJurisdiction for 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 = false".		2.30
IsCustodian	bool	Whether the person is a custodian or not.		2.31
TINs	TIN[]	Array of TINs. 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
ForcePasswordReset	bool	True if the user has to change their password.		2024-04-03
TaxRate	double	Tax rate for the person (This is a simplified value used in insurances, this has nothing to do with Tax Management )		2024-09-25

Response rows

Name	Type	Description	Available from version

Name	Type	Description	Available from version
Entities	Array	All persons in the request with BrickId and an array of Errors per person

Code examples

C# - Create a person

            var credentials = new Credentials
            {
                UserName = "UserName",
                Password = "Password"
            };

            var createPersonRequest = new CreatePersonRequest
            {
                Credentials = credentials,
                identify = "uniqueIdentifierForYourBfsInstance",
                Entities = new[]
                {
                    new Person
                    {
                        FirstName = "FirstName",
                        LastName = "LastName",
                        UserName = "UserName",
                        Password = "Password",
                        Email = "email@email.com",
                        IsNaturalPerson = true,
                    }
                }
            };

            var response = client.CreatePersons(createPersonRequest);

            foreach (var createdPerson in response.Entities)
            {
                Console.WriteLine($"BrickId: {createdPerson.BrickId}");
            }

Blog Posts

Blog: How to create a new account for a legal entity using CreateAccounts, GetPersons and GetAccountTypes created by
Stefan Willebrand

Dec 30, 2015

BFS API