POST api/screening/SearchCustomerByName

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ScreeningCode	string	Required String length: inclusive between 0 and 100
BranchCode	string	Required String length: inclusive between 0 and 5
CustomerNumber	string	String length: inclusive between 0 and 100
RelatedCustomerNumber	string	String length: inclusive between 0 and 20
SearchFor	string	Required String length: inclusive between 0 and 200
CustomerUniqueId	globally unique identifier	None.
CustomerName	string	Required String length: inclusive between 0 and 500
SearchedName	string	Required String length: inclusive between 0 and 500
Gender	string	String length: inclusive between 0 and 10
Country	string	Required String length: inclusive between 0 and 200
DateOfBirth	date	None.
CititzenshipNumber	string	String length: inclusive between 0 and 200
CitizenshipIssuedDate	date	None.
CitizenshipIssuedDistrict	string	String length: inclusive between 0 and 200
PassportNumber	string	String length: inclusive between 0 and 200
IndianEmbassyNumber	string	String length: inclusive between 0 and 200
PANNumber	string	String length: inclusive between 0 and 200
CompanyRegistrationNumber	string	String length: inclusive between 0 and 200
CompanyRegistrationDate	date	None.
CompanyRegistrationAuth	string	String length: inclusive between 0 and 500
Function	string	String length: inclusive between 0 and 200
GrandFatherName	string	String length: inclusive between 0 and 500
FatherName	string	String length: inclusive between 0 and 500
MotherName	string	String length: inclusive between 0 and 500
SpouseName	string	String length: inclusive between 0 and 500
TotalRecordsMatched	integer	None.
Channel	string	String length: inclusive between 0 and 200
ScreeningStatus	string	None.
AlreadyScreened	boolean	None.
MinimumPercentage	integer	None.
RedirectionLink	string	None.
ScreeningBulkUploadId	globally unique identifier	None.
OnBoarding	integer	None.
screeningSearchDetailList	Collection of ScreeningSearchDetailDTO	None.
SiblingAndRelatedParty	string	None.
IsSuccessfullyAPIExecuted	boolean	None.
ExceptionMessage	string	None.
Id	globally unique identifier	None.
CreatedById	globally unique identifier	None.
CreatedBy	string	None.
ModifiedById	globally unique identifier	None.
ModifiedBy	string	None.
AuthorisedById	globally unique identifier	None.
AuthorisedBy	string	None.
CreatedDate	date	None.
ModifiedDate	date	None.
AuthorisedDate	date	None.
Record_Status	Record_Status	None.
RecordStatus	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ScreeningCode": "sample string 1",
  "BranchCode": "sample string 2",
  "CustomerNumber": "sample string 3",
  "RelatedCustomerNumber": "sample string 4",
  "SearchFor": "sample string 5",
  "CustomerUniqueId": "4d10c530-3c48-4016-8eb1-d5cf7171f214",
  "CustomerName": "sample string 7",
  "SearchedName": "sample string 8",
  "Gender": "sample string 9",
  "Country": "sample string 10",
  "DateOfBirth": "2026-03-16T09:26:43.8841561+05:45",
  "CititzenshipNumber": "sample string 11",
  "CitizenshipIssuedDate": "2026-03-16T09:26:43.8997638+05:45",
  "CitizenshipIssuedDistrict": "sample string 12",
  "PassportNumber": "sample string 13",
  "IndianEmbassyNumber": "sample string 14",
  "PANNumber": "sample string 15",
  "CompanyRegistrationNumber": "sample string 16",
  "CompanyRegistrationDate": "2026-03-16T09:26:43.8997638+05:45",
  "CompanyRegistrationAuth": "sample string 17",
  "Function": "sample string 18",
  "GrandFatherName": "sample string 19",
  "FatherName": "sample string 20",
  "MotherName": "sample string 21",
  "SpouseName": "sample string 22",
  "TotalRecordsMatched": 23,
  "Channel": "sample string 24",
  "ScreeningStatus": "sample string 25",
  "AlreadyScreened": true,
  "MinimumPercentage": 27,
  "RedirectionLink": "sample string 28",
  "ScreeningBulkUploadId": "9bd9df65-a9ac-4283-99e3-5d29638a2ea7",
  "OnBoarding": 29,
  "screeningSearchDetailList": [
    {
      "ScreeningSearchSetupId": "af32961b-4736-4be8-9dee-e6eb3dc63d81",
      "ScreeningUniqueId": "sample string 2",
      "SearchType": "sample string 3",
      "MatchedName": "sample string 4",
      "MatchCountry": "sample string 5",
      "MatchDateOfBirth": "sample string 6",
      "MatchFunction": "sample string 7",
      "MatchNameAccuracy": 8.1,
      "ScreeningAction": "sample string 9",
      "ScreeningDetails": "sample string 10",
      "SearchFor": "sample string 11",
      "ScreeningOrder": 12,
      "Remarks": "sample string 13",
      "ScreeningConfirmationHistories": [
        {
          "Id": "c1f483c3-0ed5-46e5-8b64-9e8593c66b5b",
          "ScreeningSearchDetailId": "036af84e-0bb9-474d-8b2b-983184022653",
          "Remarks": "sample string 3",
          "Username": "sample string 4",
          "UserId": "87662381-7b92-44fd-8b1e-56db6d481f3b",
          "CreatedDate": "2026-03-16T09:26:43.8997638+05:45"
        },
        {
          "Id": "c1f483c3-0ed5-46e5-8b64-9e8593c66b5b",
          "ScreeningSearchDetailId": "036af84e-0bb9-474d-8b2b-983184022653",
          "Remarks": "sample string 3",
          "Username": "sample string 4",
          "UserId": "87662381-7b92-44fd-8b1e-56db6d481f3b",
          "CreatedDate": "2026-03-16T09:26:43.8997638+05:45"
        }
      ],
      "Id": "b166f972-937c-4c2e-aa6e-bbfcbb1d2b7d",
      "CreatedById": "20428036-27e2-4402-9a85-793d67fc545f",
      "CreatedBy": "sample string 16",
      "ModifiedById": "c587fac1-147f-40ff-8af5-28db8e01e899",
      "ModifiedBy": "sample string 18",
      "AuthorisedById": "2fe65545-4c5c-4600-a117-fb6b5110e6f2",
      "AuthorisedBy": "sample string 19",
      "CreatedDate": "2026-03-16T09:26:43.8997638+05:45",
      "ModifiedDate": "2026-03-16T09:26:43.8997638+05:45",
      "AuthorisedDate": "2026-03-16T09:26:43.8997638+05:45",
      "Record_Status": 1,
      "RecordStatus": 22
    },
    {
      "ScreeningSearchSetupId": "af32961b-4736-4be8-9dee-e6eb3dc63d81",
      "ScreeningUniqueId": "sample string 2",
      "SearchType": "sample string 3",
      "MatchedName": "sample string 4",
      "MatchCountry": "sample string 5",
      "MatchDateOfBirth": "sample string 6",
      "MatchFunction": "sample string 7",
      "MatchNameAccuracy": 8.1,
      "ScreeningAction": "sample string 9",
      "ScreeningDetails": "sample string 10",
      "SearchFor": "sample string 11",
      "ScreeningOrder": 12,
      "Remarks": "sample string 13",
      "ScreeningConfirmationHistories": [
        {
          "Id": "c1f483c3-0ed5-46e5-8b64-9e8593c66b5b",
          "ScreeningSearchDetailId": "036af84e-0bb9-474d-8b2b-983184022653",
          "Remarks": "sample string 3",
          "Username": "sample string 4",
          "UserId": "87662381-7b92-44fd-8b1e-56db6d481f3b",
          "CreatedDate": "2026-03-16T09:26:43.8997638+05:45"
        },
        {
          "Id": "c1f483c3-0ed5-46e5-8b64-9e8593c66b5b",
          "ScreeningSearchDetailId": "036af84e-0bb9-474d-8b2b-983184022653",
          "Remarks": "sample string 3",
          "Username": "sample string 4",
          "UserId": "87662381-7b92-44fd-8b1e-56db6d481f3b",
          "CreatedDate": "2026-03-16T09:26:43.8997638+05:45"
        }
      ],
      "Id": "b166f972-937c-4c2e-aa6e-bbfcbb1d2b7d",
      "CreatedById": "20428036-27e2-4402-9a85-793d67fc545f",
      "CreatedBy": "sample string 16",
      "ModifiedById": "c587fac1-147f-40ff-8af5-28db8e01e899",
      "ModifiedBy": "sample string 18",
      "AuthorisedById": "2fe65545-4c5c-4600-a117-fb6b5110e6f2",
      "AuthorisedBy": "sample string 19",
      "CreatedDate": "2026-03-16T09:26:43.8997638+05:45",
      "ModifiedDate": "2026-03-16T09:26:43.8997638+05:45",
      "AuthorisedDate": "2026-03-16T09:26:43.8997638+05:45",
      "Record_Status": 1,
      "RecordStatus": 22
    }
  ],
  "SiblingAndRelatedParty": "sample string 30",
  "IsSuccessfullyAPIExecuted": true,
  "ExceptionMessage": "sample string 32",
  "Id": "871f32a0-feee-4ceb-8efc-ef548dc8d34f",
  "CreatedById": "57761422-eccc-426f-a8cb-40b52711f01d",
  "CreatedBy": "sample string 35",
  "ModifiedById": "5b55e321-c296-4956-9737-438b841a96ed",
  "ModifiedBy": "sample string 37",
  "AuthorisedById": "881aef99-424a-4e38-a382-46c6bfcd1f0b",
  "AuthorisedBy": "sample string 38",
  "CreatedDate": "2026-03-16T09:26:43.8997638+05:45",
  "ModifiedDate": "2026-03-16T09:26:43.8997638+05:45",
  "AuthorisedDate": "2026-03-16T09:26:43.8997638+05:45",
  "Record_Status": 1,
  "RecordStatus": 41
}

application/xml, text/xml

Sample:

<ScreeningSearchSetupDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity">
  <AuthorisedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 38</AuthorisedBy>
  <AuthorisedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">881aef99-424a-4e38-a382-46c6bfcd1f0b</AuthorisedById>
  <AuthorisedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.8997638+05:45</AuthorisedDate>
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 35</CreatedBy>
  <CreatedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">57761422-eccc-426f-a8cb-40b52711f01d</CreatedById>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.8997638+05:45</CreatedDate>
  <Id xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">871f32a0-feee-4ceb-8efc-ef548dc8d34f</Id>
  <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 37</ModifiedBy>
  <ModifiedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">5b55e321-c296-4956-9737-438b841a96ed</ModifiedById>
  <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.8997638+05:45</ModifiedDate>
  <RecordStatus xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">41</RecordStatus>
  <Record_Status xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">Inactive</Record_Status>
  <AlreadyScreened>true</AlreadyScreened>
  <BranchCode>sample string 2</BranchCode>
  <Channel>sample string 24</Channel>
  <CititzenshipNumber>sample string 11</CititzenshipNumber>
  <CitizenshipIssuedDate>2026-03-16T09:26:43.8997638+05:45</CitizenshipIssuedDate>
  <CitizenshipIssuedDistrict>sample string 12</CitizenshipIssuedDistrict>
  <CompanyRegistrationAuth>sample string 17</CompanyRegistrationAuth>
  <CompanyRegistrationDate>2026-03-16T09:26:43.8997638+05:45</CompanyRegistrationDate>
  <CompanyRegistrationNumber>sample string 16</CompanyRegistrationNumber>
  <Country>sample string 10</Country>
  <CustomerName>sample string 7</CustomerName>
  <CustomerNumber>sample string 3</CustomerNumber>
  <CustomerUniqueId>4d10c530-3c48-4016-8eb1-d5cf7171f214</CustomerUniqueId>
  <DateOfBirth>2026-03-16T09:26:43.8841561+05:45</DateOfBirth>
  <ExceptionMessage>sample string 32</ExceptionMessage>
  <FatherName>sample string 20</FatherName>
  <Function>sample string 18</Function>
  <Gender>sample string 9</Gender>
  <GrandFatherName>sample string 19</GrandFatherName>
  <IndianEmbassyNumber>sample string 14</IndianEmbassyNumber>
  <IsSuccessfullyAPIExecuted>true</IsSuccessfullyAPIExecuted>
  <MinimumPercentage>27</MinimumPercentage>
  <MotherName>sample string 21</MotherName>
  <OnBoarding>29</OnBoarding>
  <PANNumber>sample string 15</PANNumber>
  <PassportNumber>sample string 13</PassportNumber>
  <RedirectionLink>sample string 28</RedirectionLink>
  <RelatedCustomerNumber>sample string 4</RelatedCustomerNumber>
  <ScreeningBulkUploadId>9bd9df65-a9ac-4283-99e3-5d29638a2ea7</ScreeningBulkUploadId>
  <ScreeningCode>sample string 1</ScreeningCode>
  <ScreeningStatus>sample string 25</ScreeningStatus>
  <SearchFor>sample string 5</SearchFor>
  <SearchedName>sample string 8</SearchedName>
  <SiblingAndRelatedParty>sample string 30</SiblingAndRelatedParty>
  <SpouseName>sample string 22</SpouseName>
  <TotalRecordsMatched>23</TotalRecordsMatched>
  <screeningSearchDetailList>
    <ScreeningSearchDetailDTO>
      <AuthorisedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 19</AuthorisedBy>
      <AuthorisedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2fe65545-4c5c-4600-a117-fb6b5110e6f2</AuthorisedById>
      <AuthorisedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.8997638+05:45</AuthorisedDate>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 16</CreatedBy>
      <CreatedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">20428036-27e2-4402-9a85-793d67fc545f</CreatedById>
      <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.8997638+05:45</CreatedDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">b166f972-937c-4c2e-aa6e-bbfcbb1d2b7d</Id>
      <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 18</ModifiedBy>
      <ModifiedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">c587fac1-147f-40ff-8af5-28db8e01e899</ModifiedById>
      <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.8997638+05:45</ModifiedDate>
      <RecordStatus xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">22</RecordStatus>
      <Record_Status xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">Inactive</Record_Status>
      <MatchCountry>sample string 5</MatchCountry>
      <MatchDateOfBirth>sample string 6</MatchDateOfBirth>
      <MatchFunction>sample string 7</MatchFunction>
      <MatchNameAccuracy>8.1</MatchNameAccuracy>
      <MatchedName>sample string 4</MatchedName>
      <Remarks>sample string 13</Remarks>
      <ScreeningAction>sample string 9</ScreeningAction>
      <ScreeningConfirmationHistories>
        <ScreeningConfirmationHistory>
          <CreatedDate>2026-03-16T09:26:43.8997638+05:45</CreatedDate>
          <Id>c1f483c3-0ed5-46e5-8b64-9e8593c66b5b</Id>
          <Remarks>sample string 3</Remarks>
          <ScreeningSearchDetailId>036af84e-0bb9-474d-8b2b-983184022653</ScreeningSearchDetailId>
          <UserId>87662381-7b92-44fd-8b1e-56db6d481f3b</UserId>
          <Username>sample string 4</Username>
        </ScreeningConfirmationHistory>
        <ScreeningConfirmationHistory>
          <CreatedDate>2026-03-16T09:26:43.8997638+05:45</CreatedDate>
          <Id>c1f483c3-0ed5-46e5-8b64-9e8593c66b5b</Id>
          <Remarks>sample string 3</Remarks>
          <ScreeningSearchDetailId>036af84e-0bb9-474d-8b2b-983184022653</ScreeningSearchDetailId>
          <UserId>87662381-7b92-44fd-8b1e-56db6d481f3b</UserId>
          <Username>sample string 4</Username>
        </ScreeningConfirmationHistory>
      </ScreeningConfirmationHistories>
      <ScreeningDetails>sample string 10</ScreeningDetails>
      <ScreeningOrder>12</ScreeningOrder>
      <ScreeningSearchSetupId>af32961b-4736-4be8-9dee-e6eb3dc63d81</ScreeningSearchSetupId>
      <ScreeningUniqueId>sample string 2</ScreeningUniqueId>
      <SearchFor>sample string 11</SearchFor>
      <SearchType>sample string 3</SearchType>
    </ScreeningSearchDetailDTO>
    <ScreeningSearchDetailDTO>
      <AuthorisedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 19</AuthorisedBy>
      <AuthorisedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2fe65545-4c5c-4600-a117-fb6b5110e6f2</AuthorisedById>
      <AuthorisedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.8997638+05:45</AuthorisedDate>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 16</CreatedBy>
      <CreatedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">20428036-27e2-4402-9a85-793d67fc545f</CreatedById>
      <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.8997638+05:45</CreatedDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">b166f972-937c-4c2e-aa6e-bbfcbb1d2b7d</Id>
      <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 18</ModifiedBy>
      <ModifiedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">c587fac1-147f-40ff-8af5-28db8e01e899</ModifiedById>
      <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.8997638+05:45</ModifiedDate>
      <RecordStatus xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">22</RecordStatus>
      <Record_Status xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">Inactive</Record_Status>
      <MatchCountry>sample string 5</MatchCountry>
      <MatchDateOfBirth>sample string 6</MatchDateOfBirth>
      <MatchFunction>sample string 7</MatchFunction>
      <MatchNameAccuracy>8.1</MatchNameAccuracy>
      <MatchedName>sample string 4</MatchedName>
      <Remarks>sample string 13</Remarks>
      <ScreeningAction>sample string 9</ScreeningAction>
      <ScreeningConfirmationHistories>
        <ScreeningConfirmationHistory>
          <CreatedDate>2026-03-16T09:26:43.8997638+05:45</CreatedDate>
          <Id>c1f483c3-0ed5-46e5-8b64-9e8593c66b5b</Id>
          <Remarks>sample string 3</Remarks>
          <ScreeningSearchDetailId>036af84e-0bb9-474d-8b2b-983184022653</ScreeningSearchDetailId>
          <UserId>87662381-7b92-44fd-8b1e-56db6d481f3b</UserId>
          <Username>sample string 4</Username>
        </ScreeningConfirmationHistory>
        <ScreeningConfirmationHistory>
          <CreatedDate>2026-03-16T09:26:43.8997638+05:45</CreatedDate>
          <Id>c1f483c3-0ed5-46e5-8b64-9e8593c66b5b</Id>
          <Remarks>sample string 3</Remarks>
          <ScreeningSearchDetailId>036af84e-0bb9-474d-8b2b-983184022653</ScreeningSearchDetailId>
          <UserId>87662381-7b92-44fd-8b1e-56db6d481f3b</UserId>
          <Username>sample string 4</Username>
        </ScreeningConfirmationHistory>
      </ScreeningConfirmationHistories>
      <ScreeningDetails>sample string 10</ScreeningDetails>
      <ScreeningOrder>12</ScreeningOrder>
      <ScreeningSearchSetupId>af32961b-4736-4be8-9dee-e6eb3dc63d81</ScreeningSearchSetupId>
      <ScreeningUniqueId>sample string 2</ScreeningUniqueId>
      <SearchFor>sample string 11</SearchFor>
      <SearchType>sample string 3</SearchType>
    </ScreeningSearchDetailDTO>
  </screeningSearchDetailList>
</ScreeningSearchSetupDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ScreeningSearchSetupDTO

Name	Type	Additional information
ScreeningCode	string	Required String length: inclusive between 0 and 100
BranchCode	string	Required String length: inclusive between 0 and 5
CustomerNumber	string	String length: inclusive between 0 and 100
RelatedCustomerNumber	string	String length: inclusive between 0 and 20
SearchFor	string	Required String length: inclusive between 0 and 200
CustomerUniqueId	globally unique identifier	None.
CustomerName	string	Required String length: inclusive between 0 and 500
SearchedName	string	Required String length: inclusive between 0 and 500
Gender	string	String length: inclusive between 0 and 10
Country	string	Required String length: inclusive between 0 and 200
DateOfBirth	date	None.
CititzenshipNumber	string	String length: inclusive between 0 and 200
CitizenshipIssuedDate	date	None.
CitizenshipIssuedDistrict	string	String length: inclusive between 0 and 200
PassportNumber	string	String length: inclusive between 0 and 200
IndianEmbassyNumber	string	String length: inclusive between 0 and 200
PANNumber	string	String length: inclusive between 0 and 200
CompanyRegistrationNumber	string	String length: inclusive between 0 and 200
CompanyRegistrationDate	date	None.
CompanyRegistrationAuth	string	String length: inclusive between 0 and 500
Function	string	String length: inclusive between 0 and 200
GrandFatherName	string	String length: inclusive between 0 and 500
FatherName	string	String length: inclusive between 0 and 500
MotherName	string	String length: inclusive between 0 and 500
SpouseName	string	String length: inclusive between 0 and 500
TotalRecordsMatched	integer	None.
Channel	string	String length: inclusive between 0 and 200
ScreeningStatus	string	None.
AlreadyScreened	boolean	None.
MinimumPercentage	integer	None.
RedirectionLink	string	None.
ScreeningBulkUploadId	globally unique identifier	None.
OnBoarding	integer	None.
screeningSearchDetailList	Collection of ScreeningSearchDetailDTO	None.
SiblingAndRelatedParty	string	None.
IsSuccessfullyAPIExecuted	boolean	None.
ExceptionMessage	string	None.
Id	globally unique identifier	None.
CreatedById	globally unique identifier	None.
CreatedBy	string	None.
ModifiedById	globally unique identifier	None.
ModifiedBy	string	None.
AuthorisedById	globally unique identifier	None.
AuthorisedBy	string	None.
CreatedDate	date	None.
ModifiedDate	date	None.
AuthorisedDate	date	None.
Record_Status	Record_Status	None.
RecordStatus	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ScreeningCode": "sample string 1",
  "BranchCode": "sample string 2",
  "CustomerNumber": "sample string 3",
  "RelatedCustomerNumber": "sample string 4",
  "SearchFor": "sample string 5",
  "CustomerUniqueId": "e4c126fe-3567-427b-8f21-56d0619fb5e8",
  "CustomerName": "sample string 7",
  "SearchedName": "sample string 8",
  "Gender": "sample string 9",
  "Country": "sample string 10",
  "DateOfBirth": "2026-03-16T09:26:43.9783779+05:45",
  "CititzenshipNumber": "sample string 11",
  "CitizenshipIssuedDate": "2026-03-16T09:26:43.9783779+05:45",
  "CitizenshipIssuedDistrict": "sample string 12",
  "PassportNumber": "sample string 13",
  "IndianEmbassyNumber": "sample string 14",
  "PANNumber": "sample string 15",
  "CompanyRegistrationNumber": "sample string 16",
  "CompanyRegistrationDate": "2026-03-16T09:26:43.9783779+05:45",
  "CompanyRegistrationAuth": "sample string 17",
  "Function": "sample string 18",
  "GrandFatherName": "sample string 19",
  "FatherName": "sample string 20",
  "MotherName": "sample string 21",
  "SpouseName": "sample string 22",
  "TotalRecordsMatched": 23,
  "Channel": "sample string 24",
  "ScreeningStatus": "sample string 25",
  "AlreadyScreened": true,
  "MinimumPercentage": 27,
  "RedirectionLink": "sample string 28",
  "ScreeningBulkUploadId": "422bafcf-995e-4bfb-abe2-2641b7075ce8",
  "OnBoarding": 29,
  "screeningSearchDetailList": [
    {
      "ScreeningSearchSetupId": "06e9b095-196b-4ca4-9492-24ef061d4436",
      "ScreeningUniqueId": "sample string 2",
      "SearchType": "sample string 3",
      "MatchedName": "sample string 4",
      "MatchCountry": "sample string 5",
      "MatchDateOfBirth": "sample string 6",
      "MatchFunction": "sample string 7",
      "MatchNameAccuracy": 8.1,
      "ScreeningAction": "sample string 9",
      "ScreeningDetails": "sample string 10",
      "SearchFor": "sample string 11",
      "ScreeningOrder": 12,
      "Remarks": "sample string 13",
      "ScreeningConfirmationHistories": [
        {
          "Id": "4bb75031-3f96-4fd9-9a4e-7e9e8dbd346d",
          "ScreeningSearchDetailId": "951da44f-8811-4b3b-b7e1-91ca65c6862b",
          "Remarks": "sample string 3",
          "Username": "sample string 4",
          "UserId": "4b07113a-07f7-48df-be31-0cbd3e5964c0",
          "CreatedDate": "2026-03-16T09:26:43.9783779+05:45"
        },
        {
          "Id": "4bb75031-3f96-4fd9-9a4e-7e9e8dbd346d",
          "ScreeningSearchDetailId": "951da44f-8811-4b3b-b7e1-91ca65c6862b",
          "Remarks": "sample string 3",
          "Username": "sample string 4",
          "UserId": "4b07113a-07f7-48df-be31-0cbd3e5964c0",
          "CreatedDate": "2026-03-16T09:26:43.9783779+05:45"
        }
      ],
      "Id": "49ea7f93-c6dc-4350-be08-b100fe6f0cf2",
      "CreatedById": "78a99503-9fa6-493d-a639-fcc8512c7681",
      "CreatedBy": "sample string 16",
      "ModifiedById": "8a7d7b27-eced-4639-881e-3ba7b57c727f",
      "ModifiedBy": "sample string 18",
      "AuthorisedById": "952f107e-cd42-4e56-9cc9-5ba9a27aebff",
      "AuthorisedBy": "sample string 19",
      "CreatedDate": "2026-03-16T09:26:43.9783779+05:45",
      "ModifiedDate": "2026-03-16T09:26:43.9783779+05:45",
      "AuthorisedDate": "2026-03-16T09:26:43.9783779+05:45",
      "Record_Status": 1,
      "RecordStatus": 22
    },
    {
      "ScreeningSearchSetupId": "06e9b095-196b-4ca4-9492-24ef061d4436",
      "ScreeningUniqueId": "sample string 2",
      "SearchType": "sample string 3",
      "MatchedName": "sample string 4",
      "MatchCountry": "sample string 5",
      "MatchDateOfBirth": "sample string 6",
      "MatchFunction": "sample string 7",
      "MatchNameAccuracy": 8.1,
      "ScreeningAction": "sample string 9",
      "ScreeningDetails": "sample string 10",
      "SearchFor": "sample string 11",
      "ScreeningOrder": 12,
      "Remarks": "sample string 13",
      "ScreeningConfirmationHistories": [
        {
          "Id": "4bb75031-3f96-4fd9-9a4e-7e9e8dbd346d",
          "ScreeningSearchDetailId": "951da44f-8811-4b3b-b7e1-91ca65c6862b",
          "Remarks": "sample string 3",
          "Username": "sample string 4",
          "UserId": "4b07113a-07f7-48df-be31-0cbd3e5964c0",
          "CreatedDate": "2026-03-16T09:26:43.9783779+05:45"
        },
        {
          "Id": "4bb75031-3f96-4fd9-9a4e-7e9e8dbd346d",
          "ScreeningSearchDetailId": "951da44f-8811-4b3b-b7e1-91ca65c6862b",
          "Remarks": "sample string 3",
          "Username": "sample string 4",
          "UserId": "4b07113a-07f7-48df-be31-0cbd3e5964c0",
          "CreatedDate": "2026-03-16T09:26:43.9783779+05:45"
        }
      ],
      "Id": "49ea7f93-c6dc-4350-be08-b100fe6f0cf2",
      "CreatedById": "78a99503-9fa6-493d-a639-fcc8512c7681",
      "CreatedBy": "sample string 16",
      "ModifiedById": "8a7d7b27-eced-4639-881e-3ba7b57c727f",
      "ModifiedBy": "sample string 18",
      "AuthorisedById": "952f107e-cd42-4e56-9cc9-5ba9a27aebff",
      "AuthorisedBy": "sample string 19",
      "CreatedDate": "2026-03-16T09:26:43.9783779+05:45",
      "ModifiedDate": "2026-03-16T09:26:43.9783779+05:45",
      "AuthorisedDate": "2026-03-16T09:26:43.9783779+05:45",
      "Record_Status": 1,
      "RecordStatus": 22
    }
  ],
  "SiblingAndRelatedParty": "sample string 30",
  "IsSuccessfullyAPIExecuted": true,
  "ExceptionMessage": "sample string 32",
  "Id": "e31a9ece-b2ca-482c-a07c-780ad8bb0d55",
  "CreatedById": "8ac33ee8-c2df-4f79-96b5-057f0a604e45",
  "CreatedBy": "sample string 35",
  "ModifiedById": "7682f166-0c8e-401b-be8f-2c145a09f137",
  "ModifiedBy": "sample string 37",
  "AuthorisedById": "f1d6e7de-35fd-4fae-87c4-a5de12fb6ad0",
  "AuthorisedBy": "sample string 38",
  "CreatedDate": "2026-03-16T09:26:43.9783779+05:45",
  "ModifiedDate": "2026-03-16T09:26:43.9783779+05:45",
  "AuthorisedDate": "2026-03-16T09:26:43.9783779+05:45",
  "Record_Status": 1,
  "RecordStatus": 41
}

application/xml, text/xml

Sample:

<ScreeningSearchSetupDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity">
  <AuthorisedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 38</AuthorisedBy>
  <AuthorisedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">f1d6e7de-35fd-4fae-87c4-a5de12fb6ad0</AuthorisedById>
  <AuthorisedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.9783779+05:45</AuthorisedDate>
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 35</CreatedBy>
  <CreatedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">8ac33ee8-c2df-4f79-96b5-057f0a604e45</CreatedById>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.9783779+05:45</CreatedDate>
  <Id xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">e31a9ece-b2ca-482c-a07c-780ad8bb0d55</Id>
  <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 37</ModifiedBy>
  <ModifiedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">7682f166-0c8e-401b-be8f-2c145a09f137</ModifiedById>
  <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.9783779+05:45</ModifiedDate>
  <RecordStatus xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">41</RecordStatus>
  <Record_Status xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">Inactive</Record_Status>
  <AlreadyScreened>true</AlreadyScreened>
  <BranchCode>sample string 2</BranchCode>
  <Channel>sample string 24</Channel>
  <CititzenshipNumber>sample string 11</CititzenshipNumber>
  <CitizenshipIssuedDate>2026-03-16T09:26:43.9783779+05:45</CitizenshipIssuedDate>
  <CitizenshipIssuedDistrict>sample string 12</CitizenshipIssuedDistrict>
  <CompanyRegistrationAuth>sample string 17</CompanyRegistrationAuth>
  <CompanyRegistrationDate>2026-03-16T09:26:43.9783779+05:45</CompanyRegistrationDate>
  <CompanyRegistrationNumber>sample string 16</CompanyRegistrationNumber>
  <Country>sample string 10</Country>
  <CustomerName>sample string 7</CustomerName>
  <CustomerNumber>sample string 3</CustomerNumber>
  <CustomerUniqueId>e4c126fe-3567-427b-8f21-56d0619fb5e8</CustomerUniqueId>
  <DateOfBirth>2026-03-16T09:26:43.9783779+05:45</DateOfBirth>
  <ExceptionMessage>sample string 32</ExceptionMessage>
  <FatherName>sample string 20</FatherName>
  <Function>sample string 18</Function>
  <Gender>sample string 9</Gender>
  <GrandFatherName>sample string 19</GrandFatherName>
  <IndianEmbassyNumber>sample string 14</IndianEmbassyNumber>
  <IsSuccessfullyAPIExecuted>true</IsSuccessfullyAPIExecuted>
  <MinimumPercentage>27</MinimumPercentage>
  <MotherName>sample string 21</MotherName>
  <OnBoarding>29</OnBoarding>
  <PANNumber>sample string 15</PANNumber>
  <PassportNumber>sample string 13</PassportNumber>
  <RedirectionLink>sample string 28</RedirectionLink>
  <RelatedCustomerNumber>sample string 4</RelatedCustomerNumber>
  <ScreeningBulkUploadId>422bafcf-995e-4bfb-abe2-2641b7075ce8</ScreeningBulkUploadId>
  <ScreeningCode>sample string 1</ScreeningCode>
  <ScreeningStatus>sample string 25</ScreeningStatus>
  <SearchFor>sample string 5</SearchFor>
  <SearchedName>sample string 8</SearchedName>
  <SiblingAndRelatedParty>sample string 30</SiblingAndRelatedParty>
  <SpouseName>sample string 22</SpouseName>
  <TotalRecordsMatched>23</TotalRecordsMatched>
  <screeningSearchDetailList>
    <ScreeningSearchDetailDTO>
      <AuthorisedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 19</AuthorisedBy>
      <AuthorisedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">952f107e-cd42-4e56-9cc9-5ba9a27aebff</AuthorisedById>
      <AuthorisedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.9783779+05:45</AuthorisedDate>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 16</CreatedBy>
      <CreatedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">78a99503-9fa6-493d-a639-fcc8512c7681</CreatedById>
      <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.9783779+05:45</CreatedDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">49ea7f93-c6dc-4350-be08-b100fe6f0cf2</Id>
      <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 18</ModifiedBy>
      <ModifiedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">8a7d7b27-eced-4639-881e-3ba7b57c727f</ModifiedById>
      <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.9783779+05:45</ModifiedDate>
      <RecordStatus xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">22</RecordStatus>
      <Record_Status xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">Inactive</Record_Status>
      <MatchCountry>sample string 5</MatchCountry>
      <MatchDateOfBirth>sample string 6</MatchDateOfBirth>
      <MatchFunction>sample string 7</MatchFunction>
      <MatchNameAccuracy>8.1</MatchNameAccuracy>
      <MatchedName>sample string 4</MatchedName>
      <Remarks>sample string 13</Remarks>
      <ScreeningAction>sample string 9</ScreeningAction>
      <ScreeningConfirmationHistories>
        <ScreeningConfirmationHistory>
          <CreatedDate>2026-03-16T09:26:43.9783779+05:45</CreatedDate>
          <Id>4bb75031-3f96-4fd9-9a4e-7e9e8dbd346d</Id>
          <Remarks>sample string 3</Remarks>
          <ScreeningSearchDetailId>951da44f-8811-4b3b-b7e1-91ca65c6862b</ScreeningSearchDetailId>
          <UserId>4b07113a-07f7-48df-be31-0cbd3e5964c0</UserId>
          <Username>sample string 4</Username>
        </ScreeningConfirmationHistory>
        <ScreeningConfirmationHistory>
          <CreatedDate>2026-03-16T09:26:43.9783779+05:45</CreatedDate>
          <Id>4bb75031-3f96-4fd9-9a4e-7e9e8dbd346d</Id>
          <Remarks>sample string 3</Remarks>
          <ScreeningSearchDetailId>951da44f-8811-4b3b-b7e1-91ca65c6862b</ScreeningSearchDetailId>
          <UserId>4b07113a-07f7-48df-be31-0cbd3e5964c0</UserId>
          <Username>sample string 4</Username>
        </ScreeningConfirmationHistory>
      </ScreeningConfirmationHistories>
      <ScreeningDetails>sample string 10</ScreeningDetails>
      <ScreeningOrder>12</ScreeningOrder>
      <ScreeningSearchSetupId>06e9b095-196b-4ca4-9492-24ef061d4436</ScreeningSearchSetupId>
      <ScreeningUniqueId>sample string 2</ScreeningUniqueId>
      <SearchFor>sample string 11</SearchFor>
      <SearchType>sample string 3</SearchType>
    </ScreeningSearchDetailDTO>
    <ScreeningSearchDetailDTO>
      <AuthorisedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 19</AuthorisedBy>
      <AuthorisedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">952f107e-cd42-4e56-9cc9-5ba9a27aebff</AuthorisedById>
      <AuthorisedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.9783779+05:45</AuthorisedDate>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 16</CreatedBy>
      <CreatedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">78a99503-9fa6-493d-a639-fcc8512c7681</CreatedById>
      <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.9783779+05:45</CreatedDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">49ea7f93-c6dc-4350-be08-b100fe6f0cf2</Id>
      <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">sample string 18</ModifiedBy>
      <ModifiedById xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">8a7d7b27-eced-4639-881e-3ba7b57c727f</ModifiedById>
      <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">2026-03-16T09:26:43.9783779+05:45</ModifiedDate>
      <RecordStatus xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">22</RecordStatus>
      <Record_Status xmlns="http://schemas.datacontract.org/2004/07/KYCAML.Entity.DTO">Inactive</Record_Status>
      <MatchCountry>sample string 5</MatchCountry>
      <MatchDateOfBirth>sample string 6</MatchDateOfBirth>
      <MatchFunction>sample string 7</MatchFunction>
      <MatchNameAccuracy>8.1</MatchNameAccuracy>
      <MatchedName>sample string 4</MatchedName>
      <Remarks>sample string 13</Remarks>
      <ScreeningAction>sample string 9</ScreeningAction>
      <ScreeningConfirmationHistories>
        <ScreeningConfirmationHistory>
          <CreatedDate>2026-03-16T09:26:43.9783779+05:45</CreatedDate>
          <Id>4bb75031-3f96-4fd9-9a4e-7e9e8dbd346d</Id>
          <Remarks>sample string 3</Remarks>
          <ScreeningSearchDetailId>951da44f-8811-4b3b-b7e1-91ca65c6862b</ScreeningSearchDetailId>
          <UserId>4b07113a-07f7-48df-be31-0cbd3e5964c0</UserId>
          <Username>sample string 4</Username>
        </ScreeningConfirmationHistory>
        <ScreeningConfirmationHistory>
          <CreatedDate>2026-03-16T09:26:43.9783779+05:45</CreatedDate>
          <Id>4bb75031-3f96-4fd9-9a4e-7e9e8dbd346d</Id>
          <Remarks>sample string 3</Remarks>
          <ScreeningSearchDetailId>951da44f-8811-4b3b-b7e1-91ca65c6862b</ScreeningSearchDetailId>
          <UserId>4b07113a-07f7-48df-be31-0cbd3e5964c0</UserId>
          <Username>sample string 4</Username>
        </ScreeningConfirmationHistory>
      </ScreeningConfirmationHistories>
      <ScreeningDetails>sample string 10</ScreeningDetails>
      <ScreeningOrder>12</ScreeningOrder>
      <ScreeningSearchSetupId>06e9b095-196b-4ca4-9492-24ef061d4436</ScreeningSearchSetupId>
      <ScreeningUniqueId>sample string 2</ScreeningUniqueId>
      <SearchFor>sample string 11</SearchFor>
      <SearchType>sample string 3</SearchType>
    </ScreeningSearchDetailDTO>
  </screeningSearchDetailList>
</ScreeningSearchSetupDTO>