POST Client/GetClientVerification

Checks if the Client qualifies to do a specfic transaction.

Request Information

URI Parameters

None.

Body Parameters

ApiClientVerificationRequestFilter
NameDescriptionTypeAdditional information
ClientId

Gets or sets the client search string.

 integer

None.
VerficationTypeId

Gets or sets the client search string.

 integer

None.
userID

Gets or sets the user identifier.

 integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "ClientId": 1,
  "VerficationTypeId": 2,
  "userID": 3
}

application/xml, text/xml

Sample: 
<ApiClientVerificationRequestFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <userID>3</userID>
  <ClientId>1</ClientId>
  <VerficationTypeId>2</VerficationTypeId>
</ApiClientVerificationRequestFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiClientVerification
NameDescriptionTypeAdditional information
VerficationStatus

Gets or sets the response object.

 integer

None.
Message

Gets or sets the response object.

 string

None.
ResponseType

Gets or sets the type of the response.

 integer

None.
ResponseMessage

Gets or sets the response message.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "VerficationStatus": 1,
  "Message": "sample string 2",
  "ResponseType": 3,
  "ResponseMessage": "sample string 4"
}

application/xml, text/xml

Sample: 
<ApiClientVerification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <ResponseMessage>sample string 4</ResponseMessage>
  <ResponseType>3</ResponseType>
  <Message>sample string 2</Message>
  <VerficationStatus>1</VerficationStatus>
</ApiClientVerification>