CreatePersons

Inputs (Array of Persons) inherits from EntityBase

NameTypeDescriptionMandatoryAvailable from version
BrickIdGuidNot used.

FirstNamestringThe first name of the Legal Entity (Empty string is not allowed)True
LastNamestringThe last name of the Legal Entity (Empty string is not allowed)True
MiddleNamesstringThe middle name of the Legal Entity

UserNamestringThe username of the Legal Entity (Empty string is not allowed)True
PasswordstringThe password of the Legal Entity (Empty string is not allowed)True
EmailstringThe email of the Legal EntityTrue
PersonalNumberstringThe tax identification number of the Legal Entity

BirthDateDateTimeThe date of person's birth
2.04
ResellerNostringThe customer number (CustomerNo) of the reseller.

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

DepartmentstringThe name of the department of the Legal Entity

BICstringBIC code of the Legal Entity

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

PhoneMobilestringThe mobile 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

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.

IsVerifiedboolIf the Legal Entity is verified according to Know Your Customer regulations

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.

InstrumentTypesStringint[]

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



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

DomainDomainAvailable Domains: Admin, Partner, Front

PostageAddressStreetstringThe name of the postage street of the Legal Entity
2.09
PostageAddressCOstringThe name of the postage address of the Legal Entity
2.09
PostageAddressZipstringThe name of the postage zip the of Legal Entity
2.09
PostageAddressCitystringThe name of the postage city of the Legal Entity
2.09
PostageAddressCountrystringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
2.09
PostageAddressDepartmentstringThe name of the postage department of the Legal Entity
2.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 reporting
2.11
TRSIdstringThe TRS identification code that should be used for natural persons when performing TRS2 reporting
2.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 natural persons. Can be either NID, PASSPORT or CONCAT.
2.11
TRSManualHandlingboolTells whether the person 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-2
2.11
DefaultCompanyGuidThe company where the person is employed.
2.11
IsNaturalPersonboolTells whether the Legal Entity is a natural person or not. (True = Natural person, False = Legal person). Replaces the Gender property.True2.14
WhiteLabelGuidId of WhiteLabel that person belong to
2.16
HasCustomerProtectionDataboolTrue if customer has ProtectedData, in Mifid2 application
2.17
IsCounterPartyboolTrue if Legal Entity is CounterParty
2.19
CustomerCashAccountGuidUsed on Legal Entitys that is FundEntity
2.19
FundCompanyGuidFundCompany for the person
2.19
KycDateDateTimeThe KycDate reflects the date when Know Your Customer information was captured from a LegalEntity
2.23
GIINStringGIIN (global intermediary identification number) of a Legal Entity
2.24
SendWelcomeMailboolIf true, a welcome-mail will be sent to customer
2.25
ResellerAccountGuidThe BrickIds of the accounts used for the advisor to receive fees as described here How to work with advisors and fees
2.25
RiskValuedecimalRiskValue for the person
2.25
LegalJurisdictionstringThe LegalJurisdiction for the person
2.28
ParentCompanyGuidThe BrickId of a relating LegalEntity that is a parent company. Both the related and the relating LegalEntity must be companies with "IsNaturalPerson = true".
2.30
IsCustodianboolWhether the person is a custodian or not.
2.31


Response rows

NameTypeDescriptionAvailable 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