GET api/Screening?CustomerName={CustomerName}&MinimumPercentage={MinimumPercentage}&SearchFor={SearchFor}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CustomerName

string

Required

MinimumPercentage

integer

Required

SearchFor

string

Required

Body Parameters

Collection of ScreeningModelOfString
NameDescriptionTypeAdditional information
RecordType

string

None.

RecordUniqueId

string

None.

EntityType

string

None.

Name

string

None.

FatherName

string

None.

DateOfBirth

string

None.

CititzenshipNumber

string

None.

PANNumber

string

None.

PassportNumber

string

None.

CompanyRegistrationNumber

string

None.

Country

string

None.

Alias

string

None.

Choice

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "RecordType": "sample string 1",
    "RecordUniqueId": "sample string 2",
    "EntityType": "sample string 3",
    "Name": "sample string 4",
    "FatherName": "sample string 5",
    "DateOfBirth": "sample string 6",
    "CititzenshipNumber": "sample string 7",
    "PANNumber": "sample string 8",
    "PassportNumber": "sample string 9",
    "CompanyRegistrationNumber": "sample string 10",
    "Country": "sample string 11",
    "Alias": "sample string 12",
    "Choice": "sample string 13"
  },
  {
    "RecordType": "sample string 1",
    "RecordUniqueId": "sample string 2",
    "EntityType": "sample string 3",
    "Name": "sample string 4",
    "FatherName": "sample string 5",
    "DateOfBirth": "sample string 6",
    "CititzenshipNumber": "sample string 7",
    "PANNumber": "sample string 8",
    "PassportNumber": "sample string 9",
    "CompanyRegistrationNumber": "sample string 10",
    "Country": "sample string 11",
    "Alias": "sample string 12",
    "Choice": "sample string 13"
  }
]

application/xml, text/xml

Sample:
<ArrayOfScreeningModelOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KYCAML.SearchingHelper.Model">
  <ScreeningModelOfstring>
    <Alias>sample string 12</Alias>
    <Choice>sample string 13</Choice>
    <CititzenshipNumber>sample string 7</CititzenshipNumber>
    <CompanyRegistrationNumber>sample string 10</CompanyRegistrationNumber>
    <Country>sample string 11</Country>
    <DateOfBirth>sample string 6</DateOfBirth>
    <EntityType>sample string 3</EntityType>
    <FatherName>sample string 5</FatherName>
    <Name>sample string 4</Name>
    <PANNumber>sample string 8</PANNumber>
    <PassportNumber>sample string 9</PassportNumber>
    <RecordType>sample string 1</RecordType>
    <RecordUniqueId>sample string 2</RecordUniqueId>
  </ScreeningModelOfstring>
  <ScreeningModelOfstring>
    <Alias>sample string 12</Alias>
    <Choice>sample string 13</Choice>
    <CititzenshipNumber>sample string 7</CititzenshipNumber>
    <CompanyRegistrationNumber>sample string 10</CompanyRegistrationNumber>
    <Country>sample string 11</Country>
    <DateOfBirth>sample string 6</DateOfBirth>
    <EntityType>sample string 3</EntityType>
    <FatherName>sample string 5</FatherName>
    <Name>sample string 4</Name>
    <PANNumber>sample string 8</PANNumber>
    <PassportNumber>sample string 9</PassportNumber>
    <RecordType>sample string 1</RecordType>
    <RecordUniqueId>sample string 2</RecordUniqueId>
  </ScreeningModelOfstring>
</ArrayOfScreeningModelOfstring>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ExtractedResultOfString
NameDescriptionTypeAdditional information
Value

string

None.

Score

integer

None.

Index

integer

None.

RecordType

string

None.

RecordUniqueId

string

None.

EntityType

string

None.

Name

string

None.

DateOfBirth

string

None.

Country

string

None.

SearchFor

string

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.