Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

Inputs (Array of Persons to update)

NameTypeDescriptionMandatoryAvailable from version
BrickIdsGuidThis is the unique id of the account 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
2.10
TitlestringValue should be Miss, Mr, Ms, Dr, Mrs
2.10
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.

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.

  • No labels