Skip to end of metadata
Go to start of metadata

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

BICstring


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

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

DomainDomainAvailable Domains: Admin, Partner, Front

CustomerNostringThe customer number of the Legal Entity

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


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
//Create 


Blog Posts