PreScreening.io API Documentation | ZIGRAM | AML, Fraud & Financial Crime Compliance Software

API Documentation

Prescreening.io has an API-style output designed for developer documentation. It enables users to perform searches on the database and live Adverse Press Coverage search. This document provides a brief API overview, authentication and Prescreening API , Sample Request and Response and Data Field details.

API Overview

PreScreening.io API is designed to provide the users with the feature of sending requests via API, while retaining the UI capabilities. Workflow is as follows:

User generates a token using their credentials
(API Endpoint: https://coreapi.prescreening.io/v2/api/tokenV2)
User sends a screening request to the platform via API using the token.
API will authenticate the user.
Post authentication, the platform will start screening the entities as per the request and settings predefined by the user on the platform.
Once the screening is completed, API will return the results to the user in response along with Case Id.
The Case Id can then be viewed on the UI and the user can perform further actions like report download, disambiguation etc.

Token

This API is used to generate an access token for a user. The request must include encrypted username and password fields. Upon successful authentication, an access token is returned, which is valid for 30 minutes.

Base URL: https://coreapi.prescreening.io/

End point : v2/api/tokenV2

Method: POST

Example Request

				
					{
  "username": "uAECAwB4fHw+8qO7xV/RedzhGtpkOeLuZ8prTngld82YQi0CKQwBN4ZIMvVX9PhsVNNL3tAFFgAAAH4wfAYJKoZIhvcNAQcGoG8wbQIBADBoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDIuHqUohA/kstIfKhQIBEIA7mVNQv0gggj78ky8j7noMwd+LrU+uYMBLF9avguqwvJM+oi9cmNUFXjrruRPPa9MfTlWYukMYBLXcMd3Q7PQqr/+7y61hkhelPrs2a1fNXZYySesNnAqnY7qmgg==",
  "password": "uAECAwB4fHw+8qO7xV/RedzhGtpkOeLuZ8prTngld82YQi0CKQwBBeLoLaD5ITN14HGYf9I/mwAAAH4wfAYJKoZIhvcNAQcGoG8wbQIBADBoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDLXPC40KwD7hah1ZCQIBEIA7ba8dFys391G/BAxzSwWDEwff8IUOgUXa9zgzSl/7ZNOmbnTiZ2/z9K6wJ35cJUNrdOsnZbcS9bbRI719MHViueHOjPH+iq5PlzMDz0WOcfrne0m+Q6ilT3ztcQ=="
}

Example Response:

				
					{
  "message": "",
  "data": {
    "access_token": "<your_access_token>",
    "expire": "30 minutes"
  },
  "success": true
}

Prescreening API

Prescreening API is used to initiate screening for an entity.

Base URL: https://coreapi.prescreening.io/

End point : v2/api/screening

Header: Bearer {Token}

Method: POST

Example Request

				
					{
  "projectId": 672,
  "startDate": "",
  "endDate": "",
  "entityName": "Narendra Modi",
  "panNumber": "",
  "industry": "",
  "cin": "",
  "clientId": "customer001",
  "din": "",
  "GST": [],
  "emails": [],
  "phoneNumbers": [
    ""
  ],
  "organization": [],
  "identifiers": [
    ""
  ],
  "designation": "",
  "type": "Individual",
  "vesselsType": "",
  "sector": "",
  "country": [
    "India"
  ],
  "countryOfResidence": [
    "India"
  ],
  "reportType": "Detailed",
  "gender": "",
  "dob": "",
  "PassportNumber": [
    ""
  ],
  "dateOfIncorporation": "",
  "state": "",
  "city": "",
  "address": "",
  "postalCode": "",
  "state2": "",
  "city2": "",
  "address2": "",
  "postalCode2": "",
  "state3": "",
  "city3": "",
  "address3": "",
  "postalCode3": "",
  "aliases": [],
  "otherId": "",
  "monitoringmodel": {
    "frequency": "Fortnightly",
    "startDate": "10-03-2025",
    "RunFrequency": 1,
    "days": [
      "Mon"
    ],
    "runTime": "06:45 PM",
    "Timezone": "(GMT+0:00) Universal Time UTC"
  },
  "associations": [
    {
      "associationName": "MANDEGAR BASPAR KIMIYA COMPANY",
      "associationPanNumber": "",
      "associationDesignation": "",
      "associationSector": "",
      "associationCin": "",
      "associationDin": "",
      "associationGST": [],
      "associationEmails": [],
      "associationPhoneNumbers": [],
      "associationIndustry": "",
      "associationAliases": [
        ""
      ],
      "associationIdentifiers": [],
      "associationCountry": [
        "Iran"
      ],
      "associationCountryOfResidence": [],
      "associationGender": "",
      "associationDob": "",
      "associationDateOfIncorporation": "",
      "associationState": "",
      "associationCity": "",
      "associationAddress": "",
      "associationPostalCode": "",
      "associationState2": "",
      "associationCity2": "",
      "associationAddress2": "",
      "associationPostalCode2": "",
      "associationState3": "",
      "associationCity3": "",
      "associationAddress3": "",
      "associationPostalCode3": "",
      "associationOrganization": [],
      "associationsType": "Organization",
      "associationVesselsType": "",
      "associationNationality": "",
      "associationPassportNumber": [],
      "associationClientId": "customer02",
      "associationOtherId": ""
    }
  ],
  "nationality": ""
}

Example Response:

				
					{
  "message": "200",
  "data": {
    "CaseAssociation": [
      {
        "Name": "Narendra Modi",
        "Score": "10/10",
        "Status": "Red",
        "Uid": "c551614b-cbea-4811-a696-426dbcc87af9",
        "Type": "Individual"
      },
      {
        "Name": "MANDEGAR BASPAR KIMIYA COMPANY",
        "Score": "10/10",
        "Status": "Red",
        "Uid": "a5613d6f-6fb8-4d00-bca7-0886f48b1d6d",
        "Type": "Organization"
      }
    ],
    "Case_Outcome": {
      "Name": "Narendra Modi",
      "CaseId": "CA14972776L",
      "CompositeApplicationStatus": "Need Review",
      "Score": "10/10",
      "Status": "Red",
      "Uid": "bbd678ea-b1fa-4ede-b464-e181c3a3017c",
      "EntityName": "Narendra Modi",
      "EntityId": "EN.00015673298"
    },
    "ListSubscribed": null,
    "NotExistsList": null,
    "Subscribed": null,
    "entitychecks": [
      {
        "HitsFound": {
          "PepCheck": 1,
          "SanctionCheck": 0
        },
        "PepCheck": [
          {
            "Address": "Vadnagar Mehsana Gujarat INDIA|7, Lok Kalyan Marg New Delhi Delhi 110011 INDIA|South Block, Raisina Hill New Delhi Delhi 110011 INDIA|C-1 Someshwar Tenament, Ranip Ahmedabad Gujarat 382480 INDIA",
            "Address Input Details": null,
            "Address Match Details": [
              "INDIA"
            ],
            "Address Match Status": "Partial Match",
            "Alias": "नरŐū दामोदरदास मोदी|مودی داس دامودر نريندر|નરેլԍ દામોદરદાસમોદી|Нарендра Дамодардас Моди|纳伦德拉·达摩达尔达斯·莫迪|নের϶ দােমাদরদাস έমািদ|ਨਿਰੰਦਰ ਦਾਮੋਦਰਦਾਸ ਮੋਦੀ|நேரந்ொரதாேமாதரத் ாஸ் ேமாூ",
            "Associations": [
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Hiren Joshi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "FATHER_IN_LAW",
                "Name": "Chimanlal Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "BROTHER",
                "Name": "Pankaj Damodardas Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "BROTHER",
                "Name": "Amrut Damodardas Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "BROTHER_IN_LAW",
                "Name": "Kamlesh Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "BROTHER",
                "Name": "Prahlad Damodardas Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "BROTHER",
                "Name": "Som Damodardas Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "MOTHER",
                "Name": "Hiraben Damodardas Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Vijay Chauthaiwale",
                "Position Description": "Advisor - Prime Minister (Narendra Damodardas Modi), The Republic of India",
                "Timeline": "-"
              },
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Jagdish Thakker",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "BROTHER_IN_LAW",
                "Name": "Hasmukhbhai Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "MOTHER_IN_LAW",
                "Name": "Sakriben Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "SISTER",
                "Name": "Vasantiben Hasmukhlal Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Arvind Kumar Sharma",
                "Position Description": "Collector - Kheda, Gujrat, The Republic of India",
                "Timeline": "01 Jul 1997 - 01 Jun 1998"
              },
              {
                "Associaton Description": "SISTER_IN_LAW",
                "Name": "Sita Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Mukesh Dhirubhai Ambani",
                "Position Description": "Chair - India Advisory Council, British Asian Trust, The United Kingdom of Great Britain and Northern Ireland",
                "Timeline": "-"
              },
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Rajesh Jain",
                "Position Description": "Chief Executive Officer - IndiaWorld, The Republic of India",
                "Timeline": "1995 -"
              },
              {
                "Associaton Description": "SISTER_IN_LAW",
                "Name": "Jayaben Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Tanmay Mehta",
                "Position Description": "OSD - Chief Minister, Government of the Gujarat, The Republic of India",
                "Timeline": "-"
              },
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Bharat Lal Meena",
                "Position Description": "Chief Secretary - Belgaum District, Karnataka The Republic of India",
                "Timeline": "02 Aug 1991 - 31 Jan 1992"
              },
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Gautam Shantilal Adani",
                "Position Description": "Chairman - Adani Airport Holdings Limited, The Republic of India",
                "Timeline": "16 Sep 2022 -"
              },
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Om Prakash Singh",
                "Position Description": "Personal Assistant - Chief Minister, Government of the Gujarat, The Republic of India",
                "Timeline": "-"
              },
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Dinesh Thakur",
                "Position Description": "Personal Assistant - Chief Minister, Government of the Gujarat, The Republic of India",
                "Timeline": "-"
              },
              {
                "Associaton Description": "ASSOCIATE",
                "Name": "Bhoopalam Gopalakrishna Mahesh",
                "Position Description": "Founder/Director - Greynium Information Technologies Private Limited, The Republic of India",
                "Timeline": "16 Jan 2006 -"
              },
              {
                "Associaton Description": "WIFE",
                "Name": "Jashodaben Chimanlal Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "COUSIN",
                "Name": "Kantibhai Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "BROTHER_IN_LAW",
                "Name": "Ashok Chimanlal Modi",
                "Position Description": "",
                "Timeline": "-"
              },
              {
                "Associaton Description": "FATHER",
                "Name": "Damodardas Mulchand Modi",
                "Position Description": "",
                "Timeline": "-"
              }
            ],
            "Attachment": "",
            "Attachment2": "",
            "Attachment3": "",
            "AttachmentP": "",
            "City": "Mehsana|New Delhi|Ahmedabad",
            "City Match Details": [
              ""
            ],
            "City Match Status": "",
            "Comment": "",
            "Comment2": "",
            "Comment3": "",
            "CommentP": "",
            "Country": "INDIA",
            "DOB": "17 Sep 1950",
            "DOB Match Status": "",
            "Deceased": "",
            "Deceased Date": "",
            "Derived Aliases": "Narendra Modi",
            "DobMatchDetails": "",
            "Email_ID": "",
            "FinalScore": "",
            "FinalScore2": "",
            "FinalScore3": "",
            "FinalScoreP": "",
            "FinalStatus": "",
            "FinalStatus2": "",
            "FinalStatus3": "",
            "FinalStatusP": "",
            "FinalTimeStamp": "",
            "FinalTimeStamp2": "",
            "FinalTimeStamp3": "",
            "FinalTimeStampP": "",
            "Gender": "Male",
            "GenderMatchDetails": "",
            "GenderMatchStatus": "",
            "Identifier Match Details": null,
            "Identifier Match Score": "",
            "Identifier Match Status": "",
            "Image URL": "https://www.pmindia.gov.in/wp-content/themes/pmindia2015/images/know-the-pm.jpg",
            "InputAddress": [
              ""
            ],
            "InputAlias": null,
            "InputAssociations": [
              "MANDEGAR BASPAR KIMIYA COMPANY"
            ],
            "InputCin": "",
            "InputCity": [
              ""
            ],
            "InputClientID": "customer001",
            "InputConcatAddress": [
              "India"
            ],
            "InputCountry": [
              "India"
            ],
            "InputCountryOfResidence": [
              "India"
            ],
            "InputDateOfIncorporation": "",
            "InputDateofBirth": "",
            "InputDesignation": "",
            "InputDin": "",
            "InputEmailID": [],
            "InputEntityName": "Narendra Modi",
            "InputGender": "",
            "InputGst": [],
            "InputIdIdentifiers": [],
            "InputIdentifier_4": [],
            "InputIndustry": "",
            "InputNationality": "",
            "InputOrganization": [],
            "InputOtherId": "",
            "InputPan": "",
            "InputPassport": [
              ""
            ],
            "InputPhoneNumber": [
              ""
            ],
            "InputPostalCode": [
              ""
            ],
            "InputSector": "",
            "InputState": [
              ""
            ],
            "InputType": "Individual",
            "InputVesselsType": " ",
            "LGD Code": "",
            "Label": "",
            "Match": "",
            "Match2": "",
            "Match3": "",
            "MatchP": "",
            "MatchedPanNo": "",
            "Other Details": null,
            "PAN match status": "",
            "Pep_Type": "HOS|LEG|POL",
            "Priority": "",
            "Reviewer": "",
            "Reviewer2": "",
            "Reviewer3": "",
            "ReviewerId": 0,
            "ReviewerId2": 0,
            "ReviewerId3": 0,
            "ReviewerIdP": 0,
            "ReviewerP": "",
            "Rule Applied": "",
            "RunId": 29398161,
            "Source Link": "https://www.bjp.org/national-executive-member|https://www.pmindia.gov.in/en/contactus/|https://ndtv.in/elections/lok-sabha-election-candidates-2024/narendra-modi-24077-1|https://pib.gov.in/PressReleasePage.aspx?PRID=2023687|https://www.divyabhaskar.co.in/national/news/db-reels-i-amnarendra-damodardas-modi-133219283.html|https://bjpgujarat.org/narendra-modi-pm/|https://sansad.in/ls/members/biography/4589?from=members|https://www.indiatoday.in/featured/story/narendra-modimodi-as-pm-bjp-gujarat-210885-2013-09-13|https://prsindia.org/mptrack/17-lok-sabha/narendramodi|https://prsindia.org/mptrack/16-lok-sabha/narendramodi|https://prsindia.org/mptrack/18-lok-sabha/narendramodi|https://data.ipu.org/elections/|http://economictimes.indiatimes.com/news/politics-and-nation/narendra-modi-resignsas-maninagar-mla/articleshow/35442645.cms|https://www.jagranjosh.com/general-knowledge/list-of-all-prime-ministers-ofindia-1473165149-1|https://www.pmindia.gov.in/en/pms-profile/|https://pib.gov.in/PressReleaseIframePage.aspx?PRID=2023668|https://blogs.lse.ac.uk/religionglobalsociety/2019/06/hindu-nationalism-and-authoritarianism-narendra-modis-second-and-third-term/|https://www.oneindia.com/list-of-chiefministers-of-gujarat/|http://www.ndtv.com/elections/article/election-2014/narendra-modi-to-be-sworn-in-as-india-s-15thprime-minister-on-may-26-527449?curl=1400834504|http://timesofindia.indiatimes.com/india/Narendra-Modi-anointedchairman-of-BJP-election-campaigncommittee/articleshow/20505787.cms|https://timesofindia.indiatimes.com/india/Narendra-Modi-anointed-chairman-of-BJPelection-campaign-committee/articleshow/20505787.cms|https://roscongress.org/speakers/modinarendra/biography/|https://cn.baochinhphu.vn/%E5%8D%B0%E5%BA%A6%E6%80%BB%E7%90%86%E8%8E%AB%E8%BF%AA%E8%B6%8A%E5%8D%97%E6%98%AF%E5%8D%B0%E5%BA%A6%E7%89%B9%E5%88%AB%E9%87%8D%E8%A6%81%E4%BC%99%E4%BC%B4-116231202110419899.htm|https://bengali.news18.com/tag/narendramodi/|https://punjab.news18.com/news/national/i-am-narendra-damodardas-modi-3-0-from-today-sworn-in-as-primeminister-for-the-third-time-in-a-row-skm-598496.html|https://www.puthiyathalaimurai.com/features/interesting-facts-aboutindia-prime-minister-narendra-modi",
            "State": "Gujarat|Delhi",
            "State Match Details": [
              ""
            ],
            "State Match Status": null,
            "Street Address": "Vadnagar|7, Lok Kalyan Marg|South Block, Raisina Hill|C-1 Someshwar Tenament, Ranip",
            "Street Address Match Details": [
              ""
            ],
            "Street Address Match Score": "",
            "Telephone": "",
            "composite_score": "100%",
            "details": "narendra modi",
            "fileName": "",
            "fileName2": "",
            "fileName3": "",
            "fileNameP": "",
            "full_name": "Narendra Damodardas Modi",
            "full_name_db": "Narendra Damodardas Modi",
            "mappingId": 1,
            "match_description": "Chairman - Election Campaign Committee, Bhartiya Janata Party (BJP), The Republic of India \\y Jun 2013|Member - Bhartiya Janata Party (BJP), The Republic of India \\y 1985|Member - Rastriya Swayamsevak Sangh (RSS), The Republic of India \\y 1971|Prime Minister - Government of the Republic of India \\y 26 May 2014 - 2029|Member - (16 - 18)th Term, House of People (Lok Sabha), (Varanasi), Parliament of the Republic of India \\y 8 May 2014 - 30 Apr 2029|Member - National Executive, Bhartiya Janata Party, The Republic of India|General Secretary - Bhartiya Janata Party, Gujarat, The Republic of India \\y 1988|General Secretary - Bhartiya Janata Party (BJP), The Republic of India \\y 1998 - Oct 2001|National Secretary - Bhartiya Janata Party (BJP), The Republic of India \\y 1995|Member - Legislative Assembly of Gujarat, (Maninagar), The Republic of India \\y Feb 2002 - 21 May 2014|Chief Minister - Government of Gujarat, The Republic of India \\y 7 Oct 2001 - 22 May 2014",
            "match_details": "narendra modi",
            "match_score": 2,
            "match_status": "Red",
            "per_score": "100%",
            "timestamp": "14 Apr 2025, GMT 02:49:48"
          }
        ],
        "SanctionCheck": [
          {
            "Attachment": "",
            "Comment": "",
            "FinalScore": "",
            "FinalStatus": "",
            "FinalTimeStamp": "",
            "InputAddress": [
              ""
            ],
            "InputAlias": null,
            "InputAssociations": [
              "MANDEGAR BASPAR KIMIYA COMPANY"
            ],
            "InputCin": "",
            "InputCity": [
              ""
            ],
            "InputClientID": "customer001",
            "InputConcatAddress": [
              "India"
            ],
            "InputCountry": [
              "India"
            ],
            "InputCountryOfResidence": [
              "India"
            ],
            "InputDateOfIncorporation": "",
            "InputDateofBirth": "",
            "InputDesignation": "",
            "InputDin": "",
            "InputEmailID": [],
            "InputEntityName": "Narendra Modi",
            "InputGender": "",
            "InputGst": [],
            "InputIdIdentifiers": [],
            "InputIdentifier_4": [],
            "InputIndustry": "",
            "InputNationality": "",
            "InputOrganization": [],
            "InputOtherId": "",
            "InputPan": "",
            "InputPassport": [
              ""
            ],
            "InputPhoneNumber": [
              ""
            ],
            "InputPostalCode": [
              ""
            ],
            "InputSector": "",
            "InputState": [
              ""
            ],
            "InputType": "Individual",
            "InputVesselsType": " ",
            "Label": "",
            "Match": "",
            "Reviewer": "",
            "ReviewerId": 0,
            "RunId": 0,
            "fileName": "",
            "mappingId": 1,
            "match_score": 0,
            "match_status": "Green",
            "reason": "{\"Message\":\"\"}",
            "timestamp": "14 Apr 2025, GMT 02:49:48"
          }
        ],
        "entityName": "Narendra Modi",
        "entityType": "Individual",
        "totalResponseCount": 1
      },
      {
        "HitsFound": {
          "PepCheck": 0,
          "SanctionCheck": 1
        },
        "PepCheck": [
          {
            "Attachment": "",
            "Comment": "",
            "FinalScore": "",
            "FinalStatus": "",
            "FinalTimeStamp": "",
            "InputAddress": [
              ""
            ],
            "InputAlias": [
              ""
            ],
            "InputAssociations": [
              "Narendra Modi"
            ],
            "InputCin": "",
            "InputCity": [
              ""
            ],
            "InputClientID": "customer02",
            "InputConcatAddress": [
              "Iran"
            ],
            "InputCountry": [
              "Iran"
            ],
            "InputCountryOfResidence": [],
            "InputDateOfIncorporation": "",
            "InputDateofBirth": "",
            "InputDesignation": "",
            "InputDin": "",
            "InputEmailID": [],
            "InputEntityName": "MANDEGAR BASPAR KIMIYA COMPANY",
            "InputGender": "",
            "InputGst": [],
            "InputIdIdentifiers": [],
            "InputIdentifier_4": [],
            "InputIndustry": "",
            "InputNationality": "",
            "InputOrganization": [],
            "InputOtherId": "",
            "InputPan": "",
            "InputPassport": [],
            "InputPhoneNumber": [],
            "InputPostalCode": [
              ""
            ],
            "InputSector": "",
            "InputState": [
              ""
            ],
            "InputType": "Organization",
            "InputVesselsType": "",
            "Label": "",
            "Match": "",
            "Reviewer": "",
            "ReviewerId": 0,
            "RunId": 0,
            "fileName": "",
            "mappingId": 1,
            "match_score": 0,
            "match_status": "Green",
            "reason": "{\"Message\":\"\"}",
            "timestamp": "14 Apr 2025, GMT 02:49:48"
          }
        ],
        "SanctionCheck": [
          {
            "Additional Information": "",
            "Address": "No. 510, 5th Floor Saddi Trading Building South SAA DI Street, Tehran, Iran",
            "Address Input Details": null,
            "Address Match Details": [
              "Iran"
            ],
            "Address Match Status": "Partial Match",
            "Alias": "MANDEGAR BASPAR FAJR ASIA|BARDIYA TEJARAT JAVID",
            "Associate Blocked Entity": "",
            "Associate Level": "",
            "Associations": "",
            "Attachment": "",
            "Attachment2": "",
            "Attachment3": "",
            "AttachmentP": "",
            "Authority Country": null,
            "Citizenship": "",
            "City": "Tehran",
            "City Match Details": [
              ""
            ],
            "City Match Status": "",
            "Comment": "",
            "Comment2": "",
            "Comment3": "",
            "CommentP": "",
            "Corporation ID": "",
            "Corporation Type": "",
            "Corporation Type (in Hebrew)": "",
            "Country": "Iran",
            "Date Designated in other countries": "",
            "Date of Foreign Designation": "",
            "Date of Incorporation": "",
            "Date of Incorporation Match Details": "",
            "Date of Incorporation Match Status": "",
            "Date of Permanent Designation": "",
            "Date of Temporary Designation": "",
            "Derived Aliases": "",
            "Designated by": "",
            "Designated by (in Hebrew)": "",
            "Designation Type": "",
            "FinalScore": "",
            "FinalScore2": "",
            "FinalScore3": "",
            "FinalScoreP": "",
            "FinalStatus": "",
            "FinalStatus2": "",
            "FinalStatus3": "",
            "FinalStatusP": "",
            "FinalTimeStamp": "",
            "FinalTimeStamp2": "",
            "FinalTimeStamp3": "",
            "FinalTimeStampP": "",
            "Foreign Designating Authority": "",
            "Foreign Designating Authority (in Hebrew)": "",
            "Foreign Designation": "",
            "Foreign Designation ID": "",
            "GenderMatchDetails": "",
            "GenderMatchStatus": "",
            "Identifier Match Details": null,
            "Identifier Match Score": "",
            "Identifier Match Status": "",
            "Identifier Number": "Subject to Secondary Sanctions",
            "Image URL": "",
            "InputAddress": [
              ""
            ],
            "InputAlias": [
              ""
            ],
            "InputAssociations": [
              "Narendra Modi"
            ],
            "InputCin": "",
            "InputCity": [
              ""
            ],
            "InputClientID": "customer02",
            "InputConcatAddress": [
              "Iran"
            ],
            "InputCountry": [
              "Iran"
            ],
            "InputCountryOfResidence": [],
            "InputDateOfIncorporation": "",
            "InputDateofBirth": "",
            "InputDesignation": "",
            "InputDin": "",
            "InputEmailID": [],
            "InputEntityName": "MANDEGAR BASPAR KIMIYA COMPANY",
            "InputGender": "",
            "InputGst": [],
            "InputIdIdentifiers": [],
            "InputIdentifier_4": [],
            "InputIndustry": "",
            "InputNationality": "",
            "InputOrganization": [],
            "InputOtherId": "",
            "InputPan": "",
            "InputPassport": [],
            "InputPhoneNumber": [],
            "InputPostalCode": [
              ""
            ],
            "InputSector": "",
            "InputState": [
              ""
            ],
            "InputType": "Organization",
            "InputVesselsType": "",
            "Justification for the designation": "",
            "Label": "",
            "Linked to": "",
            "List Name": "Specially Designated Nationals List (SDN List)",
            "ListUid": "SAN_A00001L000001",
            "Location of Formation": "",
            "Location of Formation (in Hebrew)": "",
            "Match": "",
            "Match2": "",
            "Match3": "",
            "MatchP": "",
            "Name of Identifier": "Additional Sanctions Information -",
            "Nationality": "",
            "Other Details": [],
            "Other Sanction Authority ID": "",
            "Passport": "",
            "Passport Country": "",
            "Passport Match Details": "",
            "Passport Match Status": "",
            "Priority": "",
            "Program": "IFSR|NPWMD",
            "Public Records References": "",
            "Remarks": "",
            "Remarks (in Hebrew)": "",
            "Reviewer": "",
            "Reviewer2": "",
            "Reviewer3": "",
            "ReviewerId": 0,
            "ReviewerId2": 0,
            "ReviewerId3": 0,
            "ReviewerIdP": 0,
            "ReviewerP": "",
            "Root Sanction Name": "",
            "Rule Applied": "",
            "RunId": 29398161,
            "Sanctions Authority ID": "17238",
            "Sources": "https://www.treasury.gov/ofac/downloads/sdnlist.pdf",
            "Stake": "",
            "State": "",
            "State Match Details": [
              ""
            ],
            "State Match Status": "",
            "Street Address": "No. 510, 5th Floor Saddi Trading Building South SAA DI Street",
            "Street Address Match Details": [
              ""
            ],
            "Street Address Match Score": "",
            "Sub-List Name": "",
            "West Bank Designation Date": "",
            "composite_score": "100%",
            "details": "mandegar baspar kimiya",
            "fileName": "",
            "fileName2": "",
            "fileName3": "",
            "fileNameP": "",
            "full_name": "MANDEGAR BASPAR KIMIYA COMPANY",
            "full_name_db": "MANDEGAR BASPAR KIMIYA COMPANY",
            "fuzzy_score": "100%",
            "mappingId": 1,
            "match_description": "U.S. Department of Treasury - Office of Foreign Assets Control",
            "match_details": "mandegar baspar kimiya",
            "match_score": 2,
            "match_status": "Red",
            "sanction_date": "",
            "timestamp": "14 Apr 2025, GMT 02:49:48"
          }
        ],
        "entityName": "MANDEGAR BASPAR KIMIYA COMPANY",
        "entityType": "Organization",
        "totalResponseCount": 1
      }
    ],
    "pdfUrl": "NA"
  },
  "success": true
}

Data Field – Target Entity:

Datafield Name	Type	Required	Length	Single	Multiple
ProjectId	int32	Yes
StartDate (For negative news Timeline)	Date (dd-mm-yyyy)	No		Yes
EndDate (For negative news Timeline)	Date (dd-mm-yyyy)	No		Yes
EntityName	string	Yes	nvarchar(max)	Yes
Industry	string	No	nvarchar(max)	Yes
ClientId	string	Yes	50	Yes
Organization	Array of strings	No	nvarchar(max)		Yes
Designation	string	No	nvarchar(max)	Yes
panNumber	string	No	10	Yes
cin	string	No	27	Yes
din	string	No	nvarchar(max)	Yes
GST	Array of strings	No			Yes
Nationality	string	No	nvarchar(max)	Yes
vesselsType	string	No	nvarchar(max)	Yes
Type	string	Yes	50	Yes
Gender	string	No	nvarchar(max)	Yes
Sector	string	No	nvarchar(max)	Yes
Country	Array of strings	Yes	3		Yes
dob	Date (dd-mm-yyyy)	No		Yes
state	string	No	nvarchar(max)	Yes
city	string	No	nvarchar(max)	Yes
aliases	Array of strings	No	nvarchar(max)		Yes
Identifiers	Array of strings	No	nvarchar(max)		Yes
Emails	Array of strings	No	nvarchar(max)		Yes
PassportNumber	Array of strings	No	nvarchar(max)		Yes
PhoneNumbers	Array of strings	No	nvarchar(max)		Yes
CountryOfResidence	Array of strings	No	3		Yes
dateOfIncorporation	Date (dd-mm-yyyy)	No		Yes
postalCode	string	No	nvarchar(max)	Yes
address	string	No	nvarchar(max)	Yes
reportType	string	No	nvarchar(max)	Yes
otherID	string	No	nvarchar(max)	Yes
monitoringmodel	Object	No

Data Fields – Associated Entity (Multiple):

Datafield Name	Type	Required	Length	Single	Multiple
AssociationName	string	Yes	nvarchar(max)	Yes
AssociationClientId	string	Yes	30	Yes
AssociationOrganization	Array of strings	No	nvarchar(max)		Yes
AssociationDesignation	string	No	nvarchar(max)	Yes
AssociationPanNumber	string	No	10	Yes
AssociationCin	string	No	27	Yes
AssociationDin	string	No	nvarchar(max)	Yes
AssociationNationality	string	No	nvarchar(max)	Yes
AssociationVesselsType	string	No	nvarchar(max)	Yes
AssociationsType	string	Yes	50	Yes
AssociationGender	string	No	nvarchar(max)	Yes
AssociationSector	string	No	nvarchar(max)	Yes
associationState	string	No	nvarchar(max)	Yes
associationCity	string	No	nvarchar(max)	Yes
associationAddress	string	No	nvarchar(max)	Yes
associationPostalCode	string	No	nvarchar(max)	Yes
AssociationCountry	Array of strings	Yes	3		Yes
AssociationDob	date(dd-mm-yyyy)	No		Yes
AssociationState	string	No	nvarchar(max)	Yes
AssociationCity	string	No	nvarchar(max)	Yes
AssociationAlias	Array of strings	No	nvarchar(max)		Yes
AssociationIdentifiers	Array of strings	No	nvarchar(max)		Yes
AssociationEmails	Array of strings	No	nvarchar(max)		Yes
AssociationPassportNumber	Array of strings	No	nvarchar(max)		Yes
AssociationPhoneNumbers	Array of strings	No	nvarchar(max)		Yes
AssociationCountryOfResidence	Array of strings	No	3		Yes
AssociationIdentifierType	String	No	nvarchar(max)		Yes
AssociationGST	Array of strings	No			Yes

Prescreening Encrypted Screening API

The Encrypted Screening API allows user to securely submit screening requests using an encrypted payload.

Base URL: https://coreapi.prescreening.io/

End point : v2/api/EncryptedScreening

Header: Bearer {Token}

Method: POST

Example Request

				
					{
  "cyphertext": "VdPwH/Wgub0mNr3ctcJ+0qj3P6kZ+AWzZxsENqGNBv/gd7jeRnxxCrvVxgEiCqrMq3Z3FpraC/XGPHH0yjnjXStxt7t4IXSGxmsMnOPqVPayIhRYT/JInmAPA14EMFnOlbbIUKB7M9g5NW8376/RHIF3dugGXYxLb5Jn1l4P5ar1vbzw5VW/PBhA5U9mvy0FxG15sPLThgQODfOmobfK+DlqkloRrW3MDW4 2HUsQmhzIkpKN/1N8PFnDh0TKlQNAsHMqNJOuT5iIPbTGAA7BgKCdp+A/i4re3Lue6RxLby9bIub5JIVrKDPfdtFUIZoFmIMrnsyM+NTGfbsuSNOwBF30s82+deVZjkz84FSKNbTf/UI1opZXJG02TvslZel2brRMIAqghRnmVsySfQOfoVlv+eQIvRehKjhsgF//w6P9yZAU4qwEVpPXMClEGBe4/2xqLarDLP+MkEGRJt/2EpbNmcZr1MMWHGt8md7O/QrG68AhtQlYHmlH0n8fe++MTOQZgaBGWzRtApmpvKc ql4aKsHCHxvKkOWU4ajic+P3aWSFpZkIgzHADMI1VEf6MSgjjeVByPa1hWz1wkaf0r/kCF+S/sPG7JenjdUZf/vIUj07GM3Nc1zkxurEzV9zYx6Vhz/UqHkTBIl/e5A4TgAM4eloMl3FCnlRM0VQYOrcWuG"
}

Example Response:

				
					{
  "encoded": "FdD0X3EBV67fPfzPN0ThkMk1uEYvfYZrBX+X+i8afr0gL5z7SgCVMYFghTnql4BirUCGzLtKX6SSY0Xi7ny1EIDHaL+9KKB/DswpX4CTqkur6wXo3EednIS5aNvarIXgp38c4IP4FqQil/kCIARCwcqqGnMvmeAqsn9t5EhhcU+rj6DwYGSBmjR0NNIO5TD+XylmCLyulgBQMVwQP7Utm8YXKP8wUVz7+Gl 6ZwksJOHRgaSfphb3H8ROCr4mMjIYkbqZBm3SDOOkzMNR5OmL9PVOy+6a5U4MeZyfRu2CvLtFbvD oKJLwAi59qMJpO5C+IqKzEaK7xO1lBtXNfSZWnz8CCaP+Vv14E86cuVpBDAzqpOeQpOL7Z1+kUrfJ8enabcvRyMtCOisc9kVcstQyuOeGiiV/Kwy0+yJda2sfiPO0jgyhUlYE5hmhgPy2lHrxIAW+fEzV/raGk2cnB5QqrFIGcmw2jgCnyLqryZSfQrmBOGk4ix+Pc8DQf5yjyh3X5eTovfN/v75g7LlcfRmzUATLH2DhY5YQIysjdyVPfeyTLv6nSFkiTv8jI52hQ5C3Mpmwe+uBcLDlOIfTvI1T7Ap+W/rtunwiAtOnap6J7xOoFdjPVZ34P+aW8pxeQjBpBNoVeYcpnvjOOcqVbTRLz1zGuTgyXexZ9Cj+F/ZMqXB07eBSRTkZmzZNJE2Qy3JTcz2RvupBWFajUmpWbfiwzRGuDkA5HUuUc/pC8y6iT21QHSdmpvhhrF6 mmqkEwg5v7VkwgYMgRsNnH4CJP9SKuncUQld8nAszmU8qdWs0OXQQyNGsmm4jFwefQJVx8wUAASf e9SmBBNlwEuwYSZXooBxEKjBhz0+t7zdRJbJQmqTEfJBt3ofj1DbTpnbkSSkF/vu9tIU3juuIUjtvp35OFLriHCiZbtX5guHIAlwHjlvtlNVxxUT5kFOf0+hqBL+8YPM5mpFE4fFB2HVvGIM7EketVs5E0UJyFyvApqO4Bsp9c4tf9sTDvb+fCGdp1e/KieXZ1FCqYEAJLdenoSQVIc43/=="
}

Monitoring API

The Monitoring API is used to schedule monitoring on an entity after onboarding.

Details:

Base URL: https://coreapi.prescreening.io/

End point : v2/api/monitoring

Header: Bearer {Token}

Method: POST

Monitoring API request for Batch:

				
					{
  "frequency": "Daily",
  "startDate": "10-03-2025",
  "RunFrequency": 1,
  "runTime": "10:20 AM",
  "batchId": "batch-name",
  "projectId": 85,
  "Timezone": "(GMT+0:00) Universal Time UTC",
  "setMonitoring": true
}

Monitoring API request for Case:

				
					{
  "frequency": "Daily",
  "startDate": "10-03-2025",
  "RunFrequency": 1,
  "runTime": "10:20 AM",
  "caseId": "CA560696L",
  "projectId": 85,
  "Timezone": "(GMT+0:00) Universal Time UTC",
  "setMonitoring": true
}

Monitoring API request for Case(Sample 2):

				
					{
  "frequency": "Fortnightly",
  "startDate": "10-03-2025",
  "RunFrequency": 1,
  "days": [
    "Mon"
  ],
  "runTime": "06:45 PM",
  "Timezone": "(GMT+0:00) Universal Time UTC",
  "caseId": "CA560699L",
  "projectId": 85,
  "setMonitoring": true
}

Monitoring API request for Entity:

				
					{
  "frequency": "Daily",
  "startDate": "10-03-2025",
  "RunFrequency": 1,
  "runTime": "10:20 AM",
  "entityId": "EN.00000001234",
  "projectId": 85,
  "Timezone": "(GMT+0:00) Universal Time UTC",
  "setMonitoring": true
}

Monitoring API request for Customer:

				
					{
  "frequency": "Daily",
  "startDate": "10-03-2025",
  "RunFrequency": 1,
  "runTime": "10:20 AM",
  "customerId": "customer-id",
  "projectId": 85,
  "Timezone": "(GMT+0:00) Universal Time UTC",
  "setMonitoring": true
}

Monitoring API Response:

				
					{
  "message": "Monitoring setting stored successfully",
  "success": true
}

Monitoring API Request for stopping monitoring:

				
					{
  "caseId": "CA560696L",
  "projectId": 85,
  "setMonitoring": false
}

Monitoring API stop response:

				
					{
  "message": "Monitoring stopped successfully",
  "success": true
}

Field Descriptions:

Datafield Name	Type	Single	Multiple	Description
Frequency	string	Yes		Can be “Once”, “Daily”, “Weekly”, “Fortnightly”, ”Monthly”, “Quarterly”, “Yearly”
StartDate	date(dd-mm-yyyy)	Yes		The date for the start of monitoring, formatted as dd-mm-yyyy.
RunFrequency	Integer	Yes		Runs the monitoring once every “X” times, depending upon Frequency. Eg: If Frequency is “Weekly” and RunFrequency is 3, then monitoring is run once every 3 weeks
Days	Array of strings		Yes	Runs monitoring on days as specified. First 3 letters of day need to be sent as input for this. Eg: [“Mon”, “Wed”]
DayOfMonth	string	Yes		Comma separated string which will tell system to run monitoring of particular date of month. Eg: “1,3,5” will run monitoring on 1st, 3rd and 5th of the month depending on frequency
NameOfMonth	string	Yes		Comma separated string which will tell system to run monitoring in particular. Eg: “January,July” will run monitoring in the month of January and July only. This is used with Yearly monitoring.
RunTime	string	Yes		Specifies time at which monitoring has to be run. It is HH:MM AM/PM format. Eg: “07:15 PM”
Timezone	string	Yes		Specifies time zone which needs to be configured in (GMT +/- HH:MM) format. Eg: "(GMT+05:30)", which is equivalent to Indian Standard Time.
setMonitoring	Boolean	Yes		Flag to enable/disable monitoring. Monitoring is stopped when setMonitoring is passed as false. User can pass “True” or “False”

Webhook Schema

Webhook Schema is used to deliver case outcomes to the client’s endpoint whenever there is a change in the status of a case. It provides real-time updates, including the case status and score.

Sample JSON:

				
					{
  "CaseId": "CA00001B",
  "CaseStatus": "Red",
  "CaseScore": "10/10",
  "ProjectId": 75,
  "ClientId": "cli12345",
  "OtherId": "other12345",
  "PostedAt": "2026-06-05T04:22:50.1514049Z",
  "EntityId": "EN.00004784839",
  "CustomerId": "cli12345",
  "CompositeApplicationStatus": "Closed - Project Admin"
}

Fields Descriptions:

S No	Field Name	Data Type	Description
1	CaseId	String	Represents the auto-generated CaseId from the system.
2	CaseStatus	String	This field indicates the status of the case. Options include Red, Amber, Green, or Grey.
3	CaseScore	String	This field specifies the current score of the case. The value for this field can range from 0/10 to 10/10 depending on the settings configuration.
4	ProjectId	Int	ProjectId associated with the account.
5	ClientId	String	Represents ClientID provided by the user to tag each entity.
6	OtherId	String	Represents WorkflowID provided by the user.
7	PostedAt	DateTime	This field indicates the time when the webhook was triggered.
8	EntityId	String	Represents the auto-generated EntityId from the system.
9	CustomerId	String	Customer ID is an input field that the user fills to identify their entity.
10	CompositeApplicationStatus	String	Composite Application Status shows the current status of the case. It can be one of the following: Need Review, Open, or Closed - Level 1 etc.

Case Body API

The Case Body API retrieves detailed information about the entities present in the case.

URL for Client ID:

URL: https://coreapi.prescreening.io/v2/
api/GetDataByClientIdOrCaseId?projectId=75&clientId={clientId}

Header: Bearer {Token}

Method: GET

URL for Case ID:

URL:https://coreapi.prescreening.io/v2/
api/GetDataByClientIdOrCaseId?caseId={caseId}’&projectId=75

Header: Bearer {Token}

Method: GET

Query Parameters:

caseId (Required if clientId is not provided): The ID of the case.
projectId (Required): The project ID for filtering the data.
clientId (Required if caseId is not provided): The ID of the client.

Case Body API Request:

				
					https://coreapi.prescreening.io/v2/api/GetDataByClientIdOrCaseId?caseId=CA12577790L&projectId=75

Case Body API Response:

				
					{
  "message": "Data in Body",
  "data": {
    "CaseAssociation": [
      {
        "Name": "Narendra Modi",
        "Score": "0/10",
        "Status": "Green",
        "Uid": "CA12577790LI001",
        "Type": "Individual",
        "ListingId": 13210586
      }
    ],
    "CaseOutcome": {
      "CaseName": "Narendra Modi",
      "CaseId": "CA12577790L",
      "CaseDeliveryStatus": "Need Review",
      "Score": "10/10",
      "Status": "Red"
    },
    "entitychecks": [
      {
        "HitsFound": {
          "SanctionCheck": 0
        },
        "SanctionCheck": [
          {
            "Additional Information": "",
            "Address": "",
            "Address Input Details": "",
            "Address Match Details": "",
            "Address Match Status": "",
            "Alias": "",
            "Associations": "",
            "Attachment": "",
            "Attachment2": "",
            "Attachment3": "",
            "AttachmentP": "",
            "Citizenship": "",
            "City": "",
            "City Match Details": "",
            "City Match Status": "",
            "Comment": "",
            "Comment2": "",
            "Comment3": "",
            "CommentP": "",
            "Country": "",
            "DOB": "",
            "DOB Match Status": "",
            "Date of Birth (DOB) from": "",
            "Date of Birth (DOB) to": "",
            "Derived Aliases": "",
            "Designation": "",
            "DobMatchDetails": "",
            "FinalScore": "",
            "FinalScore2": "",
            "FinalScore3": "",
            "FinalScoreP": "",
            "FinalStatus": "",
            "FinalStatus2": "",
            "FinalStatus3": "",
            "FinalStatusP": "",
            "FinalTimeStamp": "",
            "FinalTimeStamp2": "",
            "FinalTimeStamp3": "",
            "FinalTimeStampP": "",
            "Gender": "",
            "GenderMatchDetails": "",
            "GenderMatchStatus": "",
            "Identifier Match Details": "",
            "Identifier Match Score": "",
            "Identifier Match Status": "",
            "Image URL": "",
            "InputAddress": [
              ""
            ],
            "InputAlias": [],
            "InputAssociations": [
              "Modi"
            ],
            "InputCin": "",
            "InputCity": [
              ""
            ],
            "InputClientID": "qwafnklqwna",
            "InputConcatAddress": [
              "India"
            ],
            "InputCountry": [
              "India"
            ],
            "InputCountryOfResidence": [],
            "InputDateOfIncorporation": "",
            "InputDateofBirth": "",
            "InputDesignation": "",
            "InputDin": "",
            "InputEmailID": [],
            "InputEntityName": "Narendra Modi",
            "InputGender": "",
            "InputIdIdentifiers": [],
            "InputIdentifier_4": [],
            "InputIndustry": "",
            "InputNationality": "",
            "InputOrganization": [
              ""
            ],
            "InputOtherId": "",
            "InputPan": "",
            "InputPassport": [],
            "InputPhoneNumber": [],
            "InputPostalCode": [
              ""
            ],
            "InputSector": "",
            "InputState": [
              ""
            ],
            "InputType": "Individual",
            "InputVesselsType": "",
            "Label": "",
            "List Name": "",
            "ListUid": "",
            "Match": "",
            "Match2": "",
            "Match3": "",
            "MatchP": "",
            "Nationality": "",
            "Other Details": "",
            "Passport": "",
            "Passport Match Details": "",
            "Passport Match Status": "",
            "Place of Birth": "",
            "Priority": "",
            "Program": "",
            "Remarks": "",
            "Reviewer": "",
            "Reviewer2": "",
            "Reviewer3": "",
            "ReviewerId": 0,
            "ReviewerId2": 0,
            "ReviewerId3": 0,
            "ReviewerIdP": 0,
            "ReviewerP": "",
            "Rule Applied": "",
            "RunId": 18993653,
            "Sanctions Authority ID": "",
            "Sources": "",
            "State": "",
            "State Match Details": "",
            "State Match Status": "",
            "Street Address": "",
            "Street Address Match Details": "",
            "Street Address Match Score": "",
            "Sub-List Name": "",
            "composite_score": "",
            "details": "",
            "fileName": "",
            "fileName2": "",
            "fileName3": "",
            "fileNameP": "",
            "full_name": "",
            "fuzzy_score": "",
            "mappingId": 1,
            "match_description": "",
            "match_score": "0",
            "match_status": "Green",
            "sanction_date": "",
            "timestamp": "14 Feb 2025, GMT 09:09:10"
          }
        ],
        "entityName": "Narendra Modi",
        "entityType": "Individual",
        "totalResponseCount": 0
      }
    ]
  },
  "success": true
}

Fields Descriptions:

S No	Field Name	Data Type	Description
1	caseId	String	Represents the auto-generated CaseId from the system
2	caseStatus	String	This field indicates the status of the case. It include Red, Amber, Green, or Grey.
3	caseScore	String	This field specifies the current score of the case. The value for this field can range from 0/10 to 10/10.

Download PDF API

The PDF Download API allows users download the screening report in PDF format based on the file name.

Base URL: https://coreapi.prescreening.io/

End point : v2/api/DownloadPdfFile

Method: POST

Request for PDF Download:

				
					{
  "fileName": "CL15466000_Detailed.pdf",
  "projectId": 3
}

Fields Descriptions:

Datafield Name	Type	Required	Length	Single	Multiple	Description
Filename	string	Yes		Yes		The name of the PDF file to be downloaded.
projectId	int	Yes		Yes		The project ID associated with the report.

Phone Number Screening API

The Phone Number Screening API allows users to check whether a mobile number is flagged in the MNRL, FRI datasets, or the bank’s internal negative watchlist. This API is purpose-built for telecom number verification and integrates with bank internal monitoring systems.

Details:

Base URL: https://coreapi.prescreening.io/

End point :api/v1/CheckTelecomList

Method: POST

Sample request for Screening API request:

				
					{
  "pid": "12",
  "phone_number": "9999999999"
}

A successful API response returns HTTP 200 with the following JSON structure:

				
					[
  {
    "status": 200,
    "status_message": "Mobile Inquiry Successful",
    "data": {
      "mobile_number": "9999999999",
      "flag_status": "NOT_FLAGGED",
      "is_flagged": false,
      "FRI": {
        "is_flagged": false,
        "decision": "Green",
        "data": [
          {
            "mobile_number": "9999999999",
            "status": "compliant",
            "FRI_id": "3",
            "flaggedDate": "2026-04-12T00:00:00.000Z",
            "unflaggedDate": "2026-05-13T00:00:00.000Z",
            "dateCreated": "2026-03-14T06:10:35.470Z",
            "lastUpdated": "2026-04-13T06:10:30.217Z",
            "LSA_Name": "West Bengal",
            "FRI_Severity": "medium"
          }
        ]
      },
      "MNRL": {
        "is_flagged": false,
        "decision": "Green",
        "data": [
          {
            "id": "",
            "mobile_number": "9999999999",
            "LSA_id": "4",
            "LSA_Name": "Delhi",
            "TSP_id": "7",
            "TSP_Name": "VIL",
            "Date_Of_Incorporation": "2026-02-06T03:24:50.000Z",
            "Date_Of_Disconnection": "2026-02-04",
            "Disconnection_id": 2,
            "Disconnection_Reason": "Disconnection due to Zero usage or Non payment",
            "Date_of_Reactivation": null,
            "Reactivation_id": null,
            "Reactivation_Reason": null,
            "isActive": true,
            "dateCreated": "2026-02-16T14:59:06.960Z",
            "lastUpdated": "2026-02-16T14:59:06.960Z",
            "Unflagged_Date": "2026-05-06T00:00:00.000Z"
          }
        ]
      },
      "NegativeList": {
        "is_flagged": false
      }
    }
  }
]

The table below describes all request and response fields:

S No	Field Name	Data Type	Description
1	pid	String	Project ID under which API is configured
2	phone_number	String	Mobile number to be screened
3	status	Integer	HTTP status code
4	status_message	String	API execution result message
5	mobile_number	String	Input mobile number
6	flag_status	String	Overall flag status (FLAGGED / NOT FLAGGED)
7	is_flagged	Boolean	Indicates if number is flagged anywhere
8	FRI	Object	FRI dataset result details
9	MNRL	Object	MNRL dataset result details
10	NegativeList	Object	Internal watchlist result
11	TSP_id	string	Telecom Service Provider identifier
12	Disconnection_id	string	Disconnection record identifier
13	Date_Of_Disconnection	string	Date the number was disconnected (YYYY-MM-DD)
14	mobile_number	string	Mobile number in the MNRL record
15	LSA_id	string	Licensed Service Area identifier
16	LSA_Name	string	Name of the Licensed Service Area
17	TSP_Name	string	Name of the Telecom Service Provider
18	Disconnection_Reason	string	Reason for disconnection
19	isActive	boolean	Whether the disconnection record is active
20	id	string	Blank
21	Date_Of_Incorporation	Timestamp	Date when the mobile number was incorporated (YYYY-MM-DDThh:mm:ss.mssZ)
22	Date_of_Reactivation	Timestamp	Date when the number was reactivated after disconnection (null if not reactivated)
23	Reactivation_id	Integer	Identifier for the reactivation record
24	Reactivation_Reason	String	Reason for number reactivation
25	dateCreated	Timestamp	Timestamp when the MNRL record was created (YYYY-MM-DDThh:mm:ss.mssZ)
26	lastUpdated	Timestamp	Timestamp when the MNRL record was last updated (YYYY-MM-DDThh:mm:ss.mssZ)
27	Unflagged_Date	Timestamp	Date when the number was unflagged (YYYY-MM-DDThh:mm:ss.mssZ)

HTTP Response Code Description

Code	Response	Description
401	Error: response status is 401	The token expired
400	Bad request	Invalid Type. Type can only be either Individual, Organization, Vessels or All.
408	Request Timeout Error	The server did not receive a complete request from the client within the server's allotted timeout period.
409	Too Many Requests	The user has sent too many requests
500	Internal Server Error	The server has encountered a situation that it does not know how to handle
504	Gateway Timeout	The server is acting as a gateway and cannot get a response in time for a request.
200	Ok	Request recieved

Products

Use Cases

Industries

Latest Updates

Insights

Latest Updates

Company

Latest Updates

API Documentation

API Overview

Token

Prescreening API

Prescreening Encrypted Screening API

Monitoring API

Webhook Schema

Case Body API

Download PDF API

Phone Number Screening API

HTTP Response Code Description

Follow Us

Our Solutions

Navigation

Email Us

Contact Us

Our Locations

India

Our Locations

Singapore

Our Locations

UAE

Our Locations

Nepal

The Risk Application Ecosystem

Interested in

ZIGRAM's Products?

Our Complete AML system

API Documentation

API Overview

Token

Prescreening API

Prescreening Encrypted Screening API

Monitoring API

Webhook Schema

Case Body API

Download PDF API

Phone Number Screening API

HTTP Response Code Description

India

Singapore

UAE

Nepal