POST api/Onboarding/InitiateKYC

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
KYCData	KYCRootObject	None.
investor_id	string	None.
mobile_number	string	None.
token	string	None.
IFAID	string	None.
IFAKey	string	None.

Request Formats

application/json, text/json

Sample:

{
  "KYCData": {
    "params": {
      "user_id": "sample string 1"
    },
    "fields": {
      "kyc_details": {
        "name": "sample string 1",
        "pan_number": "sample string 2",
        "aadhar_number": "sample string 3",
        "mobile_number": "sample string 4",
        "date_of_birth": "sample string 5"
      },
      "user_id": "sample string 1",
      "vendor_key": "sample string 2",
      "redirection_url": "sample string 3"
    },
    "json": {},
    "attributes": {
      "Authorization": "sample string 1"
    },
    "api_code": "sample string 2"
  },
  "investor_id": "sample string 1",
  "mobile_number": "sample string 2",
  "token": "sample string 3",
  "IFAID": "sample string 4",
  "IFAKey": "sample string 5"
}

application/xml, text/xml

Sample:

<KYCInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LendenWrapper.Models">
  <IFAID>sample string 4</IFAID>
  <IFAKey>sample string 5</IFAKey>
  <KYCData>
    <api_code>sample string 2</api_code>
    <attributes>
      <Authorization>sample string 1</Authorization>
    </attributes>
    <fields>
      <kyc_details>
        <aadhar_number>sample string 3</aadhar_number>
        <date_of_birth>sample string 5</date_of_birth>
        <mobile_number>sample string 4</mobile_number>
        <name>sample string 1</name>
        <pan_number>sample string 2</pan_number>
      </kyc_details>
      <redirection_url>sample string 3</redirection_url>
      <user_id>sample string 1</user_id>
      <vendor_key>sample string 2</vendor_key>
    </fields>
    <json />
    <params>
      <user_id>sample string 1</user_id>
    </params>
  </KYCData>
  <investor_id>sample string 1</investor_id>
  <mobile_number>sample string 2</mobile_number>
  <token>sample string 3</token>
</KYCInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

KYCOutputModel

Name	Type	Additional information
KYCURL	string	None.
TrackID	string	None.
Status	string	None.
Message	string	None.
LCResponse	LCResponse	None.
IFAID	string	None.
IFAKey	string	None.

Response Formats

application/json, text/json

Sample:

{
  "KYCURL": "sample string 1",
  "TrackID": "sample string 2",
  "Status": "sample string 3",
  "Message": "sample string 4",
  "LCResponse": {
    "code": "sample string 1",
    "message": "sample string 2",
    "Data": {
      "checksum": "sample string 1",
      "payload": "sample string 2"
    },
    "IFAID": "sample string 3",
    "IFAKey": "sample string 4"
  },
  "IFAID": "sample string 5",
  "IFAKey": "sample string 6"
}

application/xml, text/xml

Sample:

<KYCOutputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LendenWrapper.Models">
  <IFAID>sample string 5</IFAID>
  <IFAKey>sample string 6</IFAKey>
  <LCResponse>
    <IFAID>sample string 3</IFAID>
    <IFAKey>sample string 4</IFAKey>
    <Data>
      <checksum>sample string 1</checksum>
      <payload>sample string 2</payload>
    </Data>
    <code>sample string 1</code>
    <message>sample string 2</message>
  </LCResponse>
  <Message>sample string 4</Message>
  <Status>sample string 3</Status>
  <KYCURL>sample string 1</KYCURL>
  <TrackID>sample string 2</TrackID>
</KYCOutputModel>