POST api/SubCard/AddUserInvite

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	globally unique identifier	None.
NickName	string	None.
NameOfChild	string	None.
FamilyName	string	None.
Reletionship	string	None.
DateOfBirth	date	None.
MobileExtension	string	None.
Mobile	string	None.
Email	string	None.
ProfileImageName	string	None.
DateCreated	date	None.
DateUpdated	date	None.
Status	string	None.
UserId	globally unique identifier	None.
BankCardId	globally unique identifier	None.
StatusTypeId	InvieStatus	None.
termsConditionId	globally unique identifier	None.
CountryId	integer	None.
ParentUserId	globally unique identifier	None.
ProductId	globally unique identifier	None.
ParentCardId	globally unique identifier	None.
ReceiverId	globally unique identifier	None.
BankCardProcessViewModel	BankCardProcessViewModel	None.
CurrencyId	integer	None.
BankCardProcessId	globally unique identifier	None.
IsChildOTPVerified	boolean	None.
Allowance	AllowanceViewModel	None.
ProductImage	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": "82506a41-b3ed-4340-8a8c-5f1b36446c06",
  "NickName": "sample string 2",
  "NameOfChild": "sample string 3",
  "FamilyName": "sample string 4",
  "Reletionship": "sample string 5",
  "DateOfBirth": "2023-09-22T17:21:11.277338+00:00",
  "MobileExtension": "sample string 7",
  "Mobile": "sample string 8",
  "Email": "sample string 9",
  "ProfileImageName": "sample string 10",
  "DateCreated": "2023-09-22T17:21:11.277338+00:00",
  "DateUpdated": "2023-09-22T17:21:11.277338+00:00",
  "Status": "sample string 11",
  "UserId": "9b36b6b5-2fb7-4751-acbf-f7e6d519ac9f",
  "BankCardId": "0631c9e0-cc48-441b-9875-e9ee92404c4e",
  "StatusTypeId": 0,
  "termsConditionId": "3583a802-4851-4d7d-9647-9704b948be31",
  "CountryId": 12,
  "ParentUserId": "c3453b74-673d-4059-a188-50f47074c807",
  "ProductId": "2c2830ef-a4d3-42a8-abae-4ac4d7162a56",
  "ParentCardId": "b565f574-81b4-422c-a756-af1cf4f507e1",
  "ReceiverId": "37a9533d-07cf-4652-8edd-66858e9941fe",
  "BankCardProcessViewModel": {
    "ID": "aa805d30-e4a6-4e26-a61c-138c100d03b4",
    "UserID": "bdff2639-83f7-4be2-a3cf-6e37f404d89b",
    "BankBinSponsorID": 3,
    "StatusTypeID": 4,
    "ApplicationID": "sample string 5",
    "BankCardTopupID": "75621e91-686d-4765-adec-494d3128714a",
    "BankCardID": "528bd059-0907-429d-9540-bfed4291cae0",
    "DateSubmitted": "2023-09-22T17:21:11.277338+00:00",
    "AppStatus": {
      "ID": "ba8ba7d3-1843-461e-b089-e284739d0453",
      "Alert_Reference": "sample string 2",
      "Timestamp": "sample string 3",
      "Type": "sample string 4",
      "Application_Id": "sample string 5",
      "Status": "sample string 6",
      "Status_Label": "sample string 7",
      "Reason": "sample string 8",
      "Reason_Label": "sample string 9",
      "Note": "sample string 10",
      "Customer_Id": "sample string 11",
      "Account_Id": "sample string 12",
      "DateCreated": "2023-09-22T17:21:11.277338+00:00",
      "UserID": "cf487a2b-a607-4ca9-bddb-a585e2f96b62",
      "CardName": "sample string 14",
      "KYC_ScanReference1": "sample string 15",
      "KYC_ScanReference2": "sample string 16",
      "AppData": "sample string 17",
      "KYC": {
        "PassportFname": "sample string 1",
        "PassportLname": "sample string 2",
        "DOB": "sample string 3",
        "Gender": "sample string 4",
        "Nationality": "sample string 5",
        "Passport": "sample string 6",
        "PassExpiry": "sample string 7",
        "Email": "sample string 8",
        "Name_On_Card": "sample string 9",
        "KYC_ScanReference1": "sample string 10",
        "DOB_Text": "sample string 11",
        "PassExpiry_Text": "sample string 12",
        "POB": "sample string 13",
        "BankCardProcessID": "00862dc2-263b-4357-8ade-c25a3d1ffbab",
        "CPR": "sample string 14",
        "PassportRejectReason": "sample string 15",
        "IDRejectReason": "sample string 16",
        "CPRExpiry": "sample string 17",
        "CPR_Front": "sample string 18",
        "CPR_Rear": "sample string 19",
        "KYC_ScanReference2": "sample string 20",
        "CPRExpiry_Text": "sample string 21",
        "REF_ID": "sample string 22",
        "Country": "sample string 23",
        "Address1": "sample string 24",
        "Flat": "sample string 25",
        "Building": "sample string 26",
        "Address2": "sample string 27",
        "Phone": "sample string 28",
        "POA_FRONT": "sample string 29",
        "POA_REAR": "sample string 30",
        "Proof_Of_Address": "sample string 31",
        "EMP_Position": "sample string 32",
        "EMP_Status": "sample string 33",
        "EMP_Income": "sample string 34",
        "Source_Of_Income": "sample string 35",
        "Purpose_Of_Account": "sample string 36",
        "EMP_Name": "sample string 37",
        "EMP_Address1": "sample string 38",
        "IDCard_Front": "sample string 39",
        "IDCard_Rear": "sample string 40",
        "country_residence": "sample string 41",
        "industry_type": "sample string 42",
        "expected_monthly_balance": "sample string 43",
        "monthly_salary": "sample string 44",
        "company_country": "sample string 45",
        "place_of_issuance": "sample string 46",
        "Is_US_Person": "sample string 47",
        "TIN_1": "sample string 48",
        "Tax_Status_1": "sample string 49",
        "Tax_Note_1": "sample string 50",
        "Second_Nationality": "sample string 51",
        "IS_PEP": "sample string 52",
        "PEP_Notes": "sample string 53",
        "Passport_IMG": "sample string 54",
        "Profile_Id": "sample string 55",
        "Product_Id": "sample string 56",
        "KYC_Video": "sample string 57",
        "KYC_Image": "sample string 58",
        "Mname": "sample string 59",
        "VisaExpiry": "sample string 60",
        "Visa_IMG": "sample string 61",
        "VisaExpiry_Text": "sample string 62",
        "City": "sample string 63",
        "PostalCode": "sample string 64",
        "company_city": "sample string 65",
        "Company_Building_Name": "sample string 66",
        "Company_Flat_Number": "sample string 67",
        "company_state": "sample string 68",
        "company_postalcode": "sample string 69",
        "State": "sample string 70",
        "PassportVerified": 0,
        "IDVerified": 0,
        "KYCType": "sample string 71",
        "KYC1Date": "2023-09-22T17:21:11.277338+00:00",
        "KYC2Date": "2023-09-22T17:21:11.277338+00:00",
        "KYC3Date": "2023-09-22T17:21:11.277338+00:00",
        "KYC4Date": "2023-09-22T17:21:11.277338+00:00",
        "UpdateKYCModel": {
          "KYC_Passport": true,
          "KYC_ID": true,
          "KYC_POA": true,
          "KYC_AdditionalInfo": true,
          "UpdateKYCText": "sample string 5"
        },
        "RenewKYCStatus": 72,
        "CardProcessStatus": 73,
        "ApplicationStatus": 0
      },
      "UpdatedNote": "sample string 18"
    },
    "CurrencyId": 7,
    "Note": "sample string 8",
    "GCCType": 9,
    "Country": 10,
    "ProductId": "677de510-e150-44aa-991d-b8914c9a1de0",
    "IsExists": true,
    "IsChildOTPVerified": true
  },
  "CurrencyId": 16,
  "BankCardProcessId": "b6944731-9d93-4dd6-a74d-a34d0a560828",
  "IsChildOTPVerified": true,
  "Allowance": {
    "AllowanceId": "b7e93fac-a175-4cca-825d-748ac0e59b28",
    "SenderUserId": "352e0fec-a4bd-44e5-87dd-75a418695eda",
    "ReceiverUserId": "e7022f5d-e6ab-4c82-9324-64e503b8767e",
    "SenderCardId": "89a96b03-52f5-4532-bbff-5d74d402e36f",
    "ReceiverCardId": "748714b2-ecaf-4332-a106-14d2b6e16cb1",
    "ReceiverFirstName": "sample string 5",
    "ReceiverLastName": "sample string 6",
    "ReceiverProfile": "sample string 7",
    "ReceiverMobile": "sample string 8",
    "AllowanceName": "sample string 9",
    "AllowanceDateTime": "2023-09-22T17:21:11.277338+00:00",
    "IsEnabled": true,
    "Hours": 12,
    "AllowanceTypeId": "ee349c04-1d1a-4702-b8d0-7d644c388fcc",
    "AllowancePatternId": "d16f35d3-036e-4e40-bfe0-ee21d1f8302b",
    "AllowanceAmount": 15.1,
    "AllowanceCurrency": "sample string 16",
    "AllowancePatternName": "sample string 17",
    "AllowanceTypeDetails": {
      "AllowanceTypeId": "23bea9e5-43c0-4b53-94ea-c4792ddc86c1",
      "AllowanceTypeName": "sample string 2",
      "Sequence": 3
    },
    "AllowancePatternDetails": {
      "AllowancePatternId": "aae8fe83-09c9-4e12-870c-96b00c0218e7",
      "PatternName": "sample string 2",
      "AllowanceTypeId": "b4deda76-e626-4720-9eed-da5ff2a414f4",
      "Sequence": 4,
      "PatternNumber": 5
    },
    "Type": 0,
    "Message": "sample string 18",
    "PaymentScheduleDateString": "sample string 19",
    "PaymentScheduleDate": "2023-09-22T17:21:11.277338+00:00",
    "PaymentImage": "sample string 21",
    "NoOfAllowance": 22,
    "AllowanceStartDateString": "sample string 23",
    "AllowanceEndDateString": "sample string 24",
    "FirstPaymentDateString": "sample string 25",
    "FirstPaymentDate": "2023-09-22T17:21:11.277338+00:00",
    "AllowanceStartDate": "2023-09-22T17:21:11.277338+00:00",
    "AllowanceEndDate": "2023-09-22T17:21:11.277338+00:00"
  },
  "ProductImage": "sample string 18"
}

application/xml, text/xml

Sample:

<UserInvite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <Allowance>
    <AllowanceAmount>15.1</AllowanceAmount>
    <AllowanceCurrency>sample string 16</AllowanceCurrency>
    <AllowanceDateTime>2023-09-22T17:21:11.277338+00:00</AllowanceDateTime>
    <AllowanceEndDate>2023-09-22T17:21:11.277338+00:00</AllowanceEndDate>
    <AllowanceEndDateString>sample string 24</AllowanceEndDateString>
    <AllowanceId>b7e93fac-a175-4cca-825d-748ac0e59b28</AllowanceId>
    <AllowanceName>sample string 9</AllowanceName>
    <AllowancePatternDetails>
      <AllowancePatternId>aae8fe83-09c9-4e12-870c-96b00c0218e7</AllowancePatternId>
      <AllowanceTypeId>b4deda76-e626-4720-9eed-da5ff2a414f4</AllowanceTypeId>
      <PatternName>sample string 2</PatternName>
      <PatternNumber>5</PatternNumber>
      <Sequence>4</Sequence>
    </AllowancePatternDetails>
    <AllowancePatternId>d16f35d3-036e-4e40-bfe0-ee21d1f8302b</AllowancePatternId>
    <AllowancePatternName>sample string 17</AllowancePatternName>
    <AllowanceStartDate>2023-09-22T17:21:11.277338+00:00</AllowanceStartDate>
    <AllowanceStartDateString>sample string 23</AllowanceStartDateString>
    <AllowanceTypeDetails>
      <AllowanceTypeId>23bea9e5-43c0-4b53-94ea-c4792ddc86c1</AllowanceTypeId>
      <AllowanceTypeName>sample string 2</AllowanceTypeName>
      <Sequence>3</Sequence>
    </AllowanceTypeDetails>
    <AllowanceTypeId>ee349c04-1d1a-4702-b8d0-7d644c388fcc</AllowanceTypeId>
    <FirstPaymentDate>2023-09-22T17:21:11.277338+00:00</FirstPaymentDate>
    <FirstPaymentDateString>sample string 25</FirstPaymentDateString>
    <Hours>12</Hours>
    <IsEnabled>true</IsEnabled>
    <Message>sample string 18</Message>
    <NoOfAllowance>22</NoOfAllowance>
    <PaymentImage>sample string 21</PaymentImage>
    <PaymentScheduleDate>2023-09-22T17:21:11.277338+00:00</PaymentScheduleDate>
    <PaymentScheduleDateString>sample string 19</PaymentScheduleDateString>
    <ReceiverCardId>748714b2-ecaf-4332-a106-14d2b6e16cb1</ReceiverCardId>
    <ReceiverFirstName>sample string 5</ReceiverFirstName>
    <ReceiverLastName>sample string 6</ReceiverLastName>
    <ReceiverMobile>sample string 8</ReceiverMobile>
    <ReceiverProfile>sample string 7</ReceiverProfile>
    <ReceiverUserId>e7022f5d-e6ab-4c82-9324-64e503b8767e</ReceiverUserId>
    <SenderCardId>89a96b03-52f5-4532-bbff-5d74d402e36f</SenderCardId>
    <SenderUserId>352e0fec-a4bd-44e5-87dd-75a418695eda</SenderUserId>
    <Type>Default</Type>
  </Allowance>
  <BankCardId>0631c9e0-cc48-441b-9875-e9ee92404c4e</BankCardId>
  <BankCardProcessId>b6944731-9d93-4dd6-a74d-a34d0a560828</BankCardProcessId>
  <BankCardProcessViewModel>
    <AppStatus>
      <Account_Id>sample string 12</Account_Id>
      <Alert_Reference>sample string 2</Alert_Reference>
      <AppData>sample string 17</AppData>
      <Application_Id>sample string 5</Application_Id>
      <CardName>sample string 14</CardName>
      <Customer_Id>sample string 11</Customer_Id>
      <DateCreated>2023-09-22T17:21:11.277338+00:00</DateCreated>
      <ID>ba8ba7d3-1843-461e-b089-e284739d0453</ID>
      <KYC>
        <Address1>sample string 24</Address1>
        <Address2>sample string 27</Address2>
        <ApplicationStatus>None</ApplicationStatus>
        <BankCardProcessID>00862dc2-263b-4357-8ade-c25a3d1ffbab</BankCardProcessID>
        <Building>sample string 26</Building>
        <CPR>sample string 14</CPR>
        <CPRExpiry>sample string 17</CPRExpiry>
        <CPRExpiry_Text>sample string 21</CPRExpiry_Text>
        <CPR_Front>sample string 18</CPR_Front>
        <CPR_Rear>sample string 19</CPR_Rear>
        <CardProcessStatus>73</CardProcessStatus>
        <City>sample string 63</City>
        <Company_Building_Name>sample string 66</Company_Building_Name>
        <Company_Flat_Number>sample string 67</Company_Flat_Number>
        <Country>sample string 23</Country>
        <DOB>sample string 3</DOB>
        <DOB_Text>sample string 11</DOB_Text>
        <EMP_Address1>sample string 38</EMP_Address1>
        <EMP_Income>sample string 34</EMP_Income>
        <EMP_Name>sample string 37</EMP_Name>
        <EMP_Position>sample string 32</EMP_Position>
        <EMP_Status>sample string 33</EMP_Status>
        <Email>sample string 8</Email>
        <Flat>sample string 25</Flat>
        <Gender>sample string 4</Gender>
        <IDCard_Front>sample string 39</IDCard_Front>
        <IDCard_Rear>sample string 40</IDCard_Rear>
        <IDRejectReason>sample string 16</IDRejectReason>
        <IDVerified>None</IDVerified>
        <IS_PEP>sample string 52</IS_PEP>
        <Is_US_Person>sample string 47</Is_US_Person>
        <KYC1Date>2023-09-22T17:21:11.277338+00:00</KYC1Date>
        <KYC2Date>2023-09-22T17:21:11.277338+00:00</KYC2Date>
        <KYC3Date>2023-09-22T17:21:11.277338+00:00</KYC3Date>
        <KYC4Date>2023-09-22T17:21:11.277338+00:00</KYC4Date>
        <KYCType>sample string 71</KYCType>
        <KYC_Image>sample string 58</KYC_Image>
        <KYC_ScanReference1>sample string 10</KYC_ScanReference1>
        <KYC_ScanReference2>sample string 20</KYC_ScanReference2>
        <KYC_Video>sample string 57</KYC_Video>
        <Mname>sample string 59</Mname>
        <Name_On_Card>sample string 9</Name_On_Card>
        <Nationality>sample string 5</Nationality>
        <PEP_Notes>sample string 53</PEP_Notes>
        <POA_FRONT>sample string 29</POA_FRONT>
        <POA_REAR>sample string 30</POA_REAR>
        <POB>sample string 13</POB>
        <PassExpiry>sample string 7</PassExpiry>
        <PassExpiry_Text>sample string 12</PassExpiry_Text>
        <Passport>sample string 6</Passport>
        <PassportFname>sample string 1</PassportFname>
        <PassportLname>sample string 2</PassportLname>
        <PassportRejectReason>sample string 15</PassportRejectReason>
        <PassportVerified>None</PassportVerified>
        <Passport_IMG>sample string 54</Passport_IMG>
        <Phone>sample string 28</Phone>
        <PostalCode>sample string 64</PostalCode>
        <Product_Id>sample string 56</Product_Id>
        <Profile_Id>sample string 55</Profile_Id>
        <Proof_Of_Address>sample string 31</Proof_Of_Address>
        <Purpose_Of_Account>sample string 36</Purpose_Of_Account>
        <REF_ID>sample string 22</REF_ID>
        <RenewKYCStatus>72</RenewKYCStatus>
        <Second_Nationality>sample string 51</Second_Nationality>
        <Source_Of_Income>sample string 35</Source_Of_Income>
        <State>sample string 70</State>
        <TIN_1>sample string 48</TIN_1>
        <Tax_Note_1>sample string 50</Tax_Note_1>
        <Tax_Status_1>sample string 49</Tax_Status_1>
        <UpdateKYCModel>
          <KYC_AdditionalInfo>true</KYC_AdditionalInfo>
          <KYC_ID>true</KYC_ID>
          <KYC_POA>true</KYC_POA>
          <KYC_Passport>true</KYC_Passport>
          <UpdateKYCText>sample string 5</UpdateKYCText>
        </UpdateKYCModel>
        <VisaExpiry>sample string 60</VisaExpiry>
        <VisaExpiry_Text>sample string 62</VisaExpiry_Text>
        <Visa_IMG>sample string 61</Visa_IMG>
        <company_city>sample string 65</company_city>
        <company_country>sample string 45</company_country>
        <company_postalcode>sample string 69</company_postalcode>
        <company_state>sample string 68</company_state>
        <country_residence>sample string 41</country_residence>
        <expected_monthly_balance>sample string 43</expected_monthly_balance>
        <industry_type>sample string 42</industry_type>
        <monthly_salary>sample string 44</monthly_salary>
        <place_of_issuance>sample string 46</place_of_issuance>
      </KYC>
      <KYC_ScanReference1>sample string 15</KYC_ScanReference1>
      <KYC_ScanReference2>sample string 16</KYC_ScanReference2>
      <Note>sample string 10</Note>
      <Reason>sample string 8</Reason>
      <Reason_Label>sample string 9</Reason_Label>
      <Status>sample string 6</Status>
      <Status_Label>sample string 7</Status_Label>
      <Timestamp>sample string 3</Timestamp>
      <Type>sample string 4</Type>
      <UpdatedNote>sample string 18</UpdatedNote>
      <UserID>cf487a2b-a607-4ca9-bddb-a585e2f96b62</UserID>
    </AppStatus>
    <ApplicationID>sample string 5</ApplicationID>
    <BankBinSponsorID>3</BankBinSponsorID>
    <BankCardID>528bd059-0907-429d-9540-bfed4291cae0</BankCardID>
    <BankCardTopupID>75621e91-686d-4765-adec-494d3128714a</BankCardTopupID>
    <Country>10</Country>
    <CurrencyId>7</CurrencyId>
    <DateSubmitted>2023-09-22T17:21:11.277338+00:00</DateSubmitted>
    <GCCType>9</GCCType>
    <ID>aa805d30-e4a6-4e26-a61c-138c100d03b4</ID>
    <IsChildOTPVerified>true</IsChildOTPVerified>
    <IsExists>true</IsExists>
    <Note>sample string 8</Note>
    <ProductId>677de510-e150-44aa-991d-b8914c9a1de0</ProductId>
    <StatusTypeID>4</StatusTypeID>
    <UserID>bdff2639-83f7-4be2-a3cf-6e37f404d89b</UserID>
  </BankCardProcessViewModel>
  <CountryId>12</CountryId>
  <CurrencyId>16</CurrencyId>
  <DateCreated>2023-09-22T17:21:11.277338+00:00</DateCreated>
  <DateOfBirth>2023-09-22T17:21:11.277338+00:00</DateOfBirth>
  <DateUpdated>2023-09-22T17:21:11.277338+00:00</DateUpdated>
  <Email>sample string 9</Email>
  <FamilyName>sample string 4</FamilyName>
  <ID>82506a41-b3ed-4340-8a8c-5f1b36446c06</ID>
  <IsChildOTPVerified>true</IsChildOTPVerified>
  <Mobile>sample string 8</Mobile>
  <MobileExtension>sample string 7</MobileExtension>
  <NameOfChild>sample string 3</NameOfChild>
  <NickName>sample string 2</NickName>
  <ParentCardId>b565f574-81b4-422c-a756-af1cf4f507e1</ParentCardId>
  <ParentUserId>c3453b74-673d-4059-a188-50f47074c807</ParentUserId>
  <ProductId>2c2830ef-a4d3-42a8-abae-4ac4d7162a56</ProductId>
  <ProductImage>sample string 18</ProductImage>
  <ProfileImageName>sample string 10</ProfileImageName>
  <ReceiverId>37a9533d-07cf-4652-8edd-66858e9941fe</ReceiverId>
  <Reletionship>sample string 5</Reletionship>
  <Status>sample string 11</Status>
  <StatusTypeId>Default</StatusTypeId>
  <UserId>9b36b6b5-2fb7-4751-acbf-f7e6d519ac9f</UserId>
  <termsConditionId>3583a802-4851-4d7d-9647-9704b948be31</termsConditionId>
</UserInvite>

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

Response Information

Resource Description

ResponseViewModel

Name	Type	Additional information
Status	boolean	None.
StatusCode	integer	None.
Message	string	None.
Data	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": true,
  "StatusCode": 2,
  "Message": "sample string 3",
  "Data": {}
}

application/xml, text/xml

Sample:

<ResponseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bankiom.DataLayer.Common">
  <Data />
  <Message>sample string 3</Message>
  <Status>true</Status>
  <StatusCode>2</StatusCode>
</ResponseViewModel>