POST v1/companies-web/customers/beneficial-owners-list

Request Information

URI Parameters

None.

Body Parameters

Collection of UpdateBeneficialOwnersRequest

Name	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": "83ebc6b2-742a-4f81-a0da-fa5c56b8535e",
    "PrimaryTaxCountryCode": "sample string 9",
    "PrimaryTaxCountryTin": "sample string 10",
    "AdditionalTaxCountryId": "8b3cb64e-8651-4368-8faf-bcd11d231eae",
    "AdditionalTaxCountryCode": "sample string 11",
    "AdditionalTaxCountryTin": "sample string 12",
    "AdditionalTaxCountry2Id": "fdb47927-aaec-4f88-874a-1c00a2b7f254",
    "AdditionalTaxCountry2Code": "sample string 13",
    "AdditionalTaxCountry2Tin": "sample string 14",
    "NationalityId": "9d1c69fb-aa65-4856-a2aa-69bb545001a4",
    "NationalityCode": "sample string 15",
    "AdditionalNationalityId": "370a9e50-21a4-4b15-8309-7332626384cb",
    "AdditionalNationalityCode": "sample string 16",
    "AdditionalNationality2Id": "9991b3e1-5c86-450d-b0a1-ca351cddea81",
    "AdditionalNationality2Code": "sample string 17",
    "IsUsCitizen": true,
    "IsPep": true,
    "OwnerSharePercent": 1.0,
    "BeneficialOwnerType": "NULL",
    "CountryOfBirthId": "4c8e2eb2-d6c7-43a2-a768-6804455af5c7",
    "PepCountryId": "a9b7faa3-9d62-4910-b499-00b05838fef7",
    "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"
    }
  },
  {
    "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": "83ebc6b2-742a-4f81-a0da-fa5c56b8535e",
    "PrimaryTaxCountryCode": "sample string 9",
    "PrimaryTaxCountryTin": "sample string 10",
    "AdditionalTaxCountryId": "8b3cb64e-8651-4368-8faf-bcd11d231eae",
    "AdditionalTaxCountryCode": "sample string 11",
    "AdditionalTaxCountryTin": "sample string 12",
    "AdditionalTaxCountry2Id": "fdb47927-aaec-4f88-874a-1c00a2b7f254",
    "AdditionalTaxCountry2Code": "sample string 13",
    "AdditionalTaxCountry2Tin": "sample string 14",
    "NationalityId": "9d1c69fb-aa65-4856-a2aa-69bb545001a4",
    "NationalityCode": "sample string 15",
    "AdditionalNationalityId": "370a9e50-21a4-4b15-8309-7332626384cb",
    "AdditionalNationalityCode": "sample string 16",
    "AdditionalNationality2Id": "9991b3e1-5c86-450d-b0a1-ca351cddea81",
    "AdditionalNationality2Code": "sample string 17",
    "IsUsCitizen": true,
    "IsPep": true,
    "OwnerSharePercent": 1.0,
    "BeneficialOwnerType": "NULL",
    "CountryOfBirthId": "4c8e2eb2-d6c7-43a2-a768-6804455af5c7",
    "PepCountryId": "a9b7faa3-9d62-4910-b499-00b05838fef7",
    "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:

<ArrayOfUpdateBeneficialOwnersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfMobileApi.Models">
  <UpdateBeneficialOwnersRequest>
    <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>9991b3e1-5c86-450d-b0a1-ca351cddea81</AdditionalNationality2Id>
    <AdditionalNationalityCode>sample string 16</AdditionalNationalityCode>
    <AdditionalNationalityId>370a9e50-21a4-4b15-8309-7332626384cb</AdditionalNationalityId>
    <AdditionalTaxCountry2Code>sample string 13</AdditionalTaxCountry2Code>
    <AdditionalTaxCountry2Id>fdb47927-aaec-4f88-874a-1c00a2b7f254</AdditionalTaxCountry2Id>
    <AdditionalTaxCountry2Tin>sample string 14</AdditionalTaxCountry2Tin>
    <AdditionalTaxCountryCode>sample string 11</AdditionalTaxCountryCode>
    <AdditionalTaxCountryId>8b3cb64e-8651-4368-8faf-bcd11d231eae</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>4c8e2eb2-d6c7-43a2-a768-6804455af5c7</CountryOfBirthId>
    <FirstName>sample string 1</FirstName>
    <IsPep>true</IsPep>
    <IsUsCitizen>true</IsUsCitizen>
    <LastName>sample string 2</LastName>
    <NationalityCode>sample string 15</NationalityCode>
    <NationalityId>9d1c69fb-aa65-4856-a2aa-69bb545001a4</NationalityId>
    <OwnerSharePercent>1</OwnerSharePercent>
    <PepCountryId>a9b7faa3-9d62-4910-b499-00b05838fef7</PepCountryId>
    <PepType>Self</PepType>
    <PrimaryTaxCountryCode>sample string 9</PrimaryTaxCountryCode>
    <PrimaryTaxCountryId>83ebc6b2-742a-4f81-a0da-fa5c56b8535e</PrimaryTaxCountryId>
    <PrimaryTaxCountryTin>sample string 10</PrimaryTaxCountryTin>
    <SsnBic>sample string 3</SsnBic>
    <Title>sample string 20</Title>
  </UpdateBeneficialOwnersRequest>
  <UpdateBeneficialOwnersRequest>
    <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>9991b3e1-5c86-450d-b0a1-ca351cddea81</AdditionalNationality2Id>
    <AdditionalNationalityCode>sample string 16</AdditionalNationalityCode>
    <AdditionalNationalityId>370a9e50-21a4-4b15-8309-7332626384cb</AdditionalNationalityId>
    <AdditionalTaxCountry2Code>sample string 13</AdditionalTaxCountry2Code>
    <AdditionalTaxCountry2Id>fdb47927-aaec-4f88-874a-1c00a2b7f254</AdditionalTaxCountry2Id>
    <AdditionalTaxCountry2Tin>sample string 14</AdditionalTaxCountry2Tin>
    <AdditionalTaxCountryCode>sample string 11</AdditionalTaxCountryCode>
    <AdditionalTaxCountryId>8b3cb64e-8651-4368-8faf-bcd11d231eae</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>4c8e2eb2-d6c7-43a2-a768-6804455af5c7</CountryOfBirthId>
    <FirstName>sample string 1</FirstName>
    <IsPep>true</IsPep>
    <IsUsCitizen>true</IsUsCitizen>
    <LastName>sample string 2</LastName>
    <NationalityCode>sample string 15</NationalityCode>
    <NationalityId>9d1c69fb-aa65-4856-a2aa-69bb545001a4</NationalityId>
    <OwnerSharePercent>1</OwnerSharePercent>
    <PepCountryId>a9b7faa3-9d62-4910-b499-00b05838fef7</PepCountryId>
    <PepType>Self</PepType>
    <PrimaryTaxCountryCode>sample string 9</PrimaryTaxCountryCode>
    <PrimaryTaxCountryId>83ebc6b2-742a-4f81-a0da-fa5c56b8535e</PrimaryTaxCountryId>
    <PrimaryTaxCountryTin>sample string 10</PrimaryTaxCountryTin>
    <SsnBic>sample string 3</SsnBic>
    <Title>sample string 20</Title>
  </UpdateBeneficialOwnersRequest>
</ArrayOfUpdateBeneficialOwnersRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateBeneficialOwnersRequest[]'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.