POST api/KYC/GenerateAadhaarEsignURL

Request Information

URI Parameters

None.

Body Parameters

AadharEsignInputInfo
NameDescriptionTypeAdditional information
merchantId

string

None.

inputData

AadharEsignInputData

None.

authorization

string

None.

IFAID

string

None.

MembID

integer

None.

fromMobile

string

None.

Request Formats

application/json, text/json

Sample:
{
  "merchantId": "sample string 1",
  "inputData": {
    "service": "sample string 1",
    "type": "sample string 2",
    "task": "sample string 3",
    "data": {
      "inputFile": "sample string 1",
      "signatureType": "sample string 2",
      "redirectUrl": "sample string 3"
    }
  },
  "authorization": "sample string 2",
  "IFAID": "sample string 3",
  "MembID": 4,
  "fromMobile": "sample string 5"
}

application/xml, text/xml

Sample:
<AadharEsignInputInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Datacomp.AppServices.UI.WM.WMVideoKYCWrapper.Models">
  <IFAID>sample string 3</IFAID>
  <MembID>4</MembID>
  <authorization>sample string 2</authorization>
  <fromMobile>sample string 5</fromMobile>
  <inputData>
    <data>
      <inputFile>sample string 1</inputFile>
      <redirectUrl>sample string 3</redirectUrl>
      <signatureType>sample string 2</signatureType>
    </data>
    <service>sample string 1</service>
    <task>sample string 3</task>
    <type>sample string 2</type>
  </inputData>
  <merchantId>sample string 1</merchantId>
</AadharEsignInputInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AadharEsignOutputInfo
NameDescriptionTypeAdditional information
Object

AadharEsignObject

None.

error

Error

None.

statusCode

integer

None.

name

string

None.

message

string

None.

code

string

None.

ResponseCode

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Object": {
    "task": "sample string 1",
    "id": "sample string 2",
    "customerId": "sample string 3",
    "inputFile": "sample string 4",
    "signatureType": "sample string 5",
    "multiPages": "sample string 6",
    "name": "sample string 7",
    "showSignatureConsent": "sample string 8",
    "email": "sample string 9",
    "redirectUrl": "sample string 10",
    "consentText": "sample string 11",
    "createSignatureOptions": [
      {},
      {}
    ],
    "result": {
      "token": "sample string 1",
      "isUsed": 2,
      "url": "sample string 3",
      "uid": "sample string 4",
      "inputFile": "sample string 5",
      "email": "sample string 6",
      "createSignatureOptions": [
        "sample string 1",
        "sample string 2"
      ],
      "signatureType": "sample string 7",
      "name": "sample string 8",
      "showSignatureConsent": "sample string 9",
      "scaleSignature": "sample string 10",
      "selectPage": "sample string 11",
      "signaturePosition": "sample string 12",
      "pageNo": "sample string 13"
    }
  },
  "error": {
    "name": "sample string 1",
    "status": 2,
    "message": "sample string 3",
    "statusCode": 4,
    "details": [
      {
        "field": "sample string 1",
        "context": "sample string 2",
        "codes": {
          "username": [
            "sample string 1",
            "sample string 2"
          ]
        },
        "messages": {
          "username": [
            "sample string 1",
            "sample string 2"
          ]
        }
      },
      {
        "field": "sample string 1",
        "context": "sample string 2",
        "codes": {
          "username": [
            "sample string 1",
            "sample string 2"
          ]
        },
        "messages": {
          "username": [
            "sample string 1",
            "sample string 2"
          ]
        }
      }
    ]
  },
  "statusCode": 1,
  "name": "sample string 2",
  "message": "sample string 3",
  "code": "sample string 4",
  "ResponseCode": "sample string 5"
}

application/xml, text/xml

Sample:
<AadharEsignOutputInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Datacomp.AppServices.UI.WM.WMVideoKYCWrapper.Models">
  <ResponseCode>sample string 5</ResponseCode>
  <Object>
    <consentText>sample string 11</consentText>
    <createSignatureOptions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </createSignatureOptions>
    <customerId>sample string 3</customerId>
    <email>sample string 9</email>
    <id>sample string 2</id>
    <inputFile>sample string 4</inputFile>
    <multiPages>sample string 6</multiPages>
    <name>sample string 7</name>
    <redirectUrl>sample string 10</redirectUrl>
    <result>
      <createSignatureOptions xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </createSignatureOptions>
      <email>sample string 6</email>
      <inputFile>sample string 5</inputFile>
      <isUsed>2</isUsed>
      <name>sample string 8</name>
      <pageNo>sample string 13</pageNo>
      <scaleSignature>sample string 10</scaleSignature>
      <selectPage>sample string 11</selectPage>
      <showSignatureConsent>sample string 9</showSignatureConsent>
      <signaturePosition>sample string 12</signaturePosition>
      <signatureType>sample string 7</signatureType>
      <token>sample string 1</token>
      <uid>sample string 4</uid>
      <url>sample string 3</url>
    </result>
    <showSignatureConsent>sample string 8</showSignatureConsent>
    <signatureType>sample string 5</signatureType>
    <task>sample string 1</task>
  </Object>
  <code>sample string 4</code>
  <error>
    <details>
      <Details>
        <codes>
          <username xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </username>
        </codes>
        <context>sample string 2</context>
        <field>sample string 1</field>
        <messages>
          <username xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </username>
        </messages>
      </Details>
      <Details>
        <codes>
          <username xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </username>
        </codes>
        <context>sample string 2</context>
        <field>sample string 1</field>
        <messages>
          <username xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </username>
        </messages>
      </Details>
    </details>
    <message>sample string 3</message>
    <name>sample string 1</name>
    <status>2</status>
    <statusCode>4</statusCode>
  </error>
  <message>sample string 3</message>
  <name>sample string 2</name>
  <statusCode>1</statusCode>
</AadharEsignOutputInfo>