UpdatePersons

Inputs (Array of Persons to update)

NameTypeDescriptionMandatoryAvailable from version
BrickIdGuidThis is the unique id of the person that should be updatedYes
IsApprovedBooleanChange whether the person is approved or not

FirstNamestringNew first name of person

MiddleNamesstringNew middle names of person
2.10
LastNamestringNew last name of person
2.10
GenderstringValue should be Male, Female, Company
Removed from 2.14
TitlestringValue should be Miss, Mr, Ms, Dr, Mrs
Removed from 2.14
UserNamestringNew username
2.10
EmailstringNew Email of the person
2.10
CommentstringNew comment on the person
2.10
PhoneHomestringNew phone number to the persons home
2.10
PhoneMobilestringNew phone number to the persons mobile phone
2.10
PhoneWorkstringNew phone number to the persons work
2.10
PassportNumberstringThe passport number of the Legal Entity

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.

IsTaxPayerboolIf true the Legal Entity will be subject to tax reporting and tax withholding
2.10
IsApprovedForStructsboolIf the Legal Entity is approved for investing in structured products
2.10
IsVerifiedboolIf the Legal Entity is verified according to Know Your Customer regulations
2.10
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: InstrumentTypes.



AddressStreetstringThe street of the persons address
2.10
AddressCitystringThe city in the persons address
2.10
AddressZipstringThe zip code in the persons address
2.10
AddressCOstringThe c/o of the persons address
2.10
DepartmentstringThe name of the department of the person
2.10
CountrystringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
2.10
TaxCountrystringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
2.10
PostageAddressStreetstringThe postage street of the persons address
2.10
PostageAddressCitystringThe postage city in the persons address
2.10
PostageAddressZipstringThe postage zip code in the persons address
2.10
PostageAddressCOstringThe postage c/o of the persons address
2.10
PostageAddressDepartmentstringThe name of the postage department of the person
2.10
PostageAddressCountrystringAccording to ISO-standard here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
2.10
ExternalReferencestringThe 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
2.10
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.

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
ResellerNostringCustomer number of the reseller that is to be accosiated with the person
2.14
IsNaturalPersonboolTells whether the legal entity is a natural person or not. (True = Natural person, False = Legal person). Replaces the Gender property.
2.14
WhiteLabelGuidId of WhiteLabel that person belong to

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
PersonalNumberstringPersonal number for the person

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
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
BirthDateDateTimeThe BirthDate of 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

Outputs

Name
Type
Description
Available from version
EntitiesArray

All persons in the request is returned along with each persons BrickId, IsApproved, FirstName, IsFundEntity, IsFundCompany and array of Errors per person


Code examples

C# - Get all account types from a BFS instance
  //Update a person methodvar 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 response = client.UpdatePersons(new BFSServiceReference.UpdatePersonsRequest()
{
    Credentials = credentials,
    identify = bfsidentifier, //Identifier is a unique token for your instance of BFS
    Fields = new UpdatePersonFields()
    {
      IsApproved  = true,     
    },
    Entities = new []
    {
      new UpdateAccount()
      {
          BrickId = bnpersonid,
          IsApproved  = true,        
      },
    },
     
});
foreach (var c in response.Entities)
{
    Console.WriteLine(c.BrickId + "," + c.IsApproved + "," + response.Message);
}


Blog stream

Create a blog post to share news and announcements with your team and company.