POST Api/Validate/Verify/ID/Origin

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
IDCard		IDCardDetail	None.

Request Formats

application/json, text/json

Sample:

{
  "IDCard": {
    "IDNumber": "sample string 1",
    "IDType": 2,
    "FirstName": "sample string 3",
    "MiddleName": "sample string 4",
    "LastName": "sample string 5",
    "IDColour": "sample string 6",
    "IDRefNumber": "sample string 7",
    "IDStateCode": "sample string 8",
    "IDCountry": 1,
    "IDExpiryDate": "sample string 9",
    "CardNumber": "sample string 10",
    "DateOfBirth": "sample string 11",
    "CacheKey": "sample string 12",
    "StatusValidation": "sample string 13"
  }
}

application/xml, text/xml

Sample:

<ParamValidateIDOrigin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.NewSales.Parameters">
  <IDCard>
    <CacheKey>sample string 12</CacheKey>
    <CardNumber>sample string 10</CardNumber>
    <DateOfBirth>sample string 11</DateOfBirth>
    <FirstName>sample string 3</FirstName>
    <IDColour>sample string 6</IDColour>
    <IDCountry>1</IDCountry>
    <IDExpiryDate>sample string 9</IDExpiryDate>
    <IDNumber>sample string 1</IDNumber>
    <IDRefNumber>sample string 7</IDRefNumber>
    <IDStateCode>sample string 8</IDStateCode>
    <IDType>2</IDType>
    <LastName>sample string 5</LastName>
    <MiddleName>sample string 4</MiddleName>
    <StatusValidation>sample string 13</StatusValidation>
  </IDCard>
</ParamValidateIDOrigin>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultOfCustomVerifyIDResult

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
ErrorMessage	Collection of string	None.
Value	CustomVerifyIDResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Message": "sample string 2",
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Value": {
    "CacheKey": "sample string 1",
    "VerificationResult": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<ResultOfCustomVerifyIDResultPThmUsj9 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Models.Common.Returns">
  <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessage>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Value xmlns:d2p1="http://schemas.datacontract.org/2004/07/GoSwitch.CustomerTools.Logic.Integration.Origin.Model">
    <d2p1:CacheKey>sample string 1</d2p1:CacheKey>
    <d2p1:VerificationResult>sample string 2</d2p1:VerificationResult>
  </Value>
</ResultOfCustomVerifyIDResultPThmUsj9>