PUT v1/consumers/card-onboarding/{sessionId}

Request Information

URI Parameters

Name	Description	Type	Additional information
sessionId		globally unique identifier	Required

Body Parameters

CreditCardOnboardingData

Name	Type	Additional information
CustomerData	CreditCardOnboardingCustomerData	None.
Application	CreditCardApplicationRequest	None.
SourceData	TransactionSourceData	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerData": {
    "Email": "sample string 1",
    "PhoneNumber": "sample string 2"
  },
  "Application": {
    "DueDate": 1,
    "Applicants": [
      {
        "AddressCity": "sample string 1",
        "AddressCountryCode": "sample string 2",
        "AddressStreet": "sample string 3",
        "AddressZip": "sample string 4",
        "ApplicantTypeEnum": "Null",
        "BankAccountNumber": "sample string 5",
        "BusinessTypeEnum": "Null",
        "CostOfHousingPerMonth": 6.0,
        "CreditCardCount": 7,
        "DateOfBirth": "2026-07-03T15:57:53.3873287+00:00",
        "EducationLevelEnum": "Null",
        "Email": "sample string 9",
        "Employer": "sample string 10",
        "EmploymentStartDate": "2026-07-03T15:57:53.3873287+00:00",
        "EmploymentStatusEnum": "Null",
        "EmploymentTerminationDate": "2026-07-03T15:57:53.3873287+00:00",
        "FirstName": "sample string 13",
        "GenderEnum": "Null",
        "GrossIncomePerMonth": 14.0,
        "IdentityCode": "sample string 15",
        "MaritalStatusEnum": "Null",
        "Name": "sample string 16",
        "NationalityCode": "sample string 17",
        "NativeLanguageEnum": "Null",
        "NumberOfChildrenInHousehold": 18,
        "OtherExpencesPerMonth": 19.0,
        "OtherIncomePerMonth": 20.0,
        "OtherIncomeSpecification": "sample string 21",
        "Phone": "sample string 22",
        "PlaceOfBirth": "sample string 23",
        "Profession": "sample string 24",
        "RecidenceStartDate": "2026-07-03T15:57:53.3873287+00:00",
        "ReferenceNumber": "sample string 26",
        "RepresentativeFirstName": "sample string 27",
        "RepresentativeLastName": "sample string 28",
        "RepresentativeSsn": "sample string 29",
        "ResidenceOwnershipEnum": "Null",
        "ResidenceTypeEnum": "Null",
        "SsnBic": "sample string 30",
        "Title": "sample string 31"
      },
      {
        "AddressCity": "sample string 1",
        "AddressCountryCode": "sample string 2",
        "AddressStreet": "sample string 3",
        "AddressZip": "sample string 4",
        "ApplicantTypeEnum": "Null",
        "BankAccountNumber": "sample string 5",
        "BusinessTypeEnum": "Null",
        "CostOfHousingPerMonth": 6.0,
        "CreditCardCount": 7,
        "DateOfBirth": "2026-07-03T15:57:53.3873287+00:00",
        "EducationLevelEnum": "Null",
        "Email": "sample string 9",
        "Employer": "sample string 10",
        "EmploymentStartDate": "2026-07-03T15:57:53.3873287+00:00",
        "EmploymentStatusEnum": "Null",
        "EmploymentTerminationDate": "2026-07-03T15:57:53.3873287+00:00",
        "FirstName": "sample string 13",
        "GenderEnum": "Null",
        "GrossIncomePerMonth": 14.0,
        "IdentityCode": "sample string 15",
        "MaritalStatusEnum": "Null",
        "Name": "sample string 16",
        "NationalityCode": "sample string 17",
        "NativeLanguageEnum": "Null",
        "NumberOfChildrenInHousehold": 18,
        "OtherExpencesPerMonth": 19.0,
        "OtherIncomePerMonth": 20.0,
        "OtherIncomeSpecification": "sample string 21",
        "Phone": "sample string 22",
        "PlaceOfBirth": "sample string 23",
        "Profession": "sample string 24",
        "RecidenceStartDate": "2026-07-03T15:57:53.3873287+00:00",
        "ReferenceNumber": "sample string 26",
        "RepresentativeFirstName": "sample string 27",
        "RepresentativeLastName": "sample string 28",
        "RepresentativeSsn": "sample string 29",
        "ResidenceOwnershipEnum": "Null",
        "ResidenceTypeEnum": "Null",
        "SsnBic": "sample string 30",
        "Title": "sample string 31"
      }
    ],
    "ExternalLoans": [
      {
        "LoanBalance": 1.0,
        "MonthlyInstallment": 2.0,
        "Provider": "sample string 3",
        "RepaymentBankAccountNumber": "sample string 4",
        "CreditTypeEnum": 0,
        "IsToBeRepaid": true
      },
      {
        "LoanBalance": 1.0,
        "MonthlyInstallment": 2.0,
        "Provider": "sample string 3",
        "RepaymentBankAccountNumber": "sample string 4",
        "CreditTypeEnum": 0,
        "IsToBeRepaid": true
      }
    ],
    "IsPoliticallyInfluential": true,
    "NationalityId": "5b3dbdbd-f375-4a1c-96c4-c2c64a38a5e2",
    "NationalityId2": "8714f1f3-3b39-48ef-aeed-c27171114bcd",
    "NationalityId3": "d5a15222-546c-47f4-8eb6-5ebb04e16db9",
    "SourceData": {
      "ChannelEnum": 0,
      "IdentificationTypeEnum": "NULL",
      "CreateTime": "2026-07-03T15:57:53.3873287+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:53.3873287+00:00",
      "SessionStartTime": "2026-07-03T15:57:53.3873287+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"
    }
  },
  "SourceData": {
    "ChannelEnum": 0,
    "IdentificationTypeEnum": "NULL",
    "CreateTime": "2026-07-03T15:57:53.3873287+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:53.3873287+00:00",
    "SessionStartTime": "2026-07-03T15:57:53.3873287+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:

<CreditCardOnboardingData 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:53.3873287+00:00</CreateTime>
    <DeviceTypeCode>sample string 4</DeviceTypeCode>
    <ExternalCampaignCode>sample string 19</ExternalCampaignCode>
    <ExternalTransactionCode>sample string 20</ExternalTransactionCode>
    <FirstVisitTime>2026-07-03T15:57:53.3873287+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:53.3873287+00:00</SessionStartTime>
    <TrackingCookieId>sample string 15</TrackingCookieId>
    <UserName>sample string 21</UserName>
    <UserRoleCode>sample string 22</UserRoleCode>
  </SourceData>
  <Application xmlns:d2p1="http://schemas.datacontract.org/2004/07/FfMobileApi.Models">
    <d2p1:SourceData>
      <d2p1:ABTestingCode>sample string 23</d2p1:ABTestingCode>
      <d2p1:AffiliateCampaignCode>sample string 7</d2p1:AffiliateCampaignCode>
      <d2p1:AffiliateMediumCode>sample string 6</d2p1:AffiliateMediumCode>
      <d2p1:AffiliateSourceCode>sample string 5</d2p1:AffiliateSourceCode>
      <d2p1:AffiliateTransactionCode>sample string 8</d2p1:AffiliateTransactionCode>
      <d2p1:ApplicationSourceEnum>NULL</d2p1:ApplicationSourceEnum>
      <d2p1:ChannelEnum>NULL</d2p1:ChannelEnum>
      <d2p1:CreateTime>2026-07-03T15:57:53.3873287+00:00</d2p1:CreateTime>
      <d2p1:DeviceTypeCode>sample string 4</d2p1:DeviceTypeCode>
      <d2p1:ExternalCampaignCode>sample string 19</d2p1:ExternalCampaignCode>
      <d2p1:ExternalTransactionCode>sample string 20</d2p1:ExternalTransactionCode>
      <d2p1:FirstVisitTime>2026-07-03T15:57:53.3873287+00:00</d2p1:FirstVisitTime>
      <d2p1:IdentificationBankCode>sample string 1</d2p1:IdentificationBankCode>
      <d2p1:IdentificationDetail>sample string 2</d2p1:IdentificationDetail>
      <d2p1:IdentificationTypeEnum>NULL</d2p1:IdentificationTypeEnum>
      <d2p1:IpAddress>sample string 3</d2p1:IpAddress>
      <d2p1:IsMobileDevice>true</d2p1:IsMobileDevice>
      <d2p1:LandingPageUrl>sample string 13</d2p1:LandingPageUrl>
      <d2p1:OperatingSystemCode>sample string 12</d2p1:OperatingSystemCode>
      <d2p1:PageUrl>sample string 14</d2p1:PageUrl>
      <d2p1:PageVisitHistory>sample string 17</d2p1:PageVisitHistory>
      <d2p1:ReferrerUrl>sample string 18</d2p1:ReferrerUrl>
      <d2p1:SearchEngineCode>sample string 9</d2p1:SearchEngineCode>
      <d2p1:SearchEngineTransactionCode>sample string 10</d2p1:SearchEngineTransactionCode>
      <d2p1:SearchKeyword>sample string 11</d2p1:SearchKeyword>
      <d2p1:SessionCode>sample string 16</d2p1:SessionCode>
      <d2p1:SessionStartTime>2026-07-03T15:57:53.3873287+00:00</d2p1:SessionStartTime>
      <d2p1:TrackingCookieId>sample string 15</d2p1:TrackingCookieId>
      <d2p1:UserName>sample string 21</d2p1:UserName>
      <d2p1:UserRoleCode>sample string 22</d2p1:UserRoleCode>
    </d2p1:SourceData>
    <d2p1:Applicants>
      <d2p1:Applicant>
        <d2p1:AddressCity>sample string 1</d2p1:AddressCity>
        <d2p1:AddressCountryCode>sample string 2</d2p1:AddressCountryCode>
        <d2p1:AddressStreet>sample string 3</d2p1:AddressStreet>
        <d2p1:AddressZip>sample string 4</d2p1:AddressZip>
        <d2p1:ApplicantTypeEnum>Null</d2p1:ApplicantTypeEnum>
        <d2p1:BankAccountNumber>sample string 5</d2p1:BankAccountNumber>
        <d2p1:BusinessTypeEnum>Null</d2p1:BusinessTypeEnum>
        <d2p1:CostOfHousingPerMonth>6</d2p1:CostOfHousingPerMonth>
        <d2p1:CreditCardCount>7</d2p1:CreditCardCount>
        <d2p1:DateOfBirth>2026-07-03T15:57:53.3873287+00:00</d2p1:DateOfBirth>
        <d2p1:EducationLevelEnum>Null</d2p1:EducationLevelEnum>
        <d2p1:Email>sample string 9</d2p1:Email>
        <d2p1:Employer>sample string 10</d2p1:Employer>
        <d2p1:EmploymentStartDate>2026-07-03T15:57:53.3873287+00:00</d2p1:EmploymentStartDate>
        <d2p1:EmploymentStatusEnum>Null</d2p1:EmploymentStatusEnum>
        <d2p1:EmploymentTerminationDate>2026-07-03T15:57:53.3873287+00:00</d2p1:EmploymentTerminationDate>
        <d2p1:FirstName>sample string 13</d2p1:FirstName>
        <d2p1:GenderEnum>Null</d2p1:GenderEnum>
        <d2p1:GrossIncomePerMonth>14</d2p1:GrossIncomePerMonth>
        <d2p1:IdentityCode>sample string 15</d2p1:IdentityCode>
        <d2p1:MaritalStatusEnum>Null</d2p1:MaritalStatusEnum>
        <d2p1:Name>sample string 16</d2p1:Name>
        <d2p1:NationalityCode>sample string 17</d2p1:NationalityCode>
        <d2p1:NativeLanguageEnum>Null</d2p1:NativeLanguageEnum>
        <d2p1:NumberOfChildrenInHousehold>18</d2p1:NumberOfChildrenInHousehold>
        <d2p1:OtherExpencesPerMonth>19</d2p1:OtherExpencesPerMonth>
        <d2p1:OtherIncomePerMonth>20</d2p1:OtherIncomePerMonth>
        <d2p1:OtherIncomeSpecification>sample string 21</d2p1:OtherIncomeSpecification>
        <d2p1:Phone>sample string 22</d2p1:Phone>
        <d2p1:PlaceOfBirth>sample string 23</d2p1:PlaceOfBirth>
        <d2p1:Profession>sample string 24</d2p1:Profession>
        <d2p1:RecidenceStartDate>2026-07-03T15:57:53.3873287+00:00</d2p1:RecidenceStartDate>
        <d2p1:ReferenceNumber>sample string 26</d2p1:ReferenceNumber>
        <d2p1:RepresentativeFirstName>sample string 27</d2p1:RepresentativeFirstName>
        <d2p1:RepresentativeLastName>sample string 28</d2p1:RepresentativeLastName>
        <d2p1:RepresentativeSsn>sample string 29</d2p1:RepresentativeSsn>
        <d2p1:ResidenceOwnershipEnum>Null</d2p1:ResidenceOwnershipEnum>
        <d2p1:ResidenceTypeEnum>Null</d2p1:ResidenceTypeEnum>
        <d2p1:SsnBic>sample string 30</d2p1:SsnBic>
        <d2p1:Title>sample string 31</d2p1:Title>
      </d2p1:Applicant>
      <d2p1:Applicant>
        <d2p1:AddressCity>sample string 1</d2p1:AddressCity>
        <d2p1:AddressCountryCode>sample string 2</d2p1:AddressCountryCode>
        <d2p1:AddressStreet>sample string 3</d2p1:AddressStreet>
        <d2p1:AddressZip>sample string 4</d2p1:AddressZip>
        <d2p1:ApplicantTypeEnum>Null</d2p1:ApplicantTypeEnum>
        <d2p1:BankAccountNumber>sample string 5</d2p1:BankAccountNumber>
        <d2p1:BusinessTypeEnum>Null</d2p1:BusinessTypeEnum>
        <d2p1:CostOfHousingPerMonth>6</d2p1:CostOfHousingPerMonth>
        <d2p1:CreditCardCount>7</d2p1:CreditCardCount>
        <d2p1:DateOfBirth>2026-07-03T15:57:53.3873287+00:00</d2p1:DateOfBirth>
        <d2p1:EducationLevelEnum>Null</d2p1:EducationLevelEnum>
        <d2p1:Email>sample string 9</d2p1:Email>
        <d2p1:Employer>sample string 10</d2p1:Employer>
        <d2p1:EmploymentStartDate>2026-07-03T15:57:53.3873287+00:00</d2p1:EmploymentStartDate>
        <d2p1:EmploymentStatusEnum>Null</d2p1:EmploymentStatusEnum>
        <d2p1:EmploymentTerminationDate>2026-07-03T15:57:53.3873287+00:00</d2p1:EmploymentTerminationDate>
        <d2p1:FirstName>sample string 13</d2p1:FirstName>
        <d2p1:GenderEnum>Null</d2p1:GenderEnum>
        <d2p1:GrossIncomePerMonth>14</d2p1:GrossIncomePerMonth>
        <d2p1:IdentityCode>sample string 15</d2p1:IdentityCode>
        <d2p1:MaritalStatusEnum>Null</d2p1:MaritalStatusEnum>
        <d2p1:Name>sample string 16</d2p1:Name>
        <d2p1:NationalityCode>sample string 17</d2p1:NationalityCode>
        <d2p1:NativeLanguageEnum>Null</d2p1:NativeLanguageEnum>
        <d2p1:NumberOfChildrenInHousehold>18</d2p1:NumberOfChildrenInHousehold>
        <d2p1:OtherExpencesPerMonth>19</d2p1:OtherExpencesPerMonth>
        <d2p1:OtherIncomePerMonth>20</d2p1:OtherIncomePerMonth>
        <d2p1:OtherIncomeSpecification>sample string 21</d2p1:OtherIncomeSpecification>
        <d2p1:Phone>sample string 22</d2p1:Phone>
        <d2p1:PlaceOfBirth>sample string 23</d2p1:PlaceOfBirth>
        <d2p1:Profession>sample string 24</d2p1:Profession>
        <d2p1:RecidenceStartDate>2026-07-03T15:57:53.3873287+00:00</d2p1:RecidenceStartDate>
        <d2p1:ReferenceNumber>sample string 26</d2p1:ReferenceNumber>
        <d2p1:RepresentativeFirstName>sample string 27</d2p1:RepresentativeFirstName>
        <d2p1:RepresentativeLastName>sample string 28</d2p1:RepresentativeLastName>
        <d2p1:RepresentativeSsn>sample string 29</d2p1:RepresentativeSsn>
        <d2p1:ResidenceOwnershipEnum>Null</d2p1:ResidenceOwnershipEnum>
        <d2p1:ResidenceTypeEnum>Null</d2p1:ResidenceTypeEnum>
        <d2p1:SsnBic>sample string 30</d2p1:SsnBic>
        <d2p1:Title>sample string 31</d2p1:Title>
      </d2p1:Applicant>
    </d2p1:Applicants>
    <d2p1:DueDate>1</d2p1:DueDate>
    <d2p1:ExternalLoans>
      <d2p1:ExternalLoanData>
        <d2p1:CreditTypeEnum>Null</d2p1:CreditTypeEnum>
        <d2p1:IsToBeRepaid>true</d2p1:IsToBeRepaid>
        <d2p1:LoanBalance>1</d2p1:LoanBalance>
        <d2p1:MonthlyInstallment>2</d2p1:MonthlyInstallment>
        <d2p1:Provider>sample string 3</d2p1:Provider>
        <d2p1:RepaymentBankAccountNumber>sample string 4</d2p1:RepaymentBankAccountNumber>
      </d2p1:ExternalLoanData>
      <d2p1:ExternalLoanData>
        <d2p1:CreditTypeEnum>Null</d2p1:CreditTypeEnum>
        <d2p1:IsToBeRepaid>true</d2p1:IsToBeRepaid>
        <d2p1:LoanBalance>1</d2p1:LoanBalance>
        <d2p1:MonthlyInstallment>2</d2p1:MonthlyInstallment>
        <d2p1:Provider>sample string 3</d2p1:Provider>
        <d2p1:RepaymentBankAccountNumber>sample string 4</d2p1:RepaymentBankAccountNumber>
      </d2p1:ExternalLoanData>
    </d2p1:ExternalLoans>
    <d2p1:IsPoliticallyInfluential>true</d2p1:IsPoliticallyInfluential>
    <d2p1:NationalityId>5b3dbdbd-f375-4a1c-96c4-c2c64a38a5e2</d2p1:NationalityId>
    <d2p1:NationalityId2>8714f1f3-3b39-48ef-aeed-c27171114bcd</d2p1:NationalityId2>
    <d2p1:NationalityId3>d5a15222-546c-47f4-8eb6-5ebb04e16db9</d2p1:NationalityId3>
  </Application>
  <CustomerData>
    <Email>sample string 1</Email>
    <PhoneNumber>sample string 2</PhoneNumber>
  </CustomerData>
</CreditCardOnboardingData>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.