POST v1/consumers/card-onboarding/start
Request Information
URI Parameters
None.
Body Parameters
InitializeCreditCardOnboardingRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| SourceData | TransactionSourceData |
None. |
Request Formats
application/json, text/json
Sample:
{
"SourceData": {
"ChannelEnum": 0,
"IdentificationTypeEnum": "NULL",
"CreateTime": "2026-07-03T15:57:56.5903918+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-03T15:57:56.5903918+00:00",
"SessionStartTime": "2026-07-03T15:57:56.5903918+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:
<InitializeCreditCardOnboardingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfMobileApi.Models.CreditCardOnboarding">
<SourceData xmlns="http://schemas.datacontract.org/2004/07/FfMobileApi.Models">
<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-03T15:57:56.5903918+00:00</CreateTime>
<DeviceTypeCode>sample string 4</DeviceTypeCode>
<ExternalCampaignCode>sample string 19</ExternalCampaignCode>
<ExternalTransactionCode>sample string 20</ExternalTransactionCode>
<FirstVisitTime>2026-07-03T15:57:56.5903918+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-03T15:57:56.5903918+00:00</SessionStartTime>
<TrackingCookieId>sample string 15</TrackingCookieId>
<UserName>sample string 21</UserName>
<UserRoleCode>sample string 22</UserRoleCode>
</SourceData>
</InitializeCreditCardOnboardingRequest>
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.