POST v1/consumers/card-onboarding/{sessionId}/kyc

Request Information

URI Parameters

Name	Description	Type	Additional information
sessionId		globally unique identifier	Required

Body Parameters

PrivateCustomerKycForm

Name	Type	Additional information
EmploymentTypeEnum	EmploymentTypeEnum	Required
EmploymentContractTypeEnum	EmploymentContractTypeEnum	None.
EmploymentCountryId	globally unique identifier	None.
ContractEndDate	date	None.
SalaryIncomePerYearEnum	SalaryIncomePerYearEnum	Required
CapitalIncomePerYearEnum	CapitalIncomePerYearEnum	Required
OriginOfIncomeEnum	OriginOfIncomeEnum	Required
SoldAssetsDescription	string	None.
IsCrossborderBankingCustomer	boolean	Required
RegularMoneyDepositsPerMonthEnum	RegularMoneyDepositsPerMonthEnum	Required
NumberOfRegularDepositsPerMonthEnum	NumberOfRegularMoneyDepositsPerMonthEnum	Required
RegularMoneyWithdrawalsPerMonthEnum	RegularMoneyWithdrawalsPerMonthEnum	Required
NumberOfRegularWithdrawalsPerMonthEnum	NumberOfRegularWithdrawalsPerMonthEnum	Required
PaysTaxesAbroad	boolean	Required
TaxCountryId	globally unique identifier	None.
TaxCountryTin	string	None.
TaxCountryId2	globally unique identifier	None.
TaxCountryTin2	string	None.
TaxCountryId3	globally unique identifier	None.
TaxCountryTin3	string	None.
NationalityId	globally unique identifier	Required
NationalityId2	globally unique identifier	None.
NationalityId3	globally unique identifier	None.
IsPep	boolean	Required
CountryOfBirthId	globally unique identifier	None.
CountriesOfBanking	Collection of globally unique identifier	None.
CrossBorderRegularMoneyDepositsPerMonthEnum	RegularMoneyDepositsPerMonthEnum	None.
CrossBorderNumberOfRegularDepositsPerMonthEnum	NumberOfRegularMoneyDepositsPerMonthEnum	None.
CrossBorderRegularMoneyWithdrawalsPerMonthEnum	RegularMoneyWithdrawalsPerMonthEnum	None.
CrossBorderNumberOfRegularWithdrawalsPerMonthEnum	NumberOfRegularWithdrawalsPerMonthEnum	None.
IsUSCitizen	boolean	None.
SourceData	TransactionSourceData	None.

Request Formats

application/json, text/json

Sample:

{
  "EmploymentTypeEnum": "NULL",
  "EmploymentContractTypeEnum": "NULL",
  "EmploymentCountryId": "a1ae4597-3de4-4f87-a9d8-c880ad14ee1d",
  "ContractEndDate": "2026-07-03T16:00:04.3117012+00:00",
  "SalaryIncomePerYearEnum": "NULL",
  "CapitalIncomePerYearEnum": "NULL",
  "OriginOfIncomeEnum": "NULL",
  "SoldAssetsDescription": "sample string 1",
  "IsCrossborderBankingCustomer": true,
  "RegularMoneyDepositsPerMonthEnum": "NULL",
  "NumberOfRegularDepositsPerMonthEnum": "NULL",
  "RegularMoneyWithdrawalsPerMonthEnum": "NULL",
  "NumberOfRegularWithdrawalsPerMonthEnum": "NULL",
  "PaysTaxesAbroad": true,
  "TaxCountryId": "62bdcd68-307e-4444-9000-ac385ed5ebb0",
  "TaxCountryTin": "sample string 2",
  "TaxCountryId2": "96c8b403-27a7-41d1-b996-fe83d536bc39",
  "TaxCountryTin2": "sample string 3",
  "TaxCountryId3": "d429d5a2-a317-445d-9823-c002cb84d769",
  "TaxCountryTin3": "sample string 4",
  "NationalityId": "2c8280ad-ef04-4143-82ad-28355c7853eb",
  "NationalityId2": "212013d3-8a68-4c84-8e92-518e1ccf6a65",
  "NationalityId3": "bfb4d8b9-0501-44c7-b43e-a62e86d66e9c",
  "IsPep": true,
  "CountryOfBirthId": "9ad2609b-32c4-49a3-bb24-e82fefbb65c8",
  "CountriesOfBanking": [
    "b68131e3-41a1-4895-8f2e-85dcdc02d08f",
    "48f9134d-3979-42ea-af4a-9e0b350bf2bc"
  ],
  "CrossBorderRegularMoneyDepositsPerMonthEnum": "NULL",
  "CrossBorderNumberOfRegularDepositsPerMonthEnum": "NULL",
  "CrossBorderRegularMoneyWithdrawalsPerMonthEnum": "NULL",
  "CrossBorderNumberOfRegularWithdrawalsPerMonthEnum": "NULL",
  "IsUSCitizen": true,
  "SourceData": {
    "ChannelEnum": 0,
    "IdentificationTypeEnum": "NULL",
    "CreateTime": "2026-07-03T16:00:04.3117012+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-03T16:00:04.3117012+00:00",
    "SessionStartTime": "2026-07-03T16:00:04.3117012+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:

<PrivateCustomerKycForm 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-03T16:00:04.3117012+00:00</CreateTime>
    <DeviceTypeCode>sample string 4</DeviceTypeCode>
    <ExternalCampaignCode>sample string 19</ExternalCampaignCode>
    <ExternalTransactionCode>sample string 20</ExternalTransactionCode>
    <FirstVisitTime>2026-07-03T16:00:04.3117012+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-03T16:00:04.3117012+00:00</SessionStartTime>
    <TrackingCookieId>sample string 15</TrackingCookieId>
    <UserName>sample string 21</UserName>
    <UserRoleCode>sample string 22</UserRoleCode>
  </SourceData>
  <CapitalIncomePerYearEnum>NULL</CapitalIncomePerYearEnum>
  <ContractEndDate>2026-07-03T16:00:04.3117012+00:00</ContractEndDate>
  <CountriesOfBanking xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>b68131e3-41a1-4895-8f2e-85dcdc02d08f</d2p1:guid>
    <d2p1:guid>48f9134d-3979-42ea-af4a-9e0b350bf2bc</d2p1:guid>
  </CountriesOfBanking>
  <CountryOfBirthId>9ad2609b-32c4-49a3-bb24-e82fefbb65c8</CountryOfBirthId>
  <CrossBorderNumberOfRegularDepositsPerMonthEnum>NULL</CrossBorderNumberOfRegularDepositsPerMonthEnum>
  <CrossBorderNumberOfRegularWithdrawalsPerMonthEnum>NULL</CrossBorderNumberOfRegularWithdrawalsPerMonthEnum>
  <CrossBorderRegularMoneyDepositsPerMonthEnum>NULL</CrossBorderRegularMoneyDepositsPerMonthEnum>
  <CrossBorderRegularMoneyWithdrawalsPerMonthEnum>NULL</CrossBorderRegularMoneyWithdrawalsPerMonthEnum>
  <EmploymentContractTypeEnum>NULL</EmploymentContractTypeEnum>
  <EmploymentCountryId>a1ae4597-3de4-4f87-a9d8-c880ad14ee1d</EmploymentCountryId>
  <EmploymentTypeEnum>NULL</EmploymentTypeEnum>
  <IsCrossborderBankingCustomer>true</IsCrossborderBankingCustomer>
  <IsPep>true</IsPep>
  <IsUSCitizen>true</IsUSCitizen>
  <NationalityId>2c8280ad-ef04-4143-82ad-28355c7853eb</NationalityId>
  <NationalityId2>212013d3-8a68-4c84-8e92-518e1ccf6a65</NationalityId2>
  <NationalityId3>bfb4d8b9-0501-44c7-b43e-a62e86d66e9c</NationalityId3>
  <NumberOfRegularDepositsPerMonthEnum>NULL</NumberOfRegularDepositsPerMonthEnum>
  <NumberOfRegularWithdrawalsPerMonthEnum>NULL</NumberOfRegularWithdrawalsPerMonthEnum>
  <OriginOfIncomeEnum>NULL</OriginOfIncomeEnum>
  <PaysTaxesAbroad>true</PaysTaxesAbroad>
  <RegularMoneyDepositsPerMonthEnum>NULL</RegularMoneyDepositsPerMonthEnum>
  <RegularMoneyWithdrawalsPerMonthEnum>NULL</RegularMoneyWithdrawalsPerMonthEnum>
  <SalaryIncomePerYearEnum>NULL</SalaryIncomePerYearEnum>
  <SoldAssetsDescription>sample string 1</SoldAssetsDescription>
  <TaxCountryId>62bdcd68-307e-4444-9000-ac385ed5ebb0</TaxCountryId>
  <TaxCountryId2>96c8b403-27a7-41d1-b996-fe83d536bc39</TaxCountryId2>
  <TaxCountryId3>d429d5a2-a317-445d-9823-c002cb84d769</TaxCountryId3>
  <TaxCountryTin>sample string 2</TaxCountryTin>
  <TaxCountryTin2>sample string 3</TaxCountryTin2>
  <TaxCountryTin3>sample string 4</TaxCountryTin3>
</PrivateCustomerKycForm>

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 'PrivateCustomerKycForm'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.