POST v1/companies-web/customers/beneficial-owners
Request Information
URI Parameters
None.
Body Parameters
UpdateBeneficialOwnersRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| SsnBic | string |
None. |
|
| Address_City | string |
None. |
|
| Address_Zip | string |
None. |
|
| Address_Street | string |
None. |
|
| Address_Country | string |
None. |
|
| BirthDate | date |
None. |
|
| PrimaryTaxCountryId | globally unique identifier |
None. |
|
| PrimaryTaxCountryCode | string |
None. |
|
| PrimaryTaxCountryTin | string |
None. |
|
| AdditionalTaxCountryId | globally unique identifier |
None. |
|
| AdditionalTaxCountryCode | string |
None. |
|
| AdditionalTaxCountryTin | string |
None. |
|
| AdditionalTaxCountry2Id | globally unique identifier |
None. |
|
| AdditionalTaxCountry2Code | string |
None. |
|
| AdditionalTaxCountry2Tin | string |
None. |
|
| NationalityId | globally unique identifier |
None. |
|
| NationalityCode | string |
None. |
|
| AdditionalNationalityId | globally unique identifier |
None. |
|
| AdditionalNationalityCode | string |
None. |
|
| AdditionalNationality2Id | globally unique identifier |
None. |
|
| AdditionalNationality2Code | string |
None. |
|
| IsUsCitizen | boolean |
None. |
|
| IsPep | boolean |
None. |
|
| OwnerSharePercent | decimal number |
None. |
|
| BeneficialOwnerType | BeneficialOwnerTypeEnum |
None. |
|
| CountryOfBirthId | globally unique identifier |
None. |
|
| PepCountryId | globally unique identifier |
None. |
|
| Title | string |
None. |
|
| PepType | PepTypeEnum |
None. |
|
| SourceData | TransactionSourceData |
None. |
Request Formats
application/json, text/json
Sample:
{
"FirstName": "sample string 1",
"LastName": "sample string 2",
"SsnBic": "sample string 3",
"Address_City": "sample string 4",
"Address_Zip": "sample string 5",
"Address_Street": "sample string 6",
"Address_Country": "sample string 7",
"BirthDate": "2026-07-02T10:22:56.334786+00:00",
"PrimaryTaxCountryId": "e7fa79aa-af19-4751-9315-efd8d7105dde",
"PrimaryTaxCountryCode": "sample string 9",
"PrimaryTaxCountryTin": "sample string 10",
"AdditionalTaxCountryId": "bb0c0f46-8463-4084-b60d-084b0a892338",
"AdditionalTaxCountryCode": "sample string 11",
"AdditionalTaxCountryTin": "sample string 12",
"AdditionalTaxCountry2Id": "a2e78e1f-513d-4c4b-bd64-90bfaf3135f0",
"AdditionalTaxCountry2Code": "sample string 13",
"AdditionalTaxCountry2Tin": "sample string 14",
"NationalityId": "3d54cefb-6ed7-444f-9784-580fab6b46e9",
"NationalityCode": "sample string 15",
"AdditionalNationalityId": "97905258-e0d4-4373-b370-03f3352c71d4",
"AdditionalNationalityCode": "sample string 16",
"AdditionalNationality2Id": "db913a7d-d9be-4242-afcd-36a6f1421ad4",
"AdditionalNationality2Code": "sample string 17",
"IsUsCitizen": true,
"IsPep": true,
"OwnerSharePercent": 1.0,
"BeneficialOwnerType": "NULL",
"CountryOfBirthId": "4943f3d9-d523-4239-8301-a062273ae4db",
"PepCountryId": "bc1a039c-1522-478b-9340-a21069572d82",
"Title": "sample string 20",
"PepType": "Self",
"SourceData": {
"ChannelEnum": 0,
"IdentificationTypeEnum": "NULL",
"CreateTime": "2026-07-02T10:22:56.334786+00:00",
"IdentificationBankCode": "sample string 1",
"IdentificationDetail": "sample string 2",
"IpAddress": "sample string 3",
"DeviceTypeCode": "sample string 4",
"ApplicationSourceEnum": 0,
"AffiliateSourceCode": "sample string 5",
"AffiliateMediumCode": "sample string 6",
"AffiliateCampaignCode": "sample string 7",
"AffiliateTransactionCode": "sample string 8",
"SearchEngineCode": "sample string 9",
"SearchEngineTransactionCode": "sample string 10",
"SearchKeyword": "sample string 11",
"OperatingSystemCode": "sample string 12",
"LandingPageUrl": "sample string 13",
"PageUrl": "sample string 14",
"IsMobileDevice": true,
"TrackingCookieId": "sample string 15",
"SessionCode": "sample string 16",
"FirstVisitTime": "2026-07-02T10:22:56.334786+00:00",
"SessionStartTime": "2026-07-02T10:22:56.334786+00:00",
"PageVisitHistory": "sample string 17",
"ReferrerUrl": "sample string 18",
"ExternalCampaignCode": "sample string 19",
"ExternalTransactionCode": "sample string 20",
"UserName": "sample string 21",
"UserRoleCode": "sample string 22",
"ABTestingCode": "sample string 23"
}
}
application/xml, text/xml
Sample:
<UpdateBeneficialOwnersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfMobileApi.Models">
<SourceData>
<ABTestingCode>sample string 23</ABTestingCode>
<AffiliateCampaignCode>sample string 7</AffiliateCampaignCode>
<AffiliateMediumCode>sample string 6</AffiliateMediumCode>
<AffiliateSourceCode>sample string 5</AffiliateSourceCode>
<AffiliateTransactionCode>sample string 8</AffiliateTransactionCode>
<ApplicationSourceEnum>NULL</ApplicationSourceEnum>
<ChannelEnum>NULL</ChannelEnum>
<CreateTime>2026-07-02T10:22:56.334786+00:00</CreateTime>
<DeviceTypeCode>sample string 4</DeviceTypeCode>
<ExternalCampaignCode>sample string 19</ExternalCampaignCode>
<ExternalTransactionCode>sample string 20</ExternalTransactionCode>
<FirstVisitTime>2026-07-02T10:22:56.334786+00:00</FirstVisitTime>
<IdentificationBankCode>sample string 1</IdentificationBankCode>
<IdentificationDetail>sample string 2</IdentificationDetail>
<IdentificationTypeEnum>NULL</IdentificationTypeEnum>
<IpAddress>sample string 3</IpAddress>
<IsMobileDevice>true</IsMobileDevice>
<LandingPageUrl>sample string 13</LandingPageUrl>
<OperatingSystemCode>sample string 12</OperatingSystemCode>
<PageUrl>sample string 14</PageUrl>
<PageVisitHistory>sample string 17</PageVisitHistory>
<ReferrerUrl>sample string 18</ReferrerUrl>
<SearchEngineCode>sample string 9</SearchEngineCode>
<SearchEngineTransactionCode>sample string 10</SearchEngineTransactionCode>
<SearchKeyword>sample string 11</SearchKeyword>
<SessionCode>sample string 16</SessionCode>
<SessionStartTime>2026-07-02T10:22:56.334786+00:00</SessionStartTime>
<TrackingCookieId>sample string 15</TrackingCookieId>
<UserName>sample string 21</UserName>
<UserRoleCode>sample string 22</UserRoleCode>
</SourceData>
<AdditionalNationality2Code>sample string 17</AdditionalNationality2Code>
<AdditionalNationality2Id>db913a7d-d9be-4242-afcd-36a6f1421ad4</AdditionalNationality2Id>
<AdditionalNationalityCode>sample string 16</AdditionalNationalityCode>
<AdditionalNationalityId>97905258-e0d4-4373-b370-03f3352c71d4</AdditionalNationalityId>
<AdditionalTaxCountry2Code>sample string 13</AdditionalTaxCountry2Code>
<AdditionalTaxCountry2Id>a2e78e1f-513d-4c4b-bd64-90bfaf3135f0</AdditionalTaxCountry2Id>
<AdditionalTaxCountry2Tin>sample string 14</AdditionalTaxCountry2Tin>
<AdditionalTaxCountryCode>sample string 11</AdditionalTaxCountryCode>
<AdditionalTaxCountryId>bb0c0f46-8463-4084-b60d-084b0a892338</AdditionalTaxCountryId>
<AdditionalTaxCountryTin>sample string 12</AdditionalTaxCountryTin>
<Address_City>sample string 4</Address_City>
<Address_Country>sample string 7</Address_Country>
<Address_Street>sample string 6</Address_Street>
<Address_Zip>sample string 5</Address_Zip>
<BeneficialOwnerType>NULL</BeneficialOwnerType>
<BirthDate>2026-07-02T10:22:56.334786+00:00</BirthDate>
<CountryOfBirthId>4943f3d9-d523-4239-8301-a062273ae4db</CountryOfBirthId>
<FirstName>sample string 1</FirstName>
<IsPep>true</IsPep>
<IsUsCitizen>true</IsUsCitizen>
<LastName>sample string 2</LastName>
<NationalityCode>sample string 15</NationalityCode>
<NationalityId>3d54cefb-6ed7-444f-9784-580fab6b46e9</NationalityId>
<OwnerSharePercent>1</OwnerSharePercent>
<PepCountryId>bc1a039c-1522-478b-9340-a21069572d82</PepCountryId>
<PepType>Self</PepType>
<PrimaryTaxCountryCode>sample string 9</PrimaryTaxCountryCode>
<PrimaryTaxCountryId>e7fa79aa-af19-4751-9315-efd8d7105dde</PrimaryTaxCountryId>
<PrimaryTaxCountryTin>sample string 10</PrimaryTaxCountryTin>
<SsnBic>sample string 3</SsnBic>
<Title>sample string 20</Title>
</UpdateBeneficialOwnersRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.