### Tune Source: https://apidocs.kyc2020.io/ Setup and configure screening components. ```APIDOC ## Tune ### Description Setup and configure screening components. ### Endpoint (Endpoint details not provided in the source) ``` -------------------------------- ### Example Batch Job Status Response (JSON) Source: https://apidocs.kyc2020.io/ This is a sample JSON response for a successful batch job status query. It includes details about the response status, pagination, and the contents of the batch job. ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "total_count": "257", "page_no": "0", "page_size": "10", "contents": [ { "batch_name": "DIQ_1786_1658824051906", "id": "710", "batch_screened_info": { "file_name": "decision_1786_1658824051906csv_15_neww_2030237696.csv", "created_on": ""2022-07-26 13:57:32"", "completion_on": ""2022-07-26"", "batch_status": "Completed", "decision_summary": [ { "name": "Carolann Hainds", "id": "234567", "date": "10-05-1999", "address": "string", "search_type": "2", "decision": "PASS", "reviewer_decision": "Marked as Prohibited" } ], "total_no_of_records": "15", "no_of_records": "15", "no_of_error_records": "0", "error_description": "string" }, "batch_reviewed_info": { "batch_review_status": "Reviewed", "batch_review_date": ""2022-07-26 14:17:48"", "error_records": [ "[{{\"51380\",\"51381\"}}]" ], "error_cuid_records": [ "[{{\"21234\",\"21236\"}}]" ], "no_of_errors": "5", "review_file": "5" }, "batch_annotate_info": { "annotation_status": "Completed", "annotation_date": ""2022-08-25 00:06:28.0"" }, "batch_stats_info": "PASS : 13", "batch_review_stats_info": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "created_by": "string" } ] } ``` -------------------------------- ### Activate Default Watchdog Rules Source: https://apidocs.kyc2020.io/ Activate the default Watchdog configuration for your account. This simplifies the setup by enabling a pre-defined set of rules. ```APIDOC ## GET /tune/dog/enable_rules ### Description Activate the default Watchdog configuration for your account. This simplifies the setup by enabling a pre-defined set of rules. ### Method GET ### Endpoint https://api.kyc2020.io/tune/dog/enable_rules ### Header Parameters - **apikey** (string) - Required - Your unique KYC2020 Account-specific API key. - **email** (string) - Required - Your registered Email ID associated with the KYC2020 Account. ### Response #### Success Response (200) - **decision_override_rules** (Array of objects) - A list of decision override rules. - **rule_id** (string) - The unique identifier for the rule. - **display_name** (string) - A display name for the rule. - **search_type** (string) - The type of search for the rule. - **rule_enable** (string) - Indicates if the rule is enabled. - **rule_condition** (string) - The condition for the rule to trigger. - **parameter_value** (string) - The parameter value associated with the rule. - **hit_action** (string) - The action to take when the rule is hit. - **decision_trigger** (string) - The trigger for a decision. - **enable_excessive_false_positive_value** (boolean) - Flag to enable excessive false positive value. - **excessive_false_positive_value** (string) - The value for excessive false positives. - **max_record_print** (string) - Maximum number of records to print. - **hit_to_clear** (string) - The threshold for clearing hits. - **dog_enable** (string) - Indicates if the Watchdog is enabled. - **response_status** (object) - Object containing status information. - **code** (string) - Status code. - **status** (string) - Status message. - **message** (string) - Detailed status message. #### Response Example ```json { "decision_override_rules": [ { "rule_id": "DRULE000", "display_name": "R00-HNRS", "search_type": "1", "rule_enable": "true", "rule_condition": "NRS Score>NRS_H", "parameter_value": "92", "hit_action": "DO NOT CLEAR" } ], "decision_trigger": "VERIFY#FAIL", "enable_excessive_false_positive_value": false, "excessive_false_positive_value": "0", "max_record_print": "5", "hit_to_clear": "50", "dog_enable": "true", "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" } } ``` ``` -------------------------------- ### Get Batch Job Status Response Sample Source: https://apidocs.kyc2020.io/ This is a sample response for retrieving the status of a batch job. It includes details about the response status, total count, pagination, and contents of the batch. ```json { * "response_status": { * "code": "2000", * "status": "SUCCESS", * "message": "OK" }, * "total_count": "257", * "page_no": "0", * "page_size": "10", * "contents": [ * { * "batch_name": "DIQ_1786_1658824051906", * "id": "710", * "batch_screened_info": { * "file_name": "decision_1786_1658824051906csv_15_neww_2030237696.csv", * "created_on": ""2022-07-26 13:57:32"", * "completion_on": ""2022-07-26"", * "batch_status": "Completed", * "decision_summary": [ * { * "name": "Carolann Hainds", * "id": "234567", * "date": "10-05-1999", * "address": "string", * "search_type": "2", * "decision": "PASS", * "reviewer_decision": "Marked as Prohibited" } ], * "total_no_of_records": "15", * "no_of_records": "15", * "no_of_error_records": "0", * "error_description": "string" }, * "batch_reviewed_info": { * "batch_review_status": "Reviewed", * "batch_review_date": ""2022-07-26 14:17:48"", * "error_records": [ * "[{{"51380","51381"}}]" ], * "error_cuid_records": [ * "[{{"21234","21236"}}]" ], * "no_of_errors": "5", * "review_file": "5" }, * "batch_annotate_info": { * "annotation_status": "Completed", * "annotation_date": ""2022-08-25 00:06:28.0"" }, * "batch_stats_info": "PASS : 13", * "batch_review_stats_info": { * "property1": { * "property1": "string", * "property2": "string" }, * "property2": { * "property1": "string", * "property2": "string" } }, * "created_by": "string" } ] } ``` -------------------------------- ### KYC API Search Payload Example Source: https://apidocs.kyc2020.io/ This JSON payload demonstrates a comprehensive request for the KYC API, including search criteria for sanctions lists and detailed information about merchants and beneficial owners. It is used to initiate a compliance check. ```json { "search_criteria": { "category_code_list": "pep,sdn", "datasource_group_name": "All Sanction", "query_count": "100", "min_shld_match": "75%", "response_type": "2,3,6", "include_adverse_media_stats": false, "include_adversemedia_articles": true, "ongoing_monitoring": { "ogm_enable": true, "customer_list": "MyEDDList", "pre_clearing_options": { "clear_pass": "NO", "clear_pass_reason": "string", "clear_verify": "NO", "clear_verify_reason": "string", "clear_fail": "NO", "clear_fail_reason": "string" } }, "merchant_id": "1234567ASD" }, "search_details": { "merchant": { "associate_type": "DBA", "cuid": "40245", "action": "0", "name": "Propo corp ltd", "identification": "31195855", "date": "09/19/1988", "record_type": "2", "filters": { "gender": "M", "nationality": "US", "country_codes": [ "US" ], "cities": [ "Chicago" ] } }, "beneficial_owners": [ { "associate_type": "DBA", "cuid": "40245", "action": "0", "name": "Propo corp ltd", "identification": "31195855", "date": "09/19/1988", "record_type": "2", "filters": { "gender": "M", "nationality": "US", "country_codes": [ "US" ], "cities": [ "Chicago" ] } } ] } } ``` -------------------------------- ### Sample Success Response for Customer List Creation/Update Source: https://apidocs.kyc2020.io/ This JSON response confirms the successful creation or update of a customer list and provides a URL for a generated PDF. ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "pod_url": "https://pdb.kyc2020.com/wfm/batch/v1/downloadPdfFile/Ml8wXzBfOTQzNDM1MTcxXzMxNzgucGRm" } ``` -------------------------------- ### Get Datasource Details Source: https://apidocs.kyc2020.io/ Retrieves the details of a specific datasource group. ```APIDOC ## GET /tune/datasource/datasource_group/{watchlist_group_name}/details ### Description Retrieves the details of a specific datasource group. ### Method GET ### Endpoint https://api.kyc2020.io/tune/datasource/datasource_group/{watchlist_group_name}/details ### Parameters #### Path Parameters - **watchlist_group_name** (string) - Required - The name of the watchlist group to retrieve details for. ### Response #### Success Response (200) - **response_status** (object) - Contains the status code, status, and message of the response. - **watch_list_name** (string) - The name of the watchlist. - **contents** (array) - An array of objects representing the watchlist contents. - **watch_list_contents** (array) - An array of objects representing the detailed contents of the watchlist. #### Response Example ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "watch_list_name": "All PEP", "contents": [ { "watchlist_name": "All PEP", "created_by": "string", "is_default": true, "is_master": true } ], "watch_list_contents": [ { "watchlist_name": "All PEP", "is_default": "All PEP", "is_master": "All PEP", "is_sanction": "string", "categories": [ { "id": 613, "description": "Hong Kong - Money service operators (HKMSB)", "alias": "hkmsb", "last_updated": "\"2022-08-03 19:18:33.0\"", "cat_type": "Sanction", "list_name": "hkmsb", "country_desc": "Hong Kong", "list_type": "HRB Data", "risk_name": "MSB", "deprecated": "0", "deprecated_on": "'2022-05-16 16:19:26.0'" } ], "created_by": "string" } ] } ``` ``` -------------------------------- ### Get Customer List Details Source: https://apidocs.kyc2020.io/ Retrieves details of a specific customer list. ```APIDOC ## Get Customer List Details ### Description Retrieves details of a specific customer list. ### Method GET ### Endpoint https://api.kyc2020.io/manage/members/customer_list/{customer_list_name} ### Parameters #### Path Parameters - **customer_list_name** (string) - Required - Enter the name of the Customer List you want to retrieve details of. #### Header Parameters - **email** (string) - Required - Example: john.doe@example.com - Your registered Email ID associated with the KYC2020 Account. - **apikey** (string) - Required - Example: a1b2c3d4e5f6g7h8i9j0 - Your unique KYC2020 Account-specific API key. ### Response #### Success Response (200) - **diq_custom_list** (object) - Details of the custom list. - **watch_list_name** (string) - Name of the watch list. - **sanction_watch_enable** (string) - Indicates if sanction watch is enabled ('True'/'False'). - **alert_notification_setting** (object) - Settings for alert notifications. #### Response Example ```json { "diq_custom_list": { "default_list": true, "custom_list_name": "MyCustomerList", "description": "string", "list_membership_cons": 1, "risk_profile": 3, "schedule_type": 2, "schedule_start_from": "11-06-2019", "do_not_include_update": true, "am_monitoring_enabled": true, "private_list_enabled": true }, "watch_list_name": "All Sanction", "sanction_watch_enable": "True/False", "alert_notification_setting": { "email": "string", "callback_url": "string", "no_of_retry": "string", "time_interval": "string", "notify_on_no_alert": "string" } } ``` ``` -------------------------------- ### Account Privileges Response Sample Source: https://apidocs.kyc2020.io/ This is a sample JSON response detailing the account privileges, showing user-specific access rights. ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "privileges": "OGM: YES" } ``` -------------------------------- ### Get Customer List Summary Source: https://apidocs.kyc2020.io/ Retrieves a summary of customer lists, allowing for pagination and filtering. ```APIDOC ## POST /review/diq/customer_list_summary/{customer_list_name}/{page_no}/{page_size} ### Description Retrieves a summary of customer lists, allowing for pagination and filtering. ### Method POST ### Endpoint https://api.kyc2020.io/review/diq/customer_list_summary/{customer_list_name}/{page_no}/{page_size} ### Parameters #### Path Parameters - **customer_list_name** (string) - Required - The name of the customer list. - **page_no** (integer) - Required - The page number to retrieve. - **page_size** (integer) - Required - The number of items per page. #### Request Body - **reviewer_status** (string) - Optional - The reviewer's status. - **monitor_status** (string) - Optional - The monitoring status. - **diq_status** (string) - Optional - The DIQ status. - **cuid** (string) - Optional - The customer unique identifier. - **date_from** (string) - Optional - The start date for filtering. - **date_to** (string) - Optional - The end date for filtering. - **decision_review** (string) - Optional - The decision review status. - **open_alert** (string) - Optional - Indicates if there are open alerts. - **name** (string) - Optional - The name to search for. ### Request Example ```json { "reviewer_status": "Cleared as Low Risk", "monitor_status": "ON", "diq_status": "FAIL", "cuid": "98123456", "date_from": "string", "date_to": "string", "decision_review": "YES", "open_alert": "YES", "name": "string" } ``` ### Response #### Success Response (200) - **response_status** (object) - Contains the status code, status message, and response message. - **summary** (object) - Contains the summary details of the customer list. - **total_elements** (integer) - Total number of elements. - **total_pages** (integer) - Total number of pages. - **first** (boolean) - Indicates if this is the first page. - **sort** (object) - Sorting information. - **number_of_elements** (integer) - Number of elements on the current page. - **pageable** (object) - Pagination details. - **last** (boolean) - Indicates if this is the last page. - **size** (integer) - The size of the page. - **content** (array) - An array of customer summary objects. - **alert_counter** (string) - The alert counter. - **merchant_id** (string) - The merchant ID. - **decision_tag** (string) - The decision tag. - **search_type** (integer) - The search type. - **monitor_status** (string) - The monitoring status. - **name** (string) - The customer's name. - **file_name** (string) - The associated file name. - **original_pod_url** (string) - URL to the original PDF file. - **diq_decision** (string) - The DIQ decision. - **alert_flag** (boolean) - Indicates if there is an alert. - **reviewer_action** (string) - The reviewer's action. - **batch_name** (string) - The batch name. - **job_id** (string) - The job ID. - **reviewer_comments** (string) - Comments from the reviewer. - **original_decision** (string) - The original decision. - **custom_list** (string) - The custom list name. - **reviewed_manual_decision** (string) - The manual decision made by the reviewer. - **reviewed_by** (string) - The user who reviewed the item. - **screened_by** (string) - The user who screened the item. - **reviewed_date** (string) - The date and time of the review. - **processing_date** (string) - The date and time of processing. - **cuid** (string) - The customer unique identifier. - **source** (string) - The source of the data. - **number** (integer) - The current page number. - **empty** (boolean) - Indicates if the page is empty. #### Response Example ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "summary": { "total_elements": 0, "total_pages": 0, "first": true, "sort": { "sorted": true, "unsorted": true, "empty": true }, "number_of_elements": 0, "pageable": { "page_size": 0, "page_number": 0, "sort": { "sorted": true, "unsorted": true, "empty": true }, "paged": true, "unpaged": true, "offset": 0 }, "last": true, "size": 0, "content": [ { "alert_counter": "0", "merchant_id": "string", "decision_tag": "string", "search_type": 0, "monitor_status": "ON", "name": "Jackson Paul Duminey Junior", "file_name": "string", "original_pod_url": "https://pdbcontent.kyc2020.com/wfm/batch/v1/downloadPdfFile/Ml8wXzBfNDcccccYyMzIxXzE3ODYucGRm", "diq_decision": "PASS", "alert_flag": true, "reviewer_action": "Reviewed", "batch_name": "string", "job_id": "string", "reviewer_comments": "Customer has been cleared as low risk.", "original_decision": "PASS", "custom_list": "AMLIST", "reviewed_manual_decision": "Escalated for EDD", "reviewed_by": "John Doe", "screened_by": "John Doe", "reviewed_date": "'2022-06-02 15:59:24.0'", "processing_date": "'2022-06-02 15:59:24.0'", "cuid": "1206614", "source": "Adhoc" } ], "number": 0, "empty": true } } ``` ``` -------------------------------- ### Get Batch Job Status Source: https://apidocs.kyc2020.io/ Retrieves the status of batch jobs based on provided job IDs. ```APIDOC ## Get Batch Job Status ### Description Retrieves the status of batch jobs using their unique IDs. ### Method GET ### Endpoint https://api.kyc2020.io/search/batch/diq/batch_job_status/by/{job_ids} ### Parameters #### Path Parameters - **job_ids** (string) - Required - Comma-separated list of job IDs to retrieve status for. ### Response #### Success Response (200) - **response_status** (object) - Contains the status code, status message, and a detailed message. - **total_count** (string) - The total number of records found. - **page_no** (string) - The current page number. - **page_size** (string) - The number of records per page. - **contents** (array) - An array of batch job details. - **batch_name** (string) - The name of the batch. - **id** (string) - The unique identifier for the batch job. - **batch_screened_info** (object) - Information about the screening process. - **file_name** (string) - The name of the file used for screening. - **created_on** (string) - The date and time the batch was created. - **completion_on** (string) - The date the batch screening was completed. - **batch_status** (string) - The status of the batch screening (e.g., 'Completed'). - **decision_summary** (array) - A summary of decisions made for records in the batch. - **name** (string) - The name of the individual. - **id** (string) - The ID of the individual. - **date** (string) - The date associated with the decision. - **address** (string) - The address of the individual. - **search_type** (string) - The type of search performed. - **decision** (string) - The screening decision (e.g., 'PASS'). - **reviewer_decision** (string) - The decision made by the reviewer. - **total_no_of_records** (string) - Total number of records in the batch. - **no_of_records** (string) - Number of records processed. - **no_of_error_records** (string) - Number of records with errors. - **error_description** (string) - Description of any errors encountered. - **batch_reviewed_info** (object) - Information about the review process. - **batch_review_status** (string) - The status of the batch review (e.g., 'Reviewed'). - **batch_review_date** (string) - The date and time the batch was reviewed. - **error_records** (array) - Records identified as errors during review. - **error_cuid_records** (array) - CUIDs of records identified as errors during review. - **no_of_errors** (string) - The total number of errors found during review. - **review_file** (string) - Identifier for the review file. - **batch_annotate_info** (object) - Information about annotation. - **annotation_status** (string) - The status of annotation (e.g., 'Completed'). - **annotation_date** (string) - The date and time of annotation. - **batch_stats_info** (string) - Statistical information about the batch (e.g., 'PASS : 13'). - **batch_review_stats_info** (object) - Statistical information about the batch review. - **property1** (object) - Placeholder for review statistics. - **property2** (object) - Placeholder for review statistics. - **created_by** (string) - The user who created the batch. ### Response Example ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "total_count": "257", "page_no": "0", "page_size": "10", "contents": [ { "batch_name": "DIQ_1786_1658824051906", "id": "710", "batch_screened_info": { "file_name": "decision_1786_1658824051906csv_15_neww_2030237696.csv", "created_on": "\"2022-07-26 13:57:32\"", "completion_on": "\"2022-07-26\"", "batch_status": "Completed", "decision_summary": [ { "name": "Carolann Hainds", "id": "234567", "date": "10-05-1999", "address": "string", "search_type": "2", "decision": "PASS", "reviewer_decision": "Marked as Prohibited" } ], "total_no_of_records": "15", "no_of_records": "15", "no_of_error_records": "0", "error_description": "string" }, "batch_reviewed_info": { "batch_review_status": "Reviewed", "batch_review_date": "\"2022-07-26 14:17:48\"", "error_records": [ "[\"{\"51380\",\"51381\"}\"]" ], "error_cuid_records": [ "[\"{\"21234\",\"21236\"}\"]" ], "no_of_errors": "5", "review_file": "5" }, "batch_annotate_info": { "annotation_status": "Completed", "annotation_date": "\"2022-08-25 00:06:28.0\"" }, "batch_stats_info": "PASS : 13", "batch_review_stats_info": { "property1": { "property1": "string", "property2": "string" }, "property2": { "property1": "string", "property2": "string" } }, "created_by": "string" } ] } ``` ``` -------------------------------- ### Response Sample for Alert Details (200 OK) Source: https://apidocs.kyc2020.io/ This is a sample successful JSON response for retrieving alert details. It includes status information and a list of alert details if found. ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "alert_details": { "total_elements": 0, "total_pages": 0, "first": true, "sort": { "sorted": true, "unsorted": true, "empty": true }, "number_of_elements": 0, "pageable": { "page_size": 0, "page_number": 0, "sort": { "sorted": true, "unsorted": true, "empty": true }, "paged": true, "unpaged": true, "offset": 0 }, "last": true, "size": 0, "content": [ { "cuid": "string", "member_name": "string", "alert_on": "JAIN SANJAY", "alert_date": ""2022-08-25 00:06:28.0"", "dob": ""1992-08-25 00:06:28.0"", "gender": "Male", "nrs_score": "90", "coda": "2N_SSLO", "list_type": "RA", "list_id": "innsedeoa", "hit_id": "0774d8094c7e4b294af1a494d658dac3", "reviewer_action": "Cleared as Low Risk", "reviewer_comment": "It's OK", "reviewed_date": "string", "reviewed_by": "string", "alert_reason": "string", "match_confidence": "string", "crime_predicates": "string", "title": "string", "alert_type": "AM - Adverse Media Alerts, WL - Watchlist Alerts" } ], "number": 0, "empty": true } } ``` -------------------------------- ### Get Datasource Details Source: https://apidocs.kyc2020.io/ Retrieves details for a specific data source group. Requires watchlist_group_name as a path parameter. ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "watch_list_name": "All PEP", "contents": [ { "watchlist_name": "All PEP", "created_by": "string", "is_default": true, "is_master": true } ], "watch_list_contents": [ { "watchlist_name": "All PEP", "is_default": "All PEP", "is_master": "All PEP", "is_sanction": "string", "categories": [ { "id": 613, "description": "Hong Kong - Money service operators (HKMSB)", "alias": "hkmsb", "last_updated": "\"2022-08-03 19:18:33.0\"", "cat_type": "Sanction", "list_name": "hkmsb", "country_desc": "Hong Kong", "list_type": "HRB Data", "risk_name": "MSB", "deprecated": "0", "deprecated_on": "'2022-05-16 16:19:26.0'" } ], "created_by": "string" } ] } ``` -------------------------------- ### Retrieve POD File Response Sample (200) Source: https://apidocs.kyc2020.io/ This JSON response indicates a successful retrieval of a Proof of Decision (POD) file, providing a URL to access it. ```json [ { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "pod_url": "https://pdb.kyc2020.com/wfm/batch/v1/downloadPdfFile/Ml8wXzBfOTQzNDM1MTcxXzMxNzgucGRm" } ] ``` -------------------------------- ### Request Sample for Alert Details Source: https://apidocs.kyc2020.io/ This is a sample JSON payload for requesting alert details. Ensure all fields match the expected schema. ```json { "alert_on": "John Doe", "alert_date": "'2022-08-25 00:06:28'", "nrs_score": "90", "coda": "2N_SSLO", "list_type": "RA", "list_id": "innsedeoa", "crime_predicates": "string", "reviewer_action": "Cleared as Low Risk", "alert_type": "AM - Adverse Media Alerts, WL - Watchlist Alerts", "page_no": "0", "page_size": "20" } ``` -------------------------------- ### Get Alert Details Source: https://apidocs.kyc2020.io/ Retrieves alert details for a specific customer based on customer ID and alert type. Requires authentication via email and API key. ```APIDOC ## GET /monitor/members/alert_details/{cuid}/{alert_type} ### Description Retrieves alert details for a specific customer identified by `cuid` and filtered by `alert_type`. This endpoint is useful for fetching alerts related to Watchlists (WL) or Adverse Media (AM). ### Method GET ### Endpoint https://api.kyc2020.io/monitor/members/alert_details/{cuid}/{alert_type} ### Parameters #### Path Parameters - **cuid** (string) - Required - Customer Unique ID (CUID) for the specific customer for whom you wish to retrieve alert details. - **alert_type** (string) - Required - The type of alerts you want to retrieve. Possible values are: WL – Alerts from Watchlists, AM: Alerts from Adverse Media. #### Header Parameters - **email** (string) - Required - Your registered Email ID associated with the KYC2020 Account. - **apikey** (string) - Required - Your unique KYC2020 Account-specific API key. ### Response #### Success Response (200) - **response_status** (object) - Contains the status code, status message, and a human-readable message. - **alert_details** (object) - Contains details about the alerts, including total elements, total pages, and a list of alert content. - **content** (array) - A list of alert objects, each containing details like `cuid`, `member_name`, `alert_on`, `alert_date`, `dob`, `gender`, `nrs_score`, `coda`, `list_type`, `list_id`, `hit_id`, `reviewer_action`, `reviewer_comment`, `reviewed_date`, `reviewed_by`, `alert_reason`, `match_confidence`, `crime_predicates`, `title`, and `alert_type`. #### Response Example (200) ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "alert_details": { "total_elements": 0, "total_pages": 0, "first": true, "sort": { "sorted": true, "unsorted": true, "empty": true }, "number_of_elements": 0, "pageable": { "page_size": 0, "page_number": 0, "sort": { "sorted": true, "unsorted": true, "empty": true }, "paged": true, "unpaged": true, "offset": 0 }, "last": true, "size": 0, "content": [ { "cuid": "string", "member_name": "string", "alert_on": "JAIN SANJAY", "alert_date": "2022-08-25 00:06:28.0", "dob": "1992-08-25 00:06:28.0", "gender": "Male", "nrs_score": "90", "coda": "2N_SSLO", "list_type": "RA", "list_id": "innsedeoa", "hit_id": "0774d8094c7e4b294af1a494d658dac3", "reviewer_action": "Cleared as Low Risk", "reviewer_comment": "It's OK", "reviewed_date": "string", "reviewed_by": "string", "alert_reason": "string", "match_confidence": "string", "crime_predicates": "string", "title": "string", "alert_type": "AM - Adverse Media Alerts, WL - Watchlist Alerts" } ], "number": 0, "empty": true } } ``` #### Error Responses - **400** Bad Request - Please check your request packet and ensure it conforms to the documented one. - **401** Authentication Error - Wrong Email or API Key. - **403** Forbidden - The resource can not be accessed. - **404** URL Not found - The resource you are requesting is not found on server. - **429** Quota Exceeded - Too many requests to serve, retry after some time. - **500** Internal Application Error - There was a problem with the response. Check response object for details. - **503** Service Under Maintenance - Service not available right now, retry after some time. ``` -------------------------------- ### View Private Lists Source: https://apidocs.kyc2020.io/ Get detailed information about private lists associated with your account. For sub-user accounts, master account details are returned. Requires email and API key. ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "private_list_contents": [ { "list_code": "criminallist", "list_description": "Blacklisted Members", "user_id": "1786", "user_name": "Peter Jackson", "csv_file_name": "privatelist.csv", "create_date": "023-01-02 05:47:00.0", "no_of_records": "5" } ] } ``` -------------------------------- ### Annotate POD files for a Batch Job Source: https://apidocs.kyc2020.io/ Utilize this service to add annotations to Proof of Decision files for a Batch Job, indicating the actions taken by the reviewer. ```APIDOC ## GET /review/batch/diq/annotate_pods/{job_id} ### Description Utilize this service to add annotations to Proof of Decision files for a Batch Job, indicating the actions taken by the reviewer. ### Method GET ### Endpoint https://api.kyc2020.io/review/batch/diq/annotate_pods/{job_id} ### Parameters #### Path Parameters - **job_id** (string) - Required - Enter the Job ID associated with the Batch Search. #### Header Parameters - **apiKey** (string) - Required - Your unique KYC2020 Account-specific API key. - **email** (string) - Required - Your registered Email ID associated with the KYC2020 Account. ### Response #### Success Response (200) Valid Response #### Response Example ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "contents": { "decision_file_url": "https://stagtest.kyc2020.com/wfm/batch/v1/downloadcsvfile/ZGVjaXNpb25fMTc4Nl8xNjU3MDA3NTc0MzE2Y3VzdG9tam9iLmNzdg==", "download_info": "Use URL received in the email/webhook notification to download the output decision CSV file", "job_id": "567" } } ``` ``` -------------------------------- ### Retrieve a Proof of Decision (POD) file Source: https://apidocs.kyc2020.io/ This service enables the retrieval and download of the Proof of Decision (POD) file for a screened customer using the Customer Unique Identifier (CUID). ```APIDOC ## Retrieve a Proof of Decision (POD) file ### Description This service enables the retrieval and download of the Proof of Decision (POD) file for a screened customer using the Customer Unique Identifier (CUID). ### Method GET ### Endpoint https://api.kyc2020.io/search/viewpod/{cuid} ### Parameters #### Path Parameters - **cuid** (string) - Required - The CUID of the Customer you want to retrieve a POD for. #### Header Parameters - **email** (string) - Required - Your registered Email ID associated with the KYC2020 Account. - **apikey** (string) - Required - Your unique KYC2020 Account-specific API key. ### Responses #### Success Response (200) - **response_status** (object) - Status of the response. - **code** (string) - Response code. - **status** (string) - Response status. - **message** (string) - Response message. - **pod_url** (string) - URL to download the POD file. #### Response Example ```json [ { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "pod_url": "https://pdb.kyc2020.com/wfm/batch/v1/downloadPdfFile/Ml8wXzBfOTQzNDM1MTcxXzMxNzgucGRm" } ] ``` ``` -------------------------------- ### Submit Feedback on Screening Decisions Source: https://apidocs.kyc2020.io/ Use this endpoint to provide feedback on a screening decision, including the Proof of Decision (POD) file. Requires API key and email in headers. ```json { "search_type": "string", "search_name": "string", "result_decision": "string", "min_should_match": "string", "pod_url": "string", "version_no": "string", "phonetic": "string", "comments": "string", "rating": "string", "module": "string", "search_parameters": "string", "processing_time": "string", "cuid": "string" } ``` -------------------------------- ### Upload Batch Data - POST /search/batch/diq/batch_upload Source: https://apidocs.kyc2020.io/ Use this endpoint to upload batch data for review. Requires an API key, email, and a multipart/form-data request body containing the CSV file. ```json { "response_status": { "code": "2000", "status": "SUCCESS", "message": "OK" }, "contents": { "decision_file_url": "https://stagtest.kyc2020.com/wfm/batch/v1/downloadcsvfile/ZGVjaXNpb25fMTc4Nl8xNjU3MDA3NTc0MzE2Y3VzdG9tam9iLmNzdg==", "download_info": "Use URL received in the email/webhook notification to download the output decision CSV file", "job_id": "567" } ```