POST api/RemitexAmlCustomerScreening?companyname={companyname}&username={username}&password={password}&generatePayload={generatePayload}

Request Information

URI Parameters

Name	Type	Additional information
companyname	string	Required
username	string	Required
password	string	Required
generatePayload	string	Required

Body Parameters

ScreeningApiRequest

Name	Type	Additional information
UserId	string	None.
CompanyName	string	None.
CustomerId	string	None.
CustomerType	string	None.
FirstName	string	None.
MiddleName	string	None.
LastName	string	None.
Gender	string	None.
DOB	string	None.
NationalityISOList	Collection of string	None.
PlaceOfBirth	string	None.
CustomerIdType	string	None.
CustomerIdNumber	string	None.
CustomerIdExpiry	string	None.
MatchCategory	string	None.
CompanyCode	string	None.
SourceCode	string	None.
ScreeningPreset	string	None.
EmailIds	string	None.
ReplyBackEmailIds	string	None.
Threshold	integer	None.
OtherParameters	OtherParameters	None.
Datasets	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserId": "sample string 1",
  "CompanyName": "sample string 2",
  "CustomerId": "sample string 3",
  "CustomerType": "sample string 4",
  "FirstName": "sample string 5",
  "MiddleName": "sample string 6",
  "LastName": "sample string 7",
  "Gender": "sample string 8",
  "DOB": "sample string 9",
  "NationalityISOList": [
    "sample string 1",
    "sample string 2"
  ],
  "PlaceOfBirth": "sample string 10",
  "CustomerIdType": "sample string 11",
  "CustomerIdNumber": "sample string 12",
  "CustomerIdExpiry": "sample string 13",
  "MatchCategory": "sample string 14",
  "CompanyCode": "sample string 15",
  "SourceCode": "sample string 16",
  "ScreeningPreset": "sample string 17",
  "EmailIds": "sample string 18",
  "ReplyBackEmailIds": "sample string 19",
  "Threshold": 20,
  "OtherParameters": {
    "Header1": "sample string 1",
    "Header2": "sample string 2",
    "Header3": "sample string 3",
    "Header4": "sample string 4",
    "Header5": "sample string 5"
  },
  "Datasets": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:

{"UserId":"sample string 1","CompanyName":"sample string 2","CustomerId":"sample string 3","CustomerType":"sample string 4","FirstName":"sample string 5","MiddleName":"sample string 6","LastName":"sample string 7","Gender":"sample string 8","DOB":"sample string 9","NationalityISOList":["sample string 1","sample string 2"],"PlaceOfBirth":"sample string 10","CustomerIdType":"sample string 11","CustomerIdNumber":"sample string 12","CustomerIdExpiry":"sample string 13","MatchCategory":"sample string 14","CompanyCode":"sample string 15","SourceCode":"sample string 16","ScreeningPreset":"sample string 17","EmailIds":"sample string 18","ReplyBackEmailIds":"sample string 19","Threshold":20,"OtherParameters":{"Header1":"sample string 1","Header2":"sample string 2","Header3":"sample string 3","Header4":"sample string 4","Header5":"sample string 5"},"Datasets":["sample string 1","sample string 2"]}

application/xml, text/xml

Sample:

<ScreeningApiRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <UserId>sample string 1</UserId>
  <CompanyName>sample string 2</CompanyName>
  <CustomerId>sample string 3</CustomerId>
  <CustomerType>sample string 4</CustomerType>
  <FirstName>sample string 5</FirstName>
  <MiddleName>sample string 6</MiddleName>
  <LastName>sample string 7</LastName>
  <Gender>sample string 8</Gender>
  <DOB>sample string 9</DOB>
  <NationalityISOList>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </NationalityISOList>
  <PlaceOfBirth>sample string 10</PlaceOfBirth>
  <CustomerIdType>sample string 11</CustomerIdType>
  <CustomerIdNumber>sample string 12</CustomerIdNumber>
  <CustomerIdExpiry>sample string 13</CustomerIdExpiry>
  <MatchCategory>sample string 14</MatchCategory>
  <CompanyCode>sample string 15</CompanyCode>
  <SourceCode>sample string 16</SourceCode>
  <ScreeningPreset>sample string 17</ScreeningPreset>
  <EmailIds>sample string 18</EmailIds>
  <ReplyBackEmailIds>sample string 19</ReplyBackEmailIds>
  <Threshold>20</Threshold>
  <OtherParameters>
    <Header1>sample string 1</Header1>
    <Header2>sample string 2</Header2>
    <Header3>sample string 3</Header3>
    <Header4>sample string 4</Header4>
    <Header5>sample string 5</Header5>
  </OtherParameters>
  <Datasets>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Datasets>
</ScreeningApiRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="UserId"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CompanyName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CustomerId"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CustomerType"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="FirstName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MiddleName"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="LastName"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Gender"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DOB"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="NationalityISOList[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="NationalityISOList[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PlaceOfBirth"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CustomerIdType"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CustomerIdNumber"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CustomerIdExpiry"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="MatchCategory"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CompanyCode"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SourceCode"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ScreeningPreset"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EmailIds"

sample string 18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ReplyBackEmailIds"

sample string 19
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Threshold"

20
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OtherParameters.Header1"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OtherParameters.Header2"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OtherParameters.Header3"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OtherParameters.Header4"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OtherParameters.Header5"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Datasets[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Datasets[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ScreeningApiResponse

Name	Type	Additional information
isMatched	string	None.
matchScore	integer	None.
customerId	string	None.
caseId	integer	None.
matchedDatasets	Collection of string	None.
highestScoringResult	HighestScoringResult	None.

Response Formats

application/json, text/json

Sample:

{
  "isMatched": "sample string 1",
  "matchScore": 2,
  "customerId": "sample string 3",
  "caseId": 4,
  "matchedDatasets": [
    "sample string 1",
    "sample string 2"
  ],
  "highestScoringResult": {
    "id": "sample string 1",
    "primaryName": "sample string 2",
    "matchedName": "sample string 3",
    "nationality": "sample string 4",
    "dob": "sample string 5",
    "datasets": [
      "sample string 1",
      "sample string 2"
    ],
    "isPEP": true
  }
}

text/html

Sample:

{"isMatched":"sample string 1","matchScore":2,"customerId":"sample string 3","caseId":4,"matchedDatasets":["sample string 1","sample string 2"],"highestScoringResult":{"id":"sample string 1","primaryName":"sample string 2","matchedName":"sample string 3","nationality":"sample string 4","dob":"sample string 5","datasets":["sample string 1","sample string 2"],"isPEP":true}}

application/xml, text/xml

Sample:

<ScreeningApiResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <isMatched>sample string 1</isMatched>
  <matchScore>2</matchScore>
  <customerId>sample string 3</customerId>
  <caseId>4</caseId>
  <matchedDatasets>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </matchedDatasets>
  <highestScoringResult>
    <id>sample string 1</id>
    <primaryName>sample string 2</primaryName>
    <matchedName>sample string 3</matchedName>
    <nationality>sample string 4</nationality>
    <dob>sample string 5</dob>
    <datasets>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </datasets>
    <isPEP>true</isPEP>
  </highestScoringResult>
</ScreeningApiResponse>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="isMatched"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="matchScore"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="customerId"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="caseId"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="matchedDatasets[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="matchedDatasets[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="highestScoringResult.id"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="highestScoringResult.primaryName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="highestScoringResult.matchedName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="highestScoringResult.nationality"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="highestScoringResult.dob"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="highestScoringResult.datasets[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="highestScoringResult.datasets[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="highestScoringResult.isPEP"

True
--MultipartDataMediaFormatterBoundary1q2w3e--