{"swagger":"2.0","info":{"version":"v1","title":"Cedar Rose API","description":""},"host":"apitest.cedar-rose.com","schemes":["https"],"paths":{"/api/reporting/customer-metrics":{"post":{"tags":["Reporting"],"summary":"Customer Metrics","description":"Request Parameters:\r\n\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><strong>start_date</strong></td><td>string</td><td>The start date for the metrics query.(DD/MM/YYYY)</td></tr><tr><td><strong>end_date</strong></td><td>string</td><td>The end date for the metrics query.(DD/MM/YYYY)</td></tr><tr><td><strong>Username</strong></td><td>string</td><td>used to filter the Metrics based on a valid username</td></tr></tbody></table>\r\nSample request:\r\n\r\n    {\r\n        \"start_date\": \"20/11/2024\",\r\n        \"end_date\": \"20/12/2024\",\r\n        \"Username\": \"\"\r\n    }\r\n\r\nResponse Parameters\r\n\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><strong>customer_id</strong></td><td>string</td><td>Client Name</td></tr><tr><td><strong>start_date</strong></td><td>string</td><td>The start date for the metrics query.(DD/MM/YYYY)</td></tr><tr><td><strong>end_date</strong></td><td>string</td><td>The end date for the metrics query.(DD/MM/YYYY)</td></tr><tr><td><strong>Username</strong></td><td>string</td><td>filtered Metrics based on a valid username</td></tr><tr><td><strong>Metrics</strong></td><td>object</td><td>JSON object containing Order information grouped by Speed and Status of the Order</td></tr><tr><td><strong>totalOrderCount</strong></td><td>integer</td><td>Total Number of orders across the date range for an account</td></tr><tr><td><strong>Regular</strong></td><td>object</td><td>Metrics for regular orders</td></tr><tr><td><strong>Download</strong></td><td>object</td><td>Metrics for download orders</td></tr><tr><td><strong>Urgent</strong></td><td>object</td><td>Metrics for urgent orders</td></tr><tr><td><strong>24 Hours</strong></td><td>object</td><td>Metrics for 24 Hours orders</td></tr><tr><td><strong>SpeedId</strong></td><td>integer</td><td>The speed ID for the order type</td></tr><tr><td><strong>TotalOrders</strong></td><td>integer</td><td>Total Number of Orders for that specific Speed</td></tr><tr><td><strong>Analysis</strong></td><td>object</td><td>Detailed analysis of the orders</td></tr><tr><td><strong>New</strong></td><td>object</td><td>Order Metrics for orders placed with (New) status</td></tr><tr><td><strong>Assigned</strong></td><td>object</td><td>Order Metrics for orders placed with (Assigned) status</td></tr><tr><td><strong>Deleted</strong></td><td>object</td><td>Order Metrics for orders placed with (Deleted) status</td></tr><tr><td><strong>Sent</strong></td><td>object</td><td>Order Metrics for orders placed with (Sent) status</td></tr><tr><td><strong>NoTrace</strong></td><td>object</td><td>Order Metrics for orders placed with (NoTrace) status</td></tr><tr><td><strong>Count</strong></td><td>integer</td><td>Total Number of Orders for that specific Speed and Status</td></tr><tr><td><strong>OrdersIds</strong></td><td>array</td><td>List of order IDs</td></tr></tbody></table>  \r\nSample response:\r\n\r\n    {\r\n        \"customer_id\": \"CEDAR ROSE\",\r\n        \"start_date\": \"20/11/2024\",\r\n        \"end_date\": \"20/12/2024\",\r\n        \"username\": \"\",\r\n        \"metrics\": {\r\n            \"totalOrderCount\": 6,\r\n            \"Regular\": {\r\n                \"SpeedId\": 1,\r\n                \"TotalOrders\": 2,\r\n                \"Analysis\": {\r\n                    \"New\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    },\r\n                    \"Assigned\": {\r\n                        \"Count\": 1,\r\n                        \"OrdersIds\": [1476241]\r\n                    },\r\n                    \"Finalised\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    },\r\n                    \"Sent\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    },\r\n                    \"NoTrace\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    }\r\n                }\r\n            },\r\n            \"Download\": {\r\n                \"SpeedId\": 2,\r\n                \"TotalOrders\": 3,\r\n                \"Analysis\": {\r\n                    \"New\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    },\r\n                    \"Assigned\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    },\r\n                    \"Finalised\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    },\r\n                    \"Sent\": {\r\n                        \"Count\": 3,\r\n                        \"OrdersIds\": [\r\n                            1476248,\r\n                            1476249,\r\n                            1476272\r\n                        ]\r\n                    },\r\n                    \"NoTrace\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    }\r\n                }\r\n            },\r\n            \"Urgent\": {\r\n                \"SpeedId\": 3,\r\n                \"TotalOrders\": 1,\r\n                \"Analysis\": {\r\n                    \"New\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    },\r\n                    \"Assigned\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    },\r\n                    \"Finalised\": {\r\n                        \"Count\": 1,\r\n                        \"OrdersIds\": [1476215]\r\n                    },\r\n                    \"Sent\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    },\r\n                    \"NoTrace\": {\r\n                        \"Count\": 0,\r\n                        \"OrdersIds\": []\r\n                    }\r\n                }\r\n            }\r\n        }\r\n    }","operationId":"Reporting_CustomerMetrics","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"customerMetricsRequest","in":"body","description":"The request object containing start and end dates.","required":true,"schema":{"$ref":"#/definitions/CustomerMetricsRequest"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"200":{"description":"Returns the customer metrics.","schema":{"type":"object"}},"400":{"description":"If the request is invalid."},"403":{"description":"If the user is unauthorized."},"500":{"description":"If there is an internal server error."}}}},"/api/Company/Search":{"post":{"tags":["Orders API"],"summary":"Company Search by Name/Registers","description":" JSON Request Parameters:\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>SearchTypeId (required)</b></td><td>string</td><td>Defines search input, 0 = name , 4 = register number, 2 = address</td></tr><tr><td><b>CountryID (required)</b></td><td>Integer</td><td>Country filter.</td></tr><tr><td><b>Page (required)</b></td><td>Integer</td><td>Number of pages to return. Default value 1</td></tr><tr><td><b>PageSize (required)</b></td><td>Integer</td><td>Number of results in each page. Default value 10</td></tr><tr><td><b>Name</b></td><td>String</td><td>English name, Arabic name, or register number. Can contain % in the start, middle, and/or end. (required if SearchTypeId = 0)</td></tr><tr><td><b>RegisterNumber</b></td><td>String</td><td>Company's registration number. Used when SearchTypeId = 4</td></tr><tr><td><b>IdTown</b></td><td>Integer</td><td> Identifier for the Town that can be used with the Company Name. (optional if SearchTypeId = 0)</td></tr><tr><td><b>Town</b></td><td>String</td><td>Town name of company's primary address. Used when SearchTypeId = 2</td></tr><tr><td><b>POBox</b></td><td>String</td><td>POBox of company's primary address. Used when SearchTypeId = 2</td></tr><tr><td><b>Street</b></td><td>String</td><td>Street name of company's primary address. Used when SearchTypeId = 2</td></tr><tr><td><b>PostalCode</b></td><td>String</td><td>Postal code of company's primary address. Used when SearchTypeId = 2</td></tr><tr><td><b>FuzzySearch</b></td><td>bit</td><td>By default, FuzzySearch =1. Specify FuzzySearch = 0 to disable Fuzzy Search and retrieve exact match. Used when SearchTypeId = 0</td></tr></tbody></table><br></br><b>JSON Response Parameters:</b><br></br><table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>Name</b></td><td>String</td><td>Company's name</td></tr><tr><td><b>NameLocal</b></td><td>String</td><td>Name in local script</td></tr><tr><td><b>UID</b></td><td>String</td><td>Country code + Cedar Rose reference number</td></tr><tr><td><b>CommercialRegister</b></td><td>String</td><td>Company's registration number</td></tr><tr><td><b>SubjectCountryId</b></td><td>Integer</td><td>Country identifier</td></tr><tr><td><b>Country</b></td><td>String</td><td>Country name</td></tr><tr><td><b>Town</b></td><td>String</td><td>Town name of company's primary address</td></tr><tr><td><b>POBox</b></td><td>String</td><td>POBox of company's primary address</td></tr><tr><td><b>Street</b></td><td>String</td><td>Street name of company's primary address</td></tr><tr><td><b>Area</b></td><td>String</td><td>Area name of company's primary address</td></tr><tr><td><b>PostalCode</b></td><td>String</td><td>Postal code of company's primary address</td></tr><tr><td><b>AddressInfo</b></td><td>String</td><td>Additional address information</td></tr><tr><td><b>UpdatedDate</b></td><td>String</td><td>Date when company information was last updated. Format yyyy-MM-dd</td></tr><tr><td><b>Status</b></td><td>String</td><td>Active/Inactive status of company. NULL if status not available</td></tr><tr><td><b>ReferenceNo</b></td><td>String</td><td>Company's reference number</td></tr><tr><td><b>fuzzySearch</b></td><td>bit</td><td>1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn't belong to Fuzzy Search performed</td></tr><tr><td><b>MatchingRate</b></td><td>decimal</td><td>Fuzzy Search score of Company Name that ranges between values (0.0 – 1.0) which is based on the input Company Name provided</td></tr></tbody></table><b>JSON Request sample:</b>\r\n\r\n     {\r\n      \"SearchTypeId\": \"0\",\r\n      \"CountryID\": 48,\r\n      \"Name\": \"SAMPLE COMPANY NAME\", \r\n      \"Page\": 1,\r\n      \"PageSize\": 10\r\n      }\r\n\r\n <b>JSON Response sample:</b>\r\n \r\n\t   {\r\n\t\t\"Name\": \"SAMPLE COMPANY NAME\",\r\n\t\t\"NameLocal\": \"\",\r\n\t\t\"UID\": \"CYC0344627\",\r\n\t\t\"CommercialRegister\": \"12345\",\r\n\t\t\"SubjectCountryID\": 36,\r\n\t\t\"Country\": \"Cyprus\",\r\n\t\t\"Town\": \"Limassol\",\r\n\t\t\"AddressInfo\": \" Limassol\",\r\n\t\t\"UpdatedDate\": \"2020-08-27\",\r\n\t\t\"ReferenceNo\": \"34534534\",\r\n\t\t\"TotalRecords\": 1\r\n\t    }","operationId":"Company_SearchCompany","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"json","in":"body","required":true,"schema":{"$ref":"#/definitions/CompanySearchDTO"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"Fuzzy Search Not Available for this Coutnry"}}}},"/api/Company/AvailableSectionsByUID":{"post":{"tags":["Orders API"],"summary":"Check Available Sections for UID","description":"<b>JSON Response sample:</b>\r\n            \r\n            [\r\n                {\r\n                    \"MainName\": \"Credit Rating\",\r\n                    \"DateUpdated\": \"07/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Trading Names\",\r\n                    \"DateUpdated\": \"07/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Legal Form\",\r\n                    \"DateUpdated\": \"05/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Country Overview\",\r\n                    \"DateUpdated\": \"05/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"CR Score\",\r\n                    \"DateUpdated\": \"05/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Auto Credit Rating\",\r\n                    \"DateUpdated\": \"05/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Group Structure\",\r\n                    \"DateUpdated\": \"05/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Date Registered\",\r\n                    \"DateUpdated\": \"05/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Name\",\r\n                    \"DateUpdated\": \"05/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Production Capacity\",\r\n                    \"DateUpdated\": \"05/02/2025\",\r\n                    \"IsAvailable\": false\r\n                },\r\n                {\r\n                    \"MainName\": \"Short Name\",\r\n                    \"DateUpdated\": \"05/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Shareholders\",\r\n                    \"DateUpdated\": \"03/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Shareholders Shares\",\r\n                    \"DateUpdated\": \"03/02/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Employees\",\r\n                    \"DateUpdated\": \"24/01/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Capital\",\r\n                    \"DateUpdated\": \"21/01/2025\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Financials\",\r\n                    \"DateUpdated\": \"31/12/2024\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Managers\",\r\n                    \"DateUpdated\": \"05/09/2024\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Premises\",\r\n                    \"DateUpdated\": \"02/07/2024\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Addresses\",\r\n                    \"DateUpdated\": \"17/04/2024\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Former Names\",\r\n                    \"DateUpdated\": \"25/07/2022\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Affiliates\",\r\n                    \"DateUpdated\": \"26/01/2022\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Activities\",\r\n                    \"DateUpdated\": \"30/07/2021\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Status\",\r\n                    \"DateUpdated\": \"19/08/2020\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Registers\",\r\n                    \"DateUpdated\": \"15/07/2020\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Brands\",\r\n                    \"DateUpdated\": \"15/07/2020\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Certifications\",\r\n                    \"DateUpdated\": \"01/03/2018\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Clients\",\r\n                    \"DateUpdated\": \"01/03/2018\",\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"History\",\r\n                    \"DateUpdated\": null,\r\n                    \"IsAvailable\": true\r\n                },\r\n                {\r\n                    \"MainName\": \"Investments\",\r\n                    \"DateUpdated\": null,\r\n                    \"IsAvailable\": false\r\n                },\r\n                {\r\n                    \"MainName\": \"Trade Rate Stars\",\r\n                    \"DateUpdated\": null,\r\n                    \"IsAvailable\": false\r\n                }\r\n            ]","operationId":"Company_AvailableSectionsByUID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"UID","in":"query","description":"","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/Company/ReceiveJsonReport":{"get":{"tags":["Orders API"],"summary":"Receive report in JSON format","description":"<b>JSON Response sample:</b>\r\n            \r\n                {\r\n                    \"orderid\": 1413189,\r\n                    \"statusCode\": \"200\",\r\n                    \"message\": \"Success\",\r\n                    \"jsonData\": \"{ REPORT DATA AS JSON }\"\r\n                }","operationId":"Company_ReceiveJsonReport","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"OrderId","in":"query","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/Company/ReceivePdfReport":{"post":{"tags":["Orders API"],"summary":"Receive report in PDF format","description":"<b>JSON Response sample:</b>\r\n            \r\n                {\r\n                    \"orderid\": 1413189,\r\n                    \"statusCode\": \"200\",\r\n                    \"message\": \"Success\",\r\n                    \"pdfData\": \"base64 encoded PDF file\"\r\n                }","operationId":"Company_ReceivePdfReport","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"OrderID","in":"query","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/order/RequestOrder":{"post":{"tags":["Orders API"],"summary":"Place order for report","description":" JSON Request Parameters:\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><strong>SubjectName (required*)</strong></td><td>String</td><td>The available name of the company. Required to include either SubjectName. For Fresh investigation speeds (speedId = 1,3,4), SubjectName is required.</td></tr><tr><td><strong>ProductId (required)</strong></td><td>String</td><td>serial number of the requested product (example: 284 is the serial number of Company Credit Report)</td></tr><tr><td><strong>SpeedId (required)</strong></td><td>String</td><td>serial number of the requested Speed (example: 1 is the serial number of the regular speed)</td></tr><tr><td><strong>SubjectCountryID (required)</strong></td><td>String</td><td>serial number of the Country of the order</td></tr><tr><td><strong>UID (required*)</strong></td><td>String</td><td>serial number of the company (if available). Required to include either SubjectName or UID. For Download speeds (speedId = 2), UID is required.</td></tr><tr><td><strong>AdditionalInfo</strong></td><td>String</td><td>additional info that you would like to include in your request</td></tr><tr><td><strong>SubjectDetails</strong></td><td>String</td><td>available details about the company</td></tr><tr><td><strong>TradingName</strong></td><td>String</td><td>available trading names of the company</td></tr><tr><td><strong>CustomerReference</strong></td><td>String</td><td>could be your serial number or project ID or purchase number or just \"0\"</td></tr><tr><td><strong>AddMonitoring</strong></td><td>integer</td><td>Specify AddMonitoring = 1 to enable monitoring for that specific order</td></tr></tbody></table><br></br><b>JSON Response Parameters:</b><br></br><table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><strong>Price</strong></td><td>String</td><td>the price amount of the order, according to the product, speed, and country</td></tr><tr><td><strong>VAT</strong></td><td>String</td><td>the VAT amount</td></tr><tr><td><strong>OrderId</strong></td><td>String</td><td>Unique Identifier for the Order placed</td></tr><tr><td><strong>DueDate</strong></td><td>String</td><td>the Due Date of the order, according to product, speed, country, holidays...</td></tr><tr><td><strong>UID</strong></td><td>String</td><td>country code + Cedar Rose reference number</td></tr><tr><td><strong>Content</strong></td><td>String (XML)</td><td>you will receive xml design separately according to the product</td></tr></tbody></table><br></br><b>JSON Request Sample:</b>\r\n \r\n     {      \r\n\t        \"ProductId\": \"547\",\r\n\t        \"SpeedId\": \"2\",\r\n\t        \"SubjectCountryId\": \"9\",\r\n\t        \"UID\": \"BHC0057425\",\r\n\t        \"CustomerReference\": \"TEST\"\r\n     }\r\n   \r\n <br></br><b>JSON Response Sample:</b>\r\n \r\n     {\r\n\t\t    \"Name\": \"SAMPLE COMPANY NAME\",\r\n\t\t    \"NameLocal\": \"\",\r\n\t\t    \"UID\": \"CYC0344627\",\r\n\t\t    \"CommercialRegister\": \"12345\",\r\n\t\t    \"SubjectCountryID\": 36,\r\n\t\t    \"Country\": \"Cyprus\",\r\n\t\t    \"Town\": \"Limassol\",\r\n\t\t    \"AddressInfo\": \" Limassol\",\r\n\t\t    \"UpdatedDate\": \"2020-08-27\",\r\n\t\t    \"ReferenceNo\": \"34534534\",\r\n\t\t    \"TotalRecords\": 1\r\n\t    }","operationId":"Order_RequestOrder","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderDTO","in":"body","required":true,"schema":{"$ref":"#/definitions/OrderDTO"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"Parameter Value Invalid"}}}},"/api/order/Files/OrderFileUpload":{"post":{"tags":["Orders API"],"summary":"OrderFileUpload","description":" JSON Request Parameters:\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><strong>OrderId</strong></td><td>Integer</td><td>Order Identifier</td></tr><tr><td><strong>FileTypeId</strong></td><td>Integer</td><td>File Type identifier (refer Get File Types)</td></tr><tr><td><strong>File</strong></td><td>.doc,.docx,.pdf,.jpg,.jpeg,.png</td><td>File to be uploaded associated with the order</td></tr></tbody></table><br></br><b>JSON Response sample:</b>\r\n \r\n     {\r\n      \"Files\": [\r\n         {\r\n             \"ResponseCode\": 3,\r\n             \"FileName\": \"CR Identify Report.pdf\",\r\n             \"Message\": \"'CR Identify Report.pdf' exceeds maximum File Size.\"\r\n         }\r\n     ],\r\n     \"Message\": \"0 out of 1 files Uploaded Sucessfully\"\r\n     }","operationId":"Order_OrderFileUpload","consumes":["multipart/form-data"],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"},{"name":"OrderId","in":"formData","description":"Order identifier","required":true,"type":"string"},{"name":"FileTypeId","in":"formData","description":"File type identifier","required":true,"type":"string"},{"name":"File","in":"formData","description":"File to upload","required":true,"type":"file"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/order/Files/FileTypes":{"get":{"tags":["Orders API"],"summary":"FileTypes","description":"<b>JSON Response sample:</b>\r\n            \r\n                {\r\n                  \"Company\": [\r\n                    {\r\n                      \"ID\": 20,\r\n                      \"Name\": \"Approved Electronic Copy of Commercial License\"\r\n                    },\r\n                    {\r\n                      \"ID\": 17,\r\n                      \"Name\": \"Certificate Copy of Change of name\"\r\n                    },\r\n                    {\r\n                      \"ID\": 18,\r\n                      \"Name\": \"Certificate Copy of Financials\"\r\n                    },\r\n                    {\r\n                      \"ID\": 1,\r\n                      \"Name\": \"Certified Copy of Articles of Association\"\r\n                    },\r\n                    {\r\n                      \"ID\": 2,\r\n                      \"Name\": \"Certified Copy of Certificate of Directors\"\r\n                    },\r\n                    {\r\n                      \"ID\": 3,\r\n                      \"Name\": \"Certified Copy of Certificate of Directors and Secretary\"\r\n                    },\r\n                    {\r\n                      \"ID\": 4,\r\n                      \"Name\": \"Certified Copy of Certificate of Good Standing\"\r\n                    },\r\n                    {\r\n                      \"ID\": 5,\r\n                      \"Name\": \"Certified Copy of Certificate of Incorporation\"\r\n                    },\r\n                    {\r\n                      \"ID\": 11,\r\n                      \"Name\": \"Certified Copy of Certificate of Particulars of Directors/shareholders\"\r\n                    },\r\n                    {\r\n                      \"ID\": 6,\r\n                      \"Name\": \"Certified Copy of Certificate of Registered Office Address\"\r\n                    },\r\n                    {\r\n                      \"ID\": 7,\r\n                      \"Name\": \"Certified Copy of Certificate of Share Capital\"\r\n                    },\r\n                    {\r\n                      \"ID\": 8,\r\n                      \"Name\": \"Certified Copy of Certificate of Shareholders\"\r\n                    },\r\n                    {\r\n                      \"ID\":16,\r\n                      \"Name\": \"Certified Copy of Chamber of Commerce and Industry Membership\"\r\n                    },\r\n                    {\r\n                      \"ID\": 13,\r\n                      \"Name\": \"Certified Copy of Extract of Commercial Register\"\r\n                    },\r\n                    {\r\n                      \"ID\": 12,\r\n                      \"Name\": \"Certified Copy of Licence\"\r\n                    },\r\n                    {\r\n                      \"ID\": 9,\r\n                      \"Name\": \"Certified Copy of Memorandum of Articles and Associations\"\r\n                    },\r\n                    {\r\n                      \"ID\": 10,\r\n                      \"Name\": \"Certified Copy of Memorandum of Association\"\r\n                    },\r\n                    {\r\n                      \"ID\": 14,\r\n                      \"Name\": \"Copy of Filed Financial Statement or Annual Return\"\r\n                    },\r\n                    {\r\n                      \"ID\": 15,\r\n                      \"Name\": \"Copy of Published Financial Statement or Annual Return\"\r\n                    }\r\n                  ],\r\n                  \"Person\": [\r\n                    {\r\n                      \"ID\": 1,\r\n                      \"Name\": \"Person File Upload\"\r\n                    }\r\n                  ]\r\n                }","operationId":"Order_FileTypes","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/order/Files/GetUploadedFiles":{"get":{"tags":["Orders API"],"summary":"GetUploadedFiles","description":"<b>JSON Response sample:</b>\r\n            \r\n                [\r\n                    {\r\n                        \"Id\": 73120,\r\n                        \"FileName\": \"ADIP-OM301_Step1_Count.txt\",\r\n                        \"FileType\": \"Testing\",\r\n                        \"FileTypeId\": 1\r\n                    },\r\n                    {\r\n                        \"Id\": 73121,\r\n                        \"FileName\": \"ADIP-OM301_Step1_Count.txt\",\r\n                        \"FileType\": \"Testing\",\r\n                        \"FileTypeId\": 1\r\n                    }\r\n            ]","operationId":"Order_GetClientFilesList","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"OrderId","in":"query","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/order/Files/DeleteUploadedFile":{"post":{"tags":["Orders API"],"summary":"DeleteUploadedFile","operationId":"Order_DeleteClientFile","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"OrderId","in":"query","required":true,"type":"integer","format":"int32"},{"name":"FileId","in":"query","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ResponseOrderFiles"}}}}}},"/api/order/GetPricebySpeedId":{"post":{"tags":["Orders API"],"summary":"Retrieves price given product, speed and country","description":"<b>Request Parameters:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <strong>ProductId</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Product identifier</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>SpeedId</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Speed Identifier</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>SubjectCountryId</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Country Identifier</td>\r\n    </tr>\r\n  </tbody>\r\n</table>\r\n<br></br>\r\n<b>Response Parameters:</b>\r\n<br></br>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <strong>amount</strong>\r\n      </td>\r\n      <td>Decimal</td>\r\n      <td>Cost of order</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Order_GetPricebySpeedId","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderDTO","in":"body","required":true,"schema":{"$ref":"#/definitions/OrderDTO"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/order/OrderDueDate":{"post":{"tags":["Orders API"],"summary":"Retrieves due date for order","description":"<b>Request Parameters:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <strong>ProductId</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Product identifier</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>SpeedId</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Speed Identifier</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>SubjectCountryId</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Last name</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>UID</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Country Identifier</td>\r\n    </tr>\r\n  </tbody>\r\n</table>\r\n<br></br>\r\n<b>Response Parameters:</b>\r\n<br></br>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <strong>DueDate</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Due date for report delivery. Date format dd/mm/yyyy</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Order_OrderDueDate","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"orderDTO","in":"body","required":true,"schema":{"$ref":"#/definitions/OrderDTO"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/order/checkOrderStatus":{"post":{"tags":["Orders API"],"summary":"Check Order Status","description":"<b>JSON Response Parameters:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <b>Status</b>\r\n      </td>\r\n      <td>Integer</td>\r\n      <td></td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <b>Content</b>\r\n      </td>\r\n      <td>String</td>\r\n      <td>XML of the report</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <b>DueDate</b>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Due Date of the Order</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Order_CheckOrderStatus","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"OrderID","in":"query","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/monitoring/GetMonitoringOrderPdf":{"get":{"tags":["Monitoring"],"summary":"Receive report in PDF format","description":"<b>JSON Response sample:</b>\r\n            \r\n                {\r\n                    \"MonitoringUpdateID\": 1413189,\r\n                    \"statusCode\": \"200\",\r\n                    \"message\": \"Success\",\r\n                    \"pdfData\": \"base64 encoded PDF file\"\r\n                }","operationId":"Monitoring_GetMonitoringOrderPDF","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"MonitoringUpdateID","in":"query","description":"","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/monitoring/GetMonitoringOrderXml":{"get":{"tags":["Monitoring"],"summary":"Receive report in XML format","description":"<b>JSON Response sample:</b>\r\n            \r\n                {\r\n                    \"MonitoringUpdateID\": 1413189,\r\n                    \"statusCode\": \"200\",\r\n                    \"message\": \"Success\",\r\n                    \"xml\": \"XML File\"\r\n                }","operationId":"Monitoring_GetMonitoringOrderXML","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"MonitoringUpdateID","in":"query","description":"","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/monitoring/GetMonitoringOrderJson":{"get":{"tags":["Monitoring"],"summary":"Receive report in JSON format","description":"<b>JSON Response sample:</b>\r\n            \r\n                {\r\n                    \"MonitoringUpdateID\": 1413189,\r\n                    \"statusCode\": \"200\",\r\n                    \"message\": \"Success\",\r\n                    \"jsonData\": \"JSON File\"\r\n                }","operationId":"Monitoring_GetMonitoringOrderJSON","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"MonitoringUpdateID","in":"query","description":"","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/kyb/search":{"post":{"tags":["CR KYB API"],"summary":"KYB search","description":" JSON Request Parameters:\r\n <table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>CountryID (required)</b></td><td>Integer</td><td>Country identifier</td></tr><tr><td><b>name (*)</b></td><td>String</td><td>Entity name</td></tr><tr><td><b>registerNumber (*)</b></td><td>String</td><td>Company registration number</td></tr><tr><td><b>city</b></td><td>String</td><td>City of company’s primary address</td></tr><tr><td><b>postalCode</b></td><td>String</td><td>Postal code of company’s primary address</td></tr><tr><td><b>clientReference</b></td><td>String</td><td>Client reference number</td></tr><tr><td><b>UID (*)</b></td><td>String</td><td>Unique Identifier of Company</td></tr><tr><td><b>FuzzySearch</b></td><td>bit</td><td>By default, FuzzySearch =1 for all searches. Specify FuzzySearch=0 to disable Fuzzy Search and retrieve exact match.</td></tr></tbody></table><br></br><b>JSON Response Parameters:</b><br></br><table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>UID</b></td><td>String</td><td>Entity Unique identifier</td></tr><tr><td><b>name</b></td><td>String</td><td>Entity name</td></tr><tr><td><b>tradingName</b></td><td>String</td><td>Trade Name matching the Search Input name</td></tr><tr><td><b>registerNumber</b></td><td>String</td><td>Entity registration number</td></tr><tr><td><b>city</b></td><td>String</td><td>City of entity’s primary address</td></tr><tr><td><b>address</b></td><td>String</td><td>Additional information for entity’s primary address</td></tr><tr><td><b>postalCode</b></td><td>String</td><td>Postal code of entity’s primary address</td></tr><tr><td><b>status</b></td><td>String</td><td>Entity’s status</td></tr><tr><td><b>legalForm</b></td><td>String</td><td>Legal Type of the Company</td></tr><tr><td><b>score</b></td><td>String</td><td>Entity’s score</td></tr><tr><td><b>display</b></td><td>Integer</td><td>1 (result displayed) OR 0 (result not displayed)</td></tr><tr><td><b>IssueDate</b></td><td>String</td><td>Register’s Issue Date</td></tr><tr><td><b>ExpiryDate</b></td><td>String</td><td>Register’s Expiry Date</td></tr><tr><td><b>fuzzySearch</b></td><td>bit</td><td>1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn’t belong to Fuzzy Search performed</td></tr></tbody></table><b>JSON Request sample:</b>\r\n\r\n     {\r\n\t        \"countryId\": 69,\r\n\t        \"name\": \"SAMPLE COMPANY NAME\",\r\n\t        \"registerNumber\": \"U63000MH2004PTC148761\",\r\n\t        \"city\": \"Mumbai City\",\r\n\t        \"postalCode\": \"400093\",\r\n\t        \"clientReference\": \"ref1234567\",\r\n\t        \"UID\": \"INC1020024374\"\r\n     }\r\n\r\n <b>JSON Response sample:</b>\r\n \r\n     [\r\n         {\r\n             \"UID\": null,\r\n             \"searchId\": 1325,\r\n             \"nameWeight\": 45,\r\n             \"regNoWeight\": 35,\r\n             \"postalCodeWeight\": 35,\r\n             \"cityWeight\": 11,\r\n             \"minPercent\": 80,\r\n             \"maxRecords\": 10,\r\n             \"countryId\": 69,\r\n             \"name\": \"SAMPLE COMPANY NAME\",\r\n             \"registerNumber\": \"U1234567890\",\r\n             \"city\": \"Mumbai City\",\r\n             \"postalCode\": \"400090\",\r\n             \"clientReference\": \"ref1234567\",\r\n             \"userId\": 486,\r\n             \"searchDate\": \"2022-03-30 17:20:40\",\r\n             \"totalResults\": 1,\r\n             \"successful\": 1,\r\n             \"reduceBalance\": null,\r\n             \"price\": null,\r\n             \"vat\": 0.0,\r\n             \"currency\": \"EUR\",\r\n             \"subscriptionStartDate\": \"2021-06-01\",\r\n             \"subscriptionEndDate\": \"2022-08-30\",\r\n             \"subscriptionMonthStartDate\": null,\r\n             \"subscriptionMonthEndDate\": null,\r\n             \"currencyRate\": null,\r\n             \"searchResult\": [\r\n             \t{\r\n             \t\t\"UID\": \"INC1234567890\",\r\n             \t\t\"name\": \"SAMPLE COMPANY NAME\",\r\n             \t\t\"registerNumber\": \"U1234567890\",\r\n             \t\t\"city\": \"Mumbai City\",\r\n             \t\t\"address\": \"Postal Code : 400090, Street : Sample Apartments, City : Mumbai City\",\r\n             \t\t\"postalCode\": \"400090\",\r\n             \t\t\"status\": \"Active\",\r\n             \t\t\"legalForm\": \"\",\r\n             \t\t\"score\": 99.0,\r\n             \t\t\"display\": 1,\r\n             \t\t\"reduceBalance\": null,\r\n                     \"price\": null,\r\n                     \"vat\": null,\r\n                     \"currency\": null,\r\n                     \"subscriptionStartDate\": null,\r\n                     \"subscriptionEndDate\": null,\r\n                     \"subscriptionMonthStartDate\": null,\r\n                     \"subscriptionMonthEndDate\": null,\r\n                     \"currencyRate\": null,\r\n                     \"crComplyHits\": null,\r\n                     \"updatedDate\": null\r\n                 }\r\n             ],\r\n             \"crComply\": null\r\n\t        }\r\n     ]","operationId":"Kyb_KybSearch","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"json","in":"body","required":true,"schema":{"$ref":"#/definitions/KYBInputModel"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"Fuzzy Search Not Available for this Coutnry"}}}},"/api/kyb/display/{searchId}/{UID}":{"get":{"tags":["CR KYB API"],"summary":"Display Company","description":" After performing KYB Search, the next step is to display an entity from the list of UIDs returned from the search. Please note that, KYB Search Results including only a single entity will automatically be displayed for that KYB SearchId. Displaying a company will return the values for Status,LegalForm, Issue Date and Expiry Date if they are available. Company from the pool of results in KYB Search can be displayed by:\r\n\r\n • Appending searchId to URL. SearchId is the unique identifier in response from POST search.\r\n       \r\n • Appending UID for an entity returned in POST Search. UID is the unique identifier of an entity returned from POST Search searchResults.\r\n       \r\nJSON Response Parameters:\r\n\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>UID</b></td><td>String</td><td>Entity Unique identifier</td></tr><tr><td><b>name</b></td><td>String</td><td>Entity name</td></tr><tr><td><b>tradingName</b></td><td>String</td><td>Trade Name matching the Search Input name</td></tr><tr><td><b>registerNumber</b></td><td>String</td><td>Entity registration number</td></tr><tr><td><b>city</b></td><td>String</td><td>City of entity’s primary address</td></tr><tr><td><b>address</b></td><td>String</td><td>Additional information for entity’s primary address</td></tr><tr><td><b>postalCode</b></td><td>String</td><td>Postal code of entity’s primary address</td></tr><tr><td><b>status</b></td><td>String</td><td>Entity’s status</td></tr><tr><td><b>legalForm</b></td><td>String</td><td>Legal Type of the Company</td></tr><tr><td><b>score</b></td><td>String</td><td>Entity’s score</td></tr><tr><td><b>display</b></td><td>Integer</td><td>1 (result displayed) OR 0 (result not displayed)</td></tr><tr><td><b>IssueDate</b></td><td>String</td><td>Register’s Issue Date</td></tr><tr><td><b>ExpiryDate</b></td><td>String</td><td>Register’s Expiry Date</td></tr><tr><td><b>fuzzySearch</b></td><td>bit</td><td>1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn’t belong to Fuzzy Search performed</td></tr></tbody></table><br></br><b>JSON Response sample:</b>\r\n\r\n    [\r\n        {\r\n\t        \"UID\": null,\r\n\t        \"searchId\": 1073,\r\n\t        \"nameWeight\": 5,\r\n\t        \"regNoWeight\": 4,\r\n\t        \"postalCodeWeight\": 4,\r\n\t        \"cityWeight\": 2,\r\n\t        \"minPercent\": 1,\r\n\t        \"maxRecords\": 10,\r\n\t        \"countryId\": 69,\r\n\t        \"name\": \"SAMPLE COMPANY NAME\",\r\n\t        \"registerNumber\": \"U63000MH2004PTC148761\",\r\n\t        \"city\": \"Mumbai City\",\r\n\t        \"postalCode\": \"400093\",\r\n\t        \"clientReference\": \"ref1234567\",\r\n\t        \"userId\": 486,\r\n\t        \"searchDate\": \"2021-05-05 08:23:19\",\r\n\t        \"totalResults\": 1,\r\n\t        \"successful\": 1,\r\n\t        \"reduceBalance\": 1,\r\n\t        \"price\": null,\r\n\t        \"vat\": null,\r\n\t        \"currency\": \"EUR\",\r\n\t        \"subscriptionStartDate\": \"2021-02-13\",\r\n\t        \"subscriptionEndDate\": \"2021-08-13\",\r\n\t        \"subscriptionMonthStartDate\": \"2021-04-12\",\r\n\t        \"subscriptionMonthEndDate\": \"2021-05-11\",\r\n\t        \"currencyRate\": null,\r\n\t        \"searchResult\": [\r\n\t\t    {\r\n\t\t\t    \"UID\": \"INC1020024322\",\r\n\t\t\t    \"name\": \"SAMPLE COMPANY NAME\",\r\n\t\t\t    \"registerNumber\": \"U63000MH2004PTC148761\",\r\n\t\t\t    \"city\": \"Mumbai City\",\r\n\t\t\t    \"address\": \"Postal Code : 400093, Street : Jayant Apartments, City : Mumbai City\",\r\n\t\t\t    \"postalCode\": \"400093\",\r\n\t\t\t    \"status\": \"Active\",\r\n\t\t\t    \"legalForm\": \"\",\r\n\t\t\t    \"score\": 99.0,\r\n\t\t\t    \"display\": 1,\r\n\t\t\t    \"reduceBalance\": null,\r\n\t\t\t    \"price\": null,\r\n\t\t\t    \"vat\": null,\r\n\t\t\t    \"currency\": null,\r\n\t\t\t    \"subscriptionStartDate\": null,\r\n\t\t\t    \"subscriptionEndDate\": null,\r\n\t\t\t    \"subscriptionMonthStartDate\": null,\r\n\t\t\t    \"subscriptionMonthEndDate\": null,\r\n\t\t\t    \"currencyRate\": null,\r\n\t\t\t    \"crComplyHits\": null,\r\n\t\t\t    \"updatedDate\": null\r\n            }\r\n\t    ],\r\n\t    \"crComply\": null\r\n      }\r\n    ]","operationId":"Kyb_KybDisplay","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"searchId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"UID","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/kyb/retrieveSearch/{searchId}":{"get":{"tags":["CR KYB API"],"summary":"Retrieve existing search results","description":"* SearchId is the unique identifier in response from POST search.\r\n\r\nJSON Response Parameters:\r\n\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>UID</b></td><td>String</td><td>Entity Unique identifier</td></tr><tr><td><b>name</b></td><td>String</td><td>Entity name</td></tr><tr><td><b>tradingName</b></td><td>String</td><td>Trade Name matching the Search Input name</td></tr><tr><td><b>registerNumber</b></td><td>String</td><td>Entity registration number</td></tr><tr><td><b>city</b></td><td>String</td><td>City of entity’s primary address</td></tr><tr><td><b>address</b></td><td>String</td><td>Additional information for entity’s primary address</td></tr><tr><td><b>postalCode</b></td><td>String</td><td>Postal code of entity’s primary address</td></tr><tr><td><b>status</b></td><td>String</td><td>Entity’s status</td></tr><tr><td><b>legalForm</b></td><td>String</td><td>Legal Type of the Company</td></tr><tr><td><b>score</b></td><td>String</td><td>Entity’s score</td></tr><tr><td><b>display</b></td><td>Integer</td><td>1 (result displayed) OR 0 (result not displayed)</td></tr><tr><td><b>IssueDate</b></td><td>String</td><td>Register’s Issue Date</td></tr><tr><td><b>ExpiryDate</b></td><td>String</td><td>Register’s Expiry Date</td></tr><tr><td><b>fuzzySearch</b></td><td>bit</td><td>1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn’t belong to Fuzzy Search performed</td></tr></tbody></table><br></br><b>JSON Response sample:</b>\r\n\r\n    [\r\n        {\r\n\t        \"UID\": null,\r\n\t        \"searchId\": 1325,\r\n\t        \"nameWeight\": 45,\r\n\t        \"regNoWeight\": 35,\r\n\t        \"postalCodeWeight\": 35,\r\n\t        \"cityWeight\": 11,\r\n\t        \"minPercent\": 80,\r\n\t        \"maxRecords\": 10,\r\n\t        \"countryId\": 69,\r\n\t        \"name\": \"SAMPLE COMPANY NAME\",\r\n\t        \"registerNumber\": \"U1234567890\",\r\n\t        \"city\": \"Mumbai City\",\r\n\t        \"postalCode\": \"400090\",\r\n\t        \"clientReference\": \"ref1234567\",\r\n\t        \"userId\": 486,\r\n\t        \"searchDate\": \"2022-03-30 17:20:40\",\r\n\t        \"totalResults\": 1,\r\n\t        \"successful\": 1,\r\n\t        \"reduceBalance\": null,\r\n\t        \"price\": null,\r\n\t        \"vat\": 0.0,\r\n\t        \"currency\": \"EUR\",\r\n\t        \"subscriptionStartDate\": \"2021-06-01\",\r\n\t        \"subscriptionEndDate\": \"2022-08-30\",\r\n\t        \"subscriptionMonthStartDate\": null,\r\n\t        \"subscriptionMonthEndDate\": null,\r\n\t        \"currencyRate\": null,\r\n\t        \"searchResult\": [\r\n\t\t    {\r\n\t\t\t    \"UID\": \"INC1234567890\",\r\n\t\t\t    \"name\": \"SAMPLE COMPANY NAME\",\r\n\t\t\t    \"registerNumber\": \"U1234567890\",\r\n\t\t\t    \"city\": \"Mumbai City\",\r\n\t\t\t    \"address\": \"Postal Code : 400090, Street : Sample Apartments, City : Mumbai City\",\r\n\t\t\t    \"postalCode\": \"400090\",\r\n\t\t\t    \"status\": \"Active\",\r\n\t\t\t    \"legalForm\": \"\",\r\n\t\t\t    \"score\": 99.0,\r\n\t\t\t    \"display\": 1,\r\n\t\t\t    \"reduceBalance\": null,\r\n\t\t\t    \"price\": null,\r\n\t\t\t    \"vat\": null,\r\n\t\t\t    \"currency\": null,\r\n\t\t\t    \"subscriptionStartDate\": null,\r\n\t\t\t    \"subscriptionEndDate\": null,\r\n\t\t\t    \"subscriptionMonthStartDate\": null,\r\n\t\t\t    \"subscriptionMonthEndDate\": null,\r\n\t\t\t    \"currencyRate\": null,\r\n\t\t\t    \"crComplyHits\": null,\r\n\t\t\t    \"updatedDate\": null\r\n            }\r\n\t    ],\r\n\t    \"crComply\": null\r\n      }\r\n    ]","operationId":"Kyb_KybRetrieveSearch","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"searchId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/kyb/searchAll":{"post":{"tags":["CR KYB API"],"summary":"Retrieves all Searches","description":"JSON Request sample:\r\n\r\n    {\r\n        \"searchId\": 111,\r\n        \"countryId\": 69,\r\n        \"name\": \"SAMPLE COMPANY NAME\",\r\n        \"registerNumber\": \"\",\r\n        \"clientReference\": \"ref1234567\",\r\n        \"userId\": 16337,\r\n        \"startDate\": \"2021-04-25\",\r\n        \"endDate\": \"2021-04-30\"\r\n    }        \r\n    \r\n<br></br><b>JSON Response sample:</b>\r\n\r\n    [\r\n        {\r\n            \"searchId\": 111,\r\n            \"country\": \"India\",\r\n            \"name\": \"SAMPLE COMPANY NAME\",\r\n            \"registerNumber\": \"U63000MH2004PTC148761\",\r\n            \"clientReference\": \"ref1234567\",\r\n            \"userId\": 16337,\r\n            \"searchDate\": \"4/30/2021 3:45:32 PM\",\r\n            \"totalResults\": 1,\r\n            \"displayedUIDs\": \"INC1020024374\"\r\n        }\r\n    ]","operationId":"Kyb_KybSearchAll","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"json","in":"body","required":true,"schema":{"type":"object"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/kyb/countryValidation/{countryId}":{"get":{"tags":["CR KYB API"],"summary":"Returns required fields for KYB search.","description":"<b>JSON Response sample:</b>\r\n            \r\n                {\r\n                    \"NameIsRequired\": 0\r\n                }","operationId":"Kyb_KybCountryValidation","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"countryId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/kyb/clientBalance":{"get":{"tags":["CR KYB API"],"summary":"Retrieves client balances and subscription dates.","description":"<b>JSON Response sample:</b>\r\n            \r\n                {\r\n                    \"subscriptionStartDate\": \"2021-04-26\",\r\n                    \"subscriptionEndDate\": \"2021-10-25\",\r\n                    \"kybTotalBalance\": 3540,\r\n                    \"currentMonthStartDate\": \"2021-04-25\",\r\n                    \"currentMonthEndDate\": \"2021-05-25\",\r\n                    \"currentMonthBalance\": 540,\r\n                    \"crComplyBalance\": 0\r\n                }","operationId":"Kyb_KybClientBalance","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/kyb/getSettings":{"get":{"tags":["CR KYB API"],"summary":"Retrieves KYB Search settings","description":" JSON Response Parameters :\r\n \r\n <table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>nameWeight</b></td><td>Integer</td><td>Weight for name as per client’s settings</td></tr><tr><td><b>regNoWeight</b></td><td>Integer</td><td>Weight for name as per client’s settings</td></tr><tr><td><b>minPercent</b></td><td>Integer</td><td>Minimum threshold for matching and fetching results</td></tr><tr><td><b>maxRecords</b></td><td>Integer</td><td>Maximum number of records per response</td></tr><tr><td><b>postalCodeWeight</b></td><td>Integer</td><td>Weight for name as per client’s settings</td></tr><tr><td><b>cityWeight</b></td><td>Integer</td><td>Weight for city as per client’s settings</td></tr><tr><td><b>crComplyFuzziness</b></td><td>Integer</td><td>Defines the fuzziness for CR Comply searches.</td></tr><tr><td><b>crComplyMonitor</b></td><td>Boolean</td><td>Defines if search will be monitored.</td></tr><tr><td><b>crComplySources</b></td><td>Array</td><td>Defines CR Comply filters.</td></tr></tbody></table><br></br><b>JSON Response sample:</b>\r\n \r\n     {\r\n\t        \"nameWeight\": 50,\r\n\t        \"regNoWeight\": 40,\r\n\t        \"minPercent\": 80,\r\n\t        \"maxRecords\": 10,\r\n\t        \"postalCodeWeight\": 20,\r\n\t        \"cityWeight\": 10,\r\n\t        \"crComplyFuzziness\": 0,\r\n\t        \"crComplyMonitor\": 1,\r\n\t        \"crComplySources\": [\r\n\t\t        {\r\n\t\t\t        \"xmlValue\": \"sanction\"\r\n             },\r\n\t\t        {\r\n\t\t\t        \"xmlValue\": \"warning\"\r\n\t\t        }\r\n\t        ]\r\n     }","operationId":"Kyb_GetKybSettings","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/kyb/updateSettings":{"post":{"tags":["CR KYB API"],"summary":"Updates KYB Search settings","description":"JSON Request/Response Parameters:\r\n\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>nameWeight</b></td><td>Integer</td><td>Weight for name as per client’s settings</td></tr><tr><td><b>regNoWeight</b></td><td>Integer</td><td>Weight for name as per client’s settings</td></tr><tr><td><b>minPercent</b></td><td>Integer</td><td>Minimum threshold for matching and fetching results</td></tr><tr><td><b>maxRecords</b></td><td>Integer</td><td>Maximum number of records per response</td></tr><tr><td><b>postalCodeWeight</b></td><td>Integer</td><td>Weight for name as per client’s settings</td></tr><tr><td><b>cityWeight</b></td><td>Integer</td><td>Weight for city as per client’s settings</td></tr><tr><td><b>crComplyFuzziness</b></td><td>Integer</td><td>Defines the fuzziness for CR Comply searches.</td></tr><tr><td><b>crComplyMonitor</b></td><td>Boolean</td><td>Defines if search will be monitored.</td></tr><tr><td><b>crComplySources</b></td><td>Array</td><td>Defines CR Comply filters.</td></tr></tbody></table><br></br><b>JSON Request sample:</b>\r\n\r\n    {\r\n        \"nameWeight\": 50,\r\n        \"regNoWeight\": 40,\r\n        \"minPercent\": 80,\r\n        \"maxRecords\": 10,\r\n        \"postalCodeWeight\": 30,\r\n        \"cityWeight\": 10,\r\n        \"crComplyFuzziness\": 0,\r\n        \"crComplyMonitor\": 1,\r\n        \"crComplySources\": [\r\n        \t{\r\n        \t\t\"xmlValue\": \"sanction\"\r\n            },\r\n        \t{\r\n        \t\t\"xmlValue\": \"warning\"\r\n        \t}\r\n        ]\r\n    }        \r\n    \r\n<br></br><b>JSON Response sample:</b>\r\n\r\n    {\r\n        \"nameWeight\": 50,\r\n        \"regNoWeight\": 40,\r\n        \"minPercent\": 80,\r\n        \"maxRecords\": 10,\r\n        \"postalCodeWeight\": 30,\r\n        \"cityWeight\": 10,\r\n        \"crComplyFuzziness\": 0,\r\n        \"crComplyMonitor\": 1,\r\n        \"crComplySources\": [\r\n\t        {\r\n\t\t        \"xmlValue\": \"sanction\"\r\n            },\r\n\t        {\r\n\t\t        \"xmlValue\": \"warning\"\r\n\t        }\r\n        ]\r\n    }","operationId":"Kyb_UpdateKybSettings","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"json","in":"body","required":true,"schema":{"type":"object"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"Parameter Value Invalid"}}}},"/api/kyb/crComply":{"post":{"tags":["CR KYB API"],"summary":"KYB CR Comply search","description":"JSON Response Parameters:\r\n\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>searchId</b></td><td>Integer</td><td>KYB Search identifier</td></tr><tr><td><b>name</b></td><td>String</td><td>Entity name</td></tr><tr><td><b>UID</b></td><td>String</td><td>Entity Unique identifier</td></tr><tr><td><b>registerNumber</b></td><td>String</td><td>Entity registration number</td></tr></tbody></table><br></br><b>JSON Request sample:</b>\r\n\r\n    {\r\n        \"searchId\": 111,\r\n        \"name\": \"SAMPLE COMPANY NAME\",\r\n        \"uid\": \"INC1020024374\"\r\n    }","operationId":"Kyb_KybComplyAll","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"json","in":"body","required":true,"schema":{"type":"object"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/kyb/crComplyResult/{crComplyOrderId}":{"get":{"tags":["CR KYB API"],"summary":"Retrieves KYB CR Comply search results","description":"<b>JSON Response sample:</b>\r\n<root>\r\n  <Searches>\r\n    <Search>\r\n      <SearchTerm>SAMPLE COMPANY PRIVATE LIMITED</SearchTerm>\r\n      <CreatedAt>30 Apr 2021 01:17 PM</CreatedAt>\r\n      <FuzzinessInterval>0%</FuzzinessInterval>\r\n      <EntityType>Company</EntityType>\r\n      <FilterTypes>\r\n        <FilterType>Sanctions</FilterType>\r\n        <FilterType>Warnings</FilterType>\r\n      </FilterTypes>\r\n      <TotalHits>0</TotalHits>\r\n    </Search>\r\n  </Searches>\r\n</root>","operationId":"Kyb_KybCRComplyReult","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"crComplyOrderId","in":"path","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/Person/PersonSearch":{"post":{"tags":["CR IDentify API"],"summary":"Person Directorship/ Shareholding Search","description":"JSON Request Parameters:\r\n\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><strong>FirstName</strong></td><td>String</td><td>First name</td></tr><tr><td><strong>MiddleName</strong></td><td>String</td><td>Middle name</td></tr><tr><td><strong>LastName</strong></td><td>String</td><td>Last name</td></tr><tr><td><strong>UID</strong></td><td>String</td><td>Person’s Unique Identifer</td></tr><tr><td><strong>YearOfbirth</strong></td><td>Integer</td><td>Year of birth</td></tr><tr><td><strong>MonthOfBirth</strong></td><td>Integer</td><td>Month of birth</td></tr><tr><td><strong>DayOfBirth</strong></td><td>Integer</td><td>Day of birth</td></tr><tr><td><strong>IsFormer</strong></td><td>Boolean</td><td></td></tr><tr><td><strong>isExact</strong></td><td>Boolean</td><td>Exact match</td></tr><tr><td><strong>LanguageId</strong></td><td>Integer</td><td></td></tr><tr><td><strong>IdentityNumber</strong></td><td>String</td><td>Person’s ID number</td></tr><tr><td><strong>NationalityCountryId</strong></td><td>Integer</td><td>CountryId of Person’s nationality</td></tr></tbody></table><br></br><b>JSON Response Parameters:</b><br></br><table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><strong>FirstName</strong></td><td>String</td><td>First name</td></tr><tr><td><strong>MiddleName</strong></td><td>String</td><td>Middle name</td></tr><tr><td><strong>LastName</strong></td><td>String</td><td>Last name</td></tr><tr><td><strong>UID</strong></td><td>String</td><td>Person’s Unique Identifer</td></tr><tr><td><strong>YearOfbirth</strong></td><td>Integer</td><td>Year of birth</td></tr><tr><td><strong>MonthOfBirth</strong></td><td>Integer</td><td>Month of birth</td></tr><tr><td><strong>DayOfBirth</strong></td><td>Integer</td><td>Day of birth</td></tr><tr><td><strong>IsFormer</strong></td><td>Boolean</td><td></td></tr><tr><td><strong>isExact</strong></td><td>Boolean</td><td>Exact match</td></tr><tr><td><strong>LanguageId</strong></td><td>Integer</td><td></td></tr><tr><td><strong>IdentityNumber</strong></td><td>String</td><td>Person’s ID number</td></tr><tr><td><strong>NationalityCountryId</strong></td><td>Integer</td><td>CountryId of Person’s nationality</td></tr></tbody></table><br></br><b>JSON Request sample:</b>\r\n\r\n       {\r\n            \"FirstName\": \"Nadine\",\r\n            \"LastName\": \"I\",\r\n            \"isExact\": 0,\r\n            \"LanguageId\": 1\r\n       }\r\n    \r\n<br></br><b>JSON Response sample:</b>\r\n\r\n    [\r\n\t\t{\r\n            \"FirstName\": \"Jane\",\r\n            \"MiddleName\": \"Available\",\r\n            \"LastName\": \"Doe\",\r\n            \"UID\": \"ZZP01234567\",\r\n            \"YearOfbirth\": \"Not Available \",\r\n            \"MonthOfBirth\": \"Not Available \",\r\n            \"DayOfBirth\": \"Not Available \",\r\n            \"isFormer\": \"Available\",\r\n            \"IdentityNumber\": \"Not Available \"\r\n        },\r\n        {\r\n            \"FirstName\": \"Jane\",\r\n            \"MiddleName\": \"Available\",\r\n            \"LastName\": \"Doe\",\r\n            \"UID\": \"LBP701234292\",\r\n            \"YearOfbirth\": \"Not Available \",\r\n            \"MonthOfBirth\": \"Not Available \",\r\n            \"DayOfBirth\": \"Not Available \",\r\n            \"isFormer\": \"Available\",\r\n            \"IdentityNumber\": \"Not Available \"\r\n        }\r\n    ]","operationId":"Person_PersonSearch","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"requestDTO","in":"body","required":true,"schema":{"$ref":"#/definitions/PSRequestDTO"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"Serialization Error"}}}},"/api/Person/FlexibleEIDV":{"post":{"tags":["CR IDentify API"],"summary":"Flexible EIDV","description":"•\tAuthentication required\r\n\r\n•\tAll Request Fields are optional except Country.\r\n\r\n•\tThe field/s included in the client’s request and is/are specified as “Primary” = true, this or these fields will be used to search for the person through Cedar Rose database.\r\n\r\n•\tIf the person is found, the field/s included in the client’s request and are or is specified as \"Primary\"=false, this or these fields will be compared to correspondent fields of the found person in the Cedar Rose database and an evaluation will be included in the response.\r\n\r\n•\t\"Like\" = true can be added to the request body to check if part of the object exists, if not added it will be false by default. “Like” does not apply to NationalId or BirthDate.\r\n       \r\nHeader\r\n\r\n•\tContent-Type: application/json\r\n\r\n•\tAuthorization: Bearer {TOKEN_FROM_LOGIN}\r\n    \r\n<b>JSON Request Parameters:</b><table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>FirstName</b></td><td>String</td><td></td></tr><tr><td><b>LastName</b></td><td>String</td><td></td></tr><tr><td><b>MiddleName</b></td><td>String</td><td></td></tr><tr><td><b>MiddleName2</b></td><td>String</td><td></td></tr><tr><td><b>MiddleName3</b></td><td>String</td><td></td></tr><tr><td><b>MiddleName4</b></td><td>String</td><td></td></tr><tr><td><b>NationalId</b></td><td>String</td><td></td></tr><tr><td><b>BirthDate</b></td><td>String</td><td>Format: Year-Month-Day</td></tr><tr><td><b>CountryId (required)</b></td><td>Integer</td><td></td></tr></tbody></table><br></br><b>JSON Response Parameters:</b>\r\n\r\nThe web service will return 1 record having the best score, containing a list of all fields (in addition to the record score), and each field has the below format:\r\n\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>Name</b></td><td>String</td><td></td></tr><tr><td><b>Evaluation</b></td><td>String</td><td></td></tr></tbody></table><br></br>\r\n\r\nThe Evaluation Options are Matching, Not Matching, Not Available, Not Received. \r\n\r\nThe following 2 options work for primary and non-primary fields: Matching, Not Received.\r\n\r\nNot Matching: is only used for non-primary fields\r\n\r\nIn case the record was found according to primary fields, but a certain non-primary field was empty in our database, the field will return “Not Available” in the response.\r\n\r\n<b>JSON Request sample:</b>\r\n\r\nPoint Source:\r\n\r\n       {\r\n            \"CountryID\": \"93\",\r\n            \"Request\": [\r\n\t            {\r\n\t\t            \"Name\": \"FirstName\",\r\n\t\t            \"Value\": \"Nad\",\r\n\t\t            \"Primary\": true,\r\n\t\t            \"Like\": true\r\n                },\r\n\t            {\r\n\t\t            \"Name\": \"LastName\",\r\n\t\t            \"Value\": \"Ibrahim\",\r\n\t\t            \"Primary\": true\r\n\t            }\r\n            ]\r\n      }\r\n    \r\nCascade 1x1:\r\n\r\n    {\r\n        \"CountryID\": \"9\",\r\n        \"Request\": [\r\n        \t{\r\n        \t\t\"Name\": \"FirstName\",\r\n        \t\t\"Value\": \"Mashaal\",\r\n        \t\t\"Primary\": true\r\n             },\r\n        \t{\r\n        \t\t\"Name\": \"Birthdate\",\r\n        \t\t\"Value\": \"1981-12-17\",\r\n        \t\t\"Primary\": true\r\n        \t}\r\n        ]\r\n    }    \r\n    \r\n<b>JSON Response sample</b>\r\n\r\nPoint Source:\r\n\r\n    [\r\n        {\r\n            \"Name\": \"FirstName\",\r\n            \"Evaluation\": \"Not Matching\"\r\n        },\r\n        {\r\n            \"Name\": \"LastName\",\r\n            \"Evaluation\": \"Matching\"\r\n        },\r\n        {\r\n        \"Name\": \"Score\",\r\n            \"Evaluation\": \"15.00\"\r\n        }\r\n   ]\r\n    \r\nCascade 1x1:\r\n\r\n       [\r\n            {\r\n            \t\"Name\": \"FirstName\",\r\n            \t\"Evaluation\": \"Matching\"\r\n             },\r\n            {\r\n            \t\"Name\": \"Birthdate\",\r\n            \t\"Evaluation\": \"Matching\"\r\n            },\r\n            {\r\n               \"Name\": \"Score\",\r\n            \t\"Evaluation\": \"35.00\"\r\n             }\r\n       ]","operationId":"Person_FlexibleEIDV","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"requestDTO","in":"body","required":true,"schema":{"$ref":"#/definitions/EIDVRequestDTO"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/EIDV/EIDVIdentifySearch":{"post":{"tags":["CR IDentify API"],"summary":"Create Identity Verification search","description":"Search is performed only when recommended fields are provided.\r\n\r\n“Source” is not applicable for Cascade Mode(cascade=1)\r\n\r\n-   Mode Selection\r\n\r\n  •\tCascade=1: Cascade Mode\r\n  \r\n  •\tCascade=0: Point Source Mode\r\n  \r\n-   Cascade Types: There are two available Cascade Types:\r\n\r\n  •\tCascadetype=1: 1x1 Identity Verification\r\n  \r\n  •\tCascadetype=2: 2x2 Identity Verification\r\n  \r\nJSON Request sample:\r\n\r\nPoint Source:\r\n\r\n    {\r\n        \"config\": {\r\n\t        \"cascade\": 0,\r\n\t        \"cascadetype\": 1,\r\n\t        \"source\": \"Hutchison\"\r\n        },\r\n        \"propertyfields\": {\r\n\t        \"firstName\": \"TOM\",\r\n\t        \"lastName\": \"CLARKE\",\r\n\t        \"middleName1\": \"CLARKE\",\r\n\t        \"fullName\": \"TOM CLARKE\",\r\n\t        \"dob\": \"1800-01-01\",\r\n\t        \"email\": \"\",\r\n\t        \"gender\": \"\",\r\n\t        \"state\": \"\",\r\n\t        \"requestId\": \"\",\r\n\t        \"building\": \"19\",\r\n\t        \"OfficeUnit\": \"19\",\r\n\t        \"street\": \"CASUARINA\",\r\n\t        \"fullAddress\": \"19 CASUARINA\",\r\n\t        \"city\": \"KILMORE\",\r\n\t        \"district\": \"KILMORE\",\r\n\t        \"postalCode\": \"3764\",\r\n\t        \"countryCode\": \"AT\",\r\n\t        \"nationalId\": \"\",\r\n\t        \"phone\": \"15555551212 \"\r\n        }\r\n    }\r\n    \r\nCascade 1x1:\r\n\r\n    {\r\n        \"config\": {\r\n        \t\"cascade\": 1,\r\n        \t\"cascadetype\": 1,\r\n        \t\"source\": \"\"\r\n        },\r\n        \r\n        \"propertyfields\": {\r\n        \t\"firstName\": \"TOM\",\r\n        \t\"lastName\": \"CLARKE\",\r\n        \t\"middleName1\": \"CLARKE\",\r\n        \t\"fullName\": \"TOM CLARKE\",\r\n        \t\"dob\": \"1800-01-01\",\r\n        \t\"email\": \"\",\r\n        \t\"gender\": \"\",\r\n        \t\"state\": \"\",\r\n        \t\"requestId\": \"\",\r\n        \t\"building\": \"19\",\r\n        \t\"OfficeUnit\": \"19\",\r\n        \t\"street\": \"CASUARINA\",\r\n        \t\"fullAddress\": \"19 CASUARINA\",\r\n        \t\"city\": \"KILMORE\",\r\n        \t\"district\": \"KILMORE\",\r\n        \t\"postalCode\": \"3764\",\r\n        \t\"countryCode\": \"AU\",\r\n        \t\"nationalId\": \"\",\r\n        \t\"phone\": \"\"\r\n        }\r\n    }    \r\n   \r\nCascade 2x2:\r\n\r\n    {\r\n        \"config\": {\r\n        \t\"cascade\": 1,\r\n        \t\"cascadetype\": 2,\r\n        \t\"source\": \"\"\r\n        },\r\n        \"propertyfields\": {\r\n        \t\"firstName\": \"TOM\",\r\n        \t\"lastName\": \"CLARKE\",\r\n        \t\"middleName1\": \"CLARKE\",\r\n        \t\"fullName\": \"TOM CLARKE\",\r\n        \t\"dob\": \"1800-01-01\",\r\n        \t\"email\": \"\",\r\n        \t\"gender\": \"\",\r\n        \t\"state\": \"\",\r\n        \t\"requestId\": \"\",\r\n        \t\"building\": \"19\",\r\n        \t\"OfficeUnit\": \"19\",\r\n        \t\"street\": \"CASUARINA\",\r\n        \t\"fullAddress\": \"19 CASUARINA\",\r\n        \t\"city\": \"KILMORE\",\r\n        \t\"district\": \"KILMORE\",\r\n        \t\"postalCode\": \"3764\",\r\n        \t\"countryCode\": \"AU\",\r\n        \t\"nationalId\": \"\",\r\n        \t\"phone\": \"\"\r\n        }\r\n    }    \r\n    \r\n<b>JSON Response sample:</b>\r\n\r\nPoint Source:\r\n\r\n    {\r\n       \"results\": {\r\n           \"HUTCHISON\": {\r\n               \"firstname\": \"Match\",\r\n               \"lastname\": \"Partial_Match\",\r\n               \"middlename1\": \"No_Data\",\r\n               \"fullname\": \"No_Data\",\r\n               \"dob\": \"Partial_Match\",\r\n               \"email\": \"No_Data\",\r\n               \"gender\": \"No_Data\",\r\n               \"state\": \"No_Data\",\r\n               \"building\": \"No_Data\",\r\n               \"officeunit\": \"No_Data\",\r\n               \"street\": \"No_Data\",\r\n               \"fulladdress\": \"Partial_Match\",\r\n               \"city\": \"No_Data\",\r\n               \"district\": \"No_Data\",\r\n               \"postalcode\": \"No_Data\",\r\n               \"countrycode\": \"No_Data\",\r\n               \"nationalid\": \"No_Data\",\r\n               \"phone\": \"No_Data\"\r\n           }\r\n       },\r\n       \"message\": \"200 OK\"\r\n    }    \r\n  \r\n Cascade 1x1:\r\n\r\n    {\r\n        \"results\": [\r\n            {\r\n                \"Government\": [\r\n                    {\r\n                       \"firstname\": \"Match\",\r\n                       \"lastname\": \"Match\",\r\n                       \"middlename1\": \"No_Data\",\r\n                       \"fullname\": \"Match\",\r\n                       \"dob\": \"No_Match\",\r\n                       \"building\": \"Match\",\r\n                       \"officeunit\": \"No_Data\",\r\n                       \"street\": \"Match\",\r\n                       \"fulladdress\": \"Match\",\r\n                       \"city\": \"Match\",\r\n                       \"district\": \"No_Match\",\r\n                       \"postalcode\": \"Match\",\r\n                       \"nationalid\": \"No_Data_Provided\",\r\n                       \"phone\": \"No_Data_Provided\",\r\n                       \"email\": \"Not Avaliable\",\r\n                       \"gender\": \"Not Avaliable\",\r\n                       \"state\": \"Not Avaliable\"\r\n                    }\r\n                ]\r\n            },\r\n            {\r\n                \"Telco\": [\r\n                    {\r\n                       \"firstname\": \"Match\",\r\n                       \"lastname\": \"Match\",\r\n                       \"middlename1\": \"No_Data\",\r\n                       \"fullname\": \"Match\",\r\n                       \"dob\": \"No_Match\",\r\n                       \"building\": \"Match\",\r\n                       \"officeunit\": \"No_Data\",\r\n                       \"street\": \"Match\",\r\n                       \"fulladdress\": \"Match\",\r\n                       \"city\": \"Match\",\r\n                       \"district\": \"No_Match\",\r\n                       \"postalcode\": \"Match\",\r\n                       \"nationalid\": \"No_Data_Provided\",\r\n                       \"phone\": \"No_Data_Provided\",\r\n                       \"email\": \"Not Avaliable\",\r\n                       \"gender\": \"Not Avaliable\",\r\n                       \"state\": \"Not Avaliable\"\r\n                    }\r\n                ]\r\n            },\r\n            {\r\n                \"Telco\": [\r\n                    {\r\n                       \"firstname\": \"Match\",\r\n                       \"lastname\": \"Match\",\r\n                       \"middlename1\": \"No_Data\",\r\n                       \"fullname\": \"Match\",\r\n                       \"dob\": \"No_Match\",\r\n                       \"building\": \"Match\",\r\n                       \"officeunit\": \"No_Data\",\r\n                       \"street\": \"Match\",\r\n                       \"fulladdress\": \"Match\",\r\n                       \"city\": \"Match\",\r\n                       \"district\": \"No_Match\",\r\n                       \"postalcode\": \"Match\",\r\n                       \"nationalid\": \"No_Data_Provided\",\r\n                       \"phone\": \"No_Data_Provided\",\r\n                       \"email\": \"Not Avaliable\",\r\n                       \"gender\": \"Not Avaliable\",\r\n                       \"state\": \"Not Avaliable\"\r\n                    }\r\n                ]\r\n            }\r\n        ],\r\n        \"message\": \"200 OK\"\r\n    }\r\n    \r\n  Cascade 2x2:\r\n\r\n     {\r\n         \"results\": [\r\n\t        {\r\n\t\t        \"Government\": [\r\n\t\t\t        {\r\n\t\t\t\t        \"firstname\": \"Match\",\r\n\t\t\t\t        \"lastname\": \"Match\",\r\n\t\t\t\t        \"middlename1\": \"No_Data\",\r\n\t\t\t\t        \"fullname\": \"Match\",\r\n\t\t\t\t        \"dob\": \"No_Data\",\r\n\t\t\t\t        \"email\": \"No_Data_Provided\",\r\n\t\t\t\t        \"gender\": \"No_Data_Provided\",\r\n\t\t\t\t        \"state\": \"No_Data_Provided\",\r\n\t\t\t\t        \"building\": \"Match\",\r\n\t\t\t\t        \"officeunit\": \"No_Data\",\r\n\t\t\t\t        \"street\": \"Match\",\r\n\t\t\t\t        \"fulladdress\": \"Match\",\r\n\t\t\t\t        \"city\": \"Match\",\r\n\t\t\t\t        \"district\": \"No_Data\",\r\n\t\t\t\t        \"postalcode\": \"Match\",\r\n\t\t\t\t        \"nationalid\": \"No_Data_Provided\",\r\n\t\t\t\t        \"phone\": \"No_Data_Provided\"\r\n                    }\r\n\t\t        ]\r\n\t        },\r\n\t        {\r\n                \"Telco\": [\r\n                    {\r\n                        \"firstname\": \"Match\",\r\n\t\t\t\t        \"lastname\": \"Match\",\r\n\t\t\t\t        \"middlename1\": \"No_Data\",\r\n\t\t\t\t        \"fullname\": \"Match\",\r\n\t\t\t\t        \"dob\": \"No_Data\",\r\n\t\t\t\t        \"email\": \"No_Data_Provided\",\r\n\t\t\t\t        \"gender\": \"No_Data_Provided\",\r\n\t\t\t\t        \"state\": \"No_Data_Provided\",\r\n\t\t\t\t        \"building\": \"Match\",\r\n\t\t\t\t        \"officeunit\": \"No_Data\",\r\n\t\t\t\t        \"street\": \"Match\",\r\n\t\t\t\t        \"fulladdress\": \"Match\",\r\n\t\t\t\t        \"city\": \"Match\",\r\n\t\t\t\t        \"district\": \"No_Data\",\r\n\t\t\t\t        \"postalcode\": \"Match\",\r\n\t\t\t\t        \"nationalid\": \"No_Data_Provided\",\r\n\t\t\t\t        \"phone\": \"No_Data_Provided\"\r\n                    }\r\n\t\t        ]\r\n\t        },\r\n\t        {\r\n                \"Telco\": [\r\n                    {\r\n                        \"firstname\": \"Match\",\r\n\t\t\t\t        \"lastname\": \"Match\",\r\n\t\t\t\t        \"middlename1\": \"No_Data\",\r\n\t\t\t\t        \"fullname\": \"Match\",\r\n\t\t\t\t        \"dob\": \"No_Data\",\r\n\t\t\t\t        \"email\": \"No_Data_Provided\",\r\n\t\t\t\t        \"gender\": \"No_Data_Provided\",\r\n\t\t\t\t        \"state\": \"No_Data_Provided\",\r\n\t\t\t\t        \"building\": \"Match\",\r\n\t\t\t\t        \"officeunit\": \"No_Data\",\r\n\t\t\t\t        \"street\": \"Match\",\r\n\t\t\t\t        \"fulladdress\": \"Match\",\r\n\t\t\t\t        \"city\": \"Match\",\r\n\t\t\t\t        \"district\": \"No_Data\",\r\n\t\t\t\t        \"postalcode\": \"Match\",\r\n\t\t\t\t        \"nationalid\": \"No_Data_Provided\",\r\n\t\t\t\t        \"phone\": \"No_Data_Provided\"\r\n                    }\r\n\t\t        ]\r\n\t        }\r\n        ],\r\n        \"message\": \"200 OK\"\r\n    }","operationId":"EIDV_EIDVIdentifySearch","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/EIDVDTO"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/EIDV/fieldvalidation":{"post":{"tags":["CR IDentify API"],"summary":"Retrieve Recommended, Required and Optional Fields","description":"Used to retrieve Recommended, Required and Optional Fields based on “Mode Selection” and “CountryCode” and “Source”.\r\n\r\n-   Mode Selection\r\n\r\n  •\tCascade=1: Cascade Mode\r\n  \r\n  •\tCascade=0: Point Source Mode\r\n  \r\nJSON Request Parameters:\r\n\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><b>cascade (required)</b></td><td>Integer</td><td>Mode selection</td></tr><tr><td><b>countryCode</b></td><td>String</td><td>Country Code</td></tr><tr><td><b>source</b></td><td>String</td><td>Data source</td></tr></tbody></table><br></br>\r\n\r\nJSON Request sample:\r\n\r\nPoint Source:\r\n\r\n    {\r\n    \t\"cascade\": 0,\r\n    \t\"countryCode\": \"IN\",\r\n    \t\"source\": \"IN1\"\r\n    }\r\n    \r\nCascade 1x1:\r\n\r\n    {\r\n\t    \"cascade\": 1,\r\n\t    \"countryCode\": \"IN\",\r\n\t    \"source\": \"\"\r\n    } \r\n    \r\n<br></br><b>JSON Response sample:</b>\r\n\r\nPoint Source:\r\n\r\n    {\r\n        \"results\": {\r\n        \t\"country\": \"India\",\r\n        \t\"countrycodename\": \"IN\",\r\n        \t\"source\": \"IN1\",\r\n        \t\"firstname\": \"Required_Field\",\r\n        \t\"lastname\": \"Required_Field\",\r\n        \t\"middlename1\": \"Recommended_Field\",\r\n        \t\"fullname\": \"Not_Recommended\",\r\n        \t\"dob\": \"Not_Recommended\",\r\n        \t\"building\": \"Not_Recommended\",\r\n        \t\"officeunit\": \"Not_Recommended\",\r\n        \t\"street\": \"Not_Recommended\",\r\n        \t\"fulladdress\": \"Recommended_Field\",\r\n        \t\"city\": \"Recommended_Field\",\r\n        \t\"district\": \"Not_Recommended\",\r\n        \t\"postalcode\": \"Recommended_Field\",\r\n        \t\"countrycode\": \"Required_Field\",\r\n        \t\"nationalid\": \"Not_Recommended\",\r\n        \t\"phone\": \"Not_Recommended\",\r\n        \t\"state\": \"Required_Field\",\r\n        \t\"email\": \"Not_Recommended\",\r\n        \t\"requestId\": \"Required_Field\",\r\n        \t\"gender\": \"Recommended_Field\",\r\n        \t\"idType\": \"0\"\r\n        },\r\n        \"message\": \"200 OK\"\r\n    }        \r\n \r\nCascade 1x1:\r\n\r\n    {\r\n        \"results\": {\r\n    \t    \"country\": \"India\",\r\n    \t    \"countrycodename\": \"IN\",\r\n    \t    \"firstname\": \"Required_Field\",\r\n    \t    \"lastname\": \"Required_Field\",\r\n    \t    \"middlename1\": \"Required_Field\",\r\n    \t    \"fullname\": \"Required_Field\",\r\n    \t    \"dob\": \"Required_Field\",\r\n    \t    \"building\": \"Optional_Field\",\r\n    \t    \"officeunit\": \"Optional_Field\",\r\n    \t    \"street\": \"Optional_Field\",\r\n    \t    \"fulladdress\": \"Optional_Field\",\r\n    \t    \"city\": \"Optional_Field\",\r\n    \t    \"district\": \"Optional_Field\",\r\n    \t    \"postalcode\": \"Optional_Field\",\r\n    \t    \"countrycode\": \"Required_Field\",\r\n    \t    \"nationalid\": \"Required_Field\",\r\n    \t    \"phone\": \"Optional_Field\",\r\n    \t    \"state\": \"Optional_Field\",\r\n    \t    \"email\": \"Optional_Field\",\r\n    \t    \"gender\": \"Optional_Field\"\r\n        },\r\n    \"message\": \"200 OK\"\r\n    }","operationId":"EIDV_Fieldvalidation","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/Fieldvalidation"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/compliance/searches":{"get":{"tags":["CR Comply API"],"summary":"Get a list of your previous searches","description":"<b>URL PARAMETERS:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>assignee_id</td>\r\n      <td>Show searches assigned to a specific user</td>\r\n    </tr>\r\n    <tr>\r\n      <td>searcher_id</td>\r\n      <td>Show searches performed by a specific user</td>\r\n    </tr>\r\n    <tr>\r\n      <td>risk_level</td>\r\n      <td>Show searches where the risk level is one of the specified options: ('low', 'medium', 'high', 'unknown'). Use commas to separate multiple options, eg and risk_level=medium,high</td>\r\n    </tr>\r\n    <tr>\r\n      <td>submitted_term</td>\r\n      <td>Show searches where the term is unsanitised and includes symbols and punctuation marks</td>\r\n    </tr>\r\n    <tr>\r\n      <td>match_status</td>\r\n      <td>Show searches where the match_status is one of the specified options: ('no_match', 'false_positive', 'potential_match', 'true_positive', 'unknown', 'true_positive_approve', 'true_positive_reject'). Use commas to separate multiple options, eg and match_status=potential_match,true_positive</td>\r\n    </tr>\r\n    <tr>\r\n      <td>search_term</td>\r\n      <td>Searches that match search term (3 characters min)</td>\r\n    </tr>\r\n    <tr>\r\n      <td>created_at_from</td>\r\n      <td>Searches made from date (yyyy-mm-dd)</td>\r\n    </tr>\r\n    <tr>\r\n      <td>created_at_to</td>\r\n      <td>Searches made to date (yyyy-mm-dd)</td>\r\n    </tr>\r\n    <tr>\r\n      <td>tags</td>\r\n      <td>Searches registered against given tags, comma separated represented as 'name:value', eg 'internal_ref:1234' or internal_ref:1234,t_type:custom'</td>\r\n    </tr>\r\n    <tr>\r\n      <td>client_ref</td>\r\n      <td>Show searches with the same client reference</td>\r\n    </tr>\r\n    <tr>\r\n      <td>monitored</td>\r\n      <td>Searches with a specific monitored status, eg. suspended for suspended searches, un-suspended for actively monitored searches and false for searches which are not monitored</td>\r\n    </tr>\r\n  </tbody>\r\n</table>\r\n<br></br>\r\n<b>Sorting parameters:</b>\r\n<br></br>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>sort_by</td>\r\n      <td>One of 'id', 'created_at', 'updated_at', 'assignee_id', 'searcher_id'</td>\r\n    </tr>\r\n    <tr>\r\n      <td>sort_dir</td>\r\n      <td>One of 'ASC, 'DESC'</td>\r\n    </tr>\r\n  </tbody>\r\n</table>\r\n<br></br>\r\n<b>Pagination parameters:</b>\r\n<br></br>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>per_page</td>\r\n      <td>Number of searches to return per \"page\" (integer, max 100)</td>\r\n    </tr>\r\n    <tr>\r\n      <td>page</td>\r\n      <td>Which page to fetch (integer)</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Compliance_GetSearch","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}},"post":{"tags":["CR Comply API"],"summary":"Create a new search","description":"The request should be a JSON object containing the following fields:\r\n- `search_term`: string\r\n- `fuzziness`: double\r\n- `filters`: object\r\n- `tags`: object\r\n- `share_url`: integer\r\n<br></br>\r\n\r\nJSON Request sample:\r\n\r\n    {\r\n        \"search_term\": \"A Bad Company Ltd\",\r\n        \"fuzziness\": 0.6,\r\n        \"filters\": {\r\n            \"types\": [\r\n                \"sanction\",\r\n                \"warning\"\r\n                     ]\r\n                   },\r\n        \"tags\": {\r\n        \"name\": \"value\"\r\n                },\r\n        \"share_url\": 1\r\n    }\r\n    \r\n<br></br><table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td>search_term (required)</td><td>String/Object</td><td>A string representing the name of the entity or an Object</td></tr><tr><td>client_ref (optional, max 255 characters))</td><td>String</td><td>Your reference for this person/entity for which you are searching. Used for tracking searches and auto-whitelisting recurring results</td></tr><tr><td>search_profile (optional)</td><td>String</td><td>The identifier of a search profile (depending on the search profile this is either a slug or a profile id) that can be retrieved from the UI</td></tr><tr><td>fuzziness (optional)</td><td>Float(0.0 to 1.0)</td><td>Determines how closely the returned results must match the supplied name. Overridden by exact_match</td></tr><tr><td>offset (optional)</td><td>Integer(default 0)</td><td>Match results from the database, starting from the offset value</td></tr><tr><td>limit (optional)</td><td>Integer(default 100, Max 100)</td><td>Match results from the database, taking up to this many matches each search</td></tr><tr><td>filters (optional)</td><td>Object</td><td>Specify filters within the search to narrow down the results. These are specified below, and are all optional</td></tr><tr><td>tags (optional)</td><td>Object</td><td>Object of name =&gt; value pairs (name must be string), must be existing tags</td></tr><tr><td>filters (optional)</td><td>Object</td><td>Specify filters within the search to narrow down the results. These are specified below, and are all optional</td></tr><tr><td>country_codes (optional)</td><td>Array of ISO 3166-1 alpha-2 </td><td>Results are filtered by the entity nationality or country of residence</td></tr><tr><td>exact_match (optional)</td><td>Boolean</td><td>Exact match disables all standard and optional matching behaviours 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviours (standard and optional)</td></tr></tbody></table><br></br><b>Filters in searches:</b><table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td>types</td><td>Array of strings</td><td>One or more of:<br>\r\n       •\tsanction<br>\r\n       •\twarning<br>\r\n       •\tfitness-probity</br>\r\n       •\tpep<br>\r\n       •\tpep-class-1</br>\r\n       •\tpep-class-2</br>\r\n       •\tpep-class-3</br>\r\n       •\tpep-class-4<br></br>\r\n        Classic Adverse Media Taxonomy:<br>\r\n       •\tadverse-media</br>\r\n       •\tadverse-media-financial-crime<br>\r\n       •\tadverse-media-violent-crime</br>\r\n       •\tadverse-media-sexual-crime<br>\r\n       •\tadverse-media-terrorism</br>\r\n       •\tadverse-media-fraud<br>\r\n       •\tadverse-media-narcotics</br>\r\n       •\tadverse-media-general<br> \r\n        If you use FATF-aligned Adverse Media Taxonomy:</br>\r\n       •\tadverse-media-v2-property<br>\r\n       •\tadverse-media-v2-financial-aml-cft</br>\r\n       •\tadverse-media-v2-fraud-linked<br>\r\n       •\tadverse-media-v2-narcotics-aml-cft</br>\r\n       •\tadverse-media-v2-violence-aml-cft<br>\r\n       •\tadverse-media-v2-terrorism</br>\r\n       •\tadverse-media-v2-cybercrime<br>\r\n       •\tadverse-media-v2-general-aml-cft</br>\r\n       •\tadverse-media-v2-regulatory<br>\r\n       •\tadverse-media-v2-financial-difficulty</br>\r\n       •\tadverse-media-v2-violence-non-aml-cft<br>\r\n       •\tadverse-media-v2-other-financial</br>\r\n       •\tadverse-media-v2-other-serious<br>\r\n       •\tadverse-media-v2-other-minor</br></td></tr><tr><td>birth_year</td><td>Integer</td><td>Year of birth, if known</td></tr><tr><td>remove_deceased</td><td>\"1\" or \"0\"</td><td>A flag which when set, removes deceased people from search results</td></tr><tr><td>country_codes</td><td>Array of ISO 3166-1 alpha-2 strings</td><td>Results filtered by nationality or country of residence.Country code filtering applies to:<br>\r\n            •\tEntity of type PEP only<br>\r\n            •\tEntity of type PEP with Adverse Media<br>\r\n            •\tEntity that has 1 country value or more (only one must match)<br></br>\r\n            Country code filtering does not apply to (i.e. results will still appear regardless of the country filter):</br>\r\n            •\tEntity on sanction lists will always appear regardless of other status (PEP, Adverse media)</br>\r\n            •\tEntity that has adverse media mentions only</br>\r\n            •\tEntity that does not have a country assigned\r\n        </td></tr><tr><td>entity_type</td><td>entity_type String (one of):\r\n            •\t\"person\"<br>\r\n            •\t\"company\"</br>\r\n            •   \"organisation\"<br>\r\n            •\t\"vessel\"</br>\r\n            •\t\"aircraft\"\r\n       </td><td>Entity type filter is not a hard filter between different entity types. It only optimizes the matching logic to the relevant entity type.Matching:<br>\r\n            •\tDepending on the entity type, pre-fixes and suffixes will be processed differently to avoid false negatives (\"Mr Robert Mugabe\" matching \"Robert Mugabe\" for person, \"Cimex Ltd\" matching \"Cimex\" for company).</br>\r\n            •\tEquivalent names considered specifically for different entity types (\"Robert\" and \"Bob\" versus \"Investment\" and \"Inversion\").<br>\r\n            •\tInitial matching between individual (\"Carl W. Litsch\") versus company acronyms (\"KFC\").</br>\r\n            Optional: If missing, default rules and logic are applied.\r\n       </td></tr></tbody></table>","operationId":"Compliance_CreateSearch","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/compliance/searches/{id}":{"get":{"tags":["CR Comply API"],"summary":"Get an overview of one of your searches","description":"<b>URL PARAMETERS:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>id</td>\r\n      <td>Either the numeric search ID, or the search REF</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Compliance_GetById","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/compliance/searches/{id}/details":{"get":{"tags":["CR Comply API"],"summary":"Get full search results of one of your searches","description":"<b>URL PARAMETERS:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>id</td>\r\n      <td>Either the numeric search ID, or the search REF</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Compliance_GetByIdDetails","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/compliance/searches/{id}/monitors":{"get":{"tags":["CR Comply API"],"summary":"Get monitored search details","description":"<b>URL PARAMETERS:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>id</td>\r\n      <td>Either the numeric search ID, or the search REF</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Compliance_MonitoredSearchesByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}},"post":{"tags":["CR Comply API"],"summary":"Update monitored search details (start/stop monitoring)","description":"<b>URL PARAMETERS:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>id</td>\r\n      <td>Either the numeric search ID, or the search REF</td>\r\n    </tr>\r\n  </tbody>\r\n</table>\r\n<br></br>\r\n<b>JSON POST PARAMETERS</b>\r\n<br></br>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>is_monitored</td>\r\n      <td>Boolean</td>\r\n      <td>Start on true and stop on false. For monitored searches, the original search will be updated with the latest results from monitor runs.</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Compliance_PatchMonitoredSearchesByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/compliance/searches/{id}/monitors/differences":{"get":{"tags":["CR Comply API"],"summary":"Retrieve the differences on the monitored search","description":"<b>URL PARAMETERS:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>id</td>\r\n      <td>Either the numeric search ID, or the search REF</td>\r\n    </tr>\r\n    <tr>\r\n      <td>date (optional)</td>\r\n      <td>The reference date (format: yyyy-mm-dd); if missing, the current day will be used</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Compliance_MonitoredSearchesByIDMonitorDifferences","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/compliance/searches/{id}/update":{"post":{"tags":["CR Comply API"],"summary":"Update details of one of your searches (e.g. status)","description":"<b>URL PARAMETERS:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>id</td>\r\n      <td>Either the numeric search ID, or the search REF</td>\r\n    </tr>\r\n  </tbody>\r\n</table>\r\n<br></br>\r\n<b>JSON PATCH PARAMETERS:</b>\r\n<br></br>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>match_status</td>\r\n      <td>String</td>\r\n      <td>One of 'unknown', 'no_match', 'potential_match', 'false_positive', 'true_positive', 'true_positive_approve', 'true_positive_reject'</td>\r\n    </tr>\r\n    <tr>\r\n      <td>risk_level</td>\r\n      <td>String</td>\r\n      <td>One of 'low', 'medium', 'high', 'unknown'</td>\r\n    </tr>\r\n    <tr>\r\n      <td>assignee_id</td>\r\n      <td>Integer</td>\r\n      <td>The ID of the user to whom the case should be assigned</td>\r\n    </tr>\r\n    <tr>\r\n      <td>limit</td>\r\n      <td>Integer</td>\r\n      <td>The number of matches retrieved (max. 100)</td>\r\n    </tr>\r\n    <tr>\r\n      <td>tags</td>\r\n      <td>Object</td>\r\n      <td>Object of name =&gt; value pairs ( name must be string ), must be existing tags</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Compliance_UpdatingSearchesByID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/compliance/searches/{id}/entities":{"post":{"tags":["CR Comply API"],"summary":"Update entities details of one of your searches","description":"<b>URL PARAMETERS:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>id</td>\r\n      <td>Either the numeric search ID, or the search REF</td>\r\n    </tr>\r\n  </tbody>\r\n</table>\r\n<br></br>\r\n<b>JSON POST PARAMETERS:</b>\r\n<br></br>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>entities</td>\r\n      <td>Array</td>\r\n      <td>Array of entity ids to be updated (list of strings)</td>\r\n    </tr>\r\n    <tr>\r\n      <td>match_status</td>\r\n      <td>String</td>\r\n      <td>One of 'no_match', 'false_positive', 'potential_match', 'true_positive','unknown'</td>\r\n    </tr>\r\n    <tr>\r\n      <td>risk_level</td>\r\n      <td>String</td>\r\n      <td>One of 'low', 'medium', 'high', 'unknown'</td>\r\n    </tr>\r\n    <tr>\r\n      <td>is_whitelisted</td>\r\n      <td>Boolean</td>\r\n      <td>true or false</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Compliance_UpdatingSearchesByIDEntities","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/compliance/searches/{id}/comments":{"get":{"tags":["CR Comply API"],"summary":"Retrieve comments for a specific search","description":"<b>URL PARAMETERS:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>id</td>\r\n      <td>Either the numeric search ID, or the search REF</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Compliance_GetComments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}},"post":{"tags":["CR Comply API"],"summary":"Create a comment (comment on search or comment on entity)","description":"<b>URL PARAMETERS:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>id</td>\r\n      <td>Either the numeric search ID, or the search REF</td>\r\n    </tr>\r\n  </tbody>\r\n</table>\r\n<br></br>\r\n<b>JSON POST PARAMETERS:</b>\r\n<br></br>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <td>\r\n        <b>TYPE</b>\r\n      </td>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>comment</td>\r\n      <td>String</td>\r\n      <td>The comment that will be added</td>\r\n    </tr>\r\n    <tr>\r\n      <td>entity_id</td>\r\n      <td>String</td>\r\n      <td>The entity id (required for adding comment on entity)</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Compliance_PostComments","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"integer","format":"int64"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/common/InterviewOutcome":{"get":{"tags":["Common"],"summary":"Retrieves investigation interview outcomes","description":"<b>JSON Response Parameters:</b>\r\n<table>\r\n  <tr>\r\n    <td>\r\n      <b>FIELD NAME</b>\r\n    </td>\r\n    <td>\r\n      <b>TYPE</b>\r\n    </td>\r\n    <td>\r\n      <b>DESCRIPTION</b>\r\n    </td>\r\n  </tr>\r\n  <tr>\r\n    <td>\r\n      <strong>ID</strong>\r\n    </td>\r\n    <td>Integer</td>\r\n    <td>Interview outcome identifier</td>\r\n  </tr>\r\n  <tr>\r\n    <td>\r\n      <strong>Name</strong>\r\n    </td>\r\n    <td>String</td>\r\n    <td>Interview outcome name</td>\r\n  </tr>\r\n</table>\r\n<b>JSON Response sample:</b>\r\n            \r\n                [\r\n                        {\r\n                          \"ID\": 1,\r\n                          \"Name\": \"Cooperative - Key Information Confirmed\",\r\n                          \"Description\": \"Information obtained directly from the company or verified sources\"\r\n                        },\r\n                        {\r\n                          \"ID\": 2,\r\n                          \"Name\": \"Partially Cooperative - Limited Information Confirmed\",\r\n                          \"Description\": \"Multiple contact attempts made, but no reply received\"\r\n                        },\r\n                        {\r\n                          \"ID\": 3,\r\n                          \"Name\": \"Do Not Contact the Subject - As Per Client Request\",\r\n                          \"Description\": \"Subject was contacted but declined to share information\"\r\n                        },\r\n                        {\r\n                          \"ID\": 4,\r\n                          \"Name\": \"Contact Details Unreachable - Subject Not Reached\",\r\n                          \"Description\": \"Contact is not requested to be made with the Subject\"\r\n                        },\r\n                        {\r\n                          \"ID\": 5,\r\n                          \"Name\": \"Subject Declined - Refused to Provide Information\",\r\n                          \"Description\": \"No reliable data found through available sources\"\r\n                        }\r\n                ]","operationId":"Common_InterviewOutcome","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/InterviewOutcomeDTO"}}}}}},"/api/common/CallOutcome":{"get":{"tags":["Common"],"summary":"Retrieves a list of call outcomes","description":"<b>JSON Response Parameters:</b>\r\n<table>\r\n  <tr>\r\n    <td>\r\n      <b>FIELD NAME</b>\r\n    </td>\r\n    <td>\r\n      <b>TYPE</b>\r\n    </td>\r\n  </tr>\r\n  <tr>\r\n    <td>\r\n      <strong>ID</strong>\r\n    </td>\r\n    <td>Integer</td>\r\n  </tr>\r\n  <tr>\r\n    <td>\r\n      <strong>Name</strong>\r\n    </td>\r\n    <td>String</td>\r\n  </tr>\r\n</table>\r\n<b>JSON Response sample:</b>\r\n            \r\n                [\r\n                  {\r\n                    \"ID\": 1,\r\n                    \"Name\": \"Investigation Successfully Completed\"\r\n                  },\r\n                  {\r\n                    \"ID\": 2,\r\n                    \"Name\": \"No Response Received\"\r\n                  },\r\n                  {\r\n                    \"ID\": 3,\r\n                    \"Name\": \"Information Disclosure Declined\"\r\n                  },\r\n                  {\r\n                    \"ID\": 4,\r\n                    \"Name\": \"Don't Establish Contact\"\r\n                  },\r\n                  {\r\n                    \"ID\": 5,\r\n                    \"Name\": \"No Verifiable Contact Details Available\"\r\n                  }\r\n                ]","operationId":"Common_CallOutcome","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PairDTO"}}}}}},"/api/common/ContactMethod":{"get":{"tags":["Common"],"summary":"Retrieves a list of contact methods","description":"<b>JSON Response Parameters:</b>\r\n<table>\r\n  <tr>\r\n    <td>\r\n      <b>FIELD NAME</b>\r\n    </td>\r\n    <td>\r\n      <b>TYPE</b>\r\n    </td>\r\n  </tr>\r\n  <tr>\r\n    <td>\r\n      <strong>ID</strong>\r\n    </td>\r\n    <td>Integer</td>\r\n  </tr>\r\n  <tr>\r\n    <td>\r\n      <strong>Name</strong>\r\n    </td>\r\n    <td>String</td>\r\n  </tr>\r\n</table>\r\n<b>JSON Response sample:</b>\r\n            \r\n                [\r\n                  {\r\n                    \"ID\": 1,\r\n                    \"Name\": \"Telephone Interview\"\r\n                  },\r\n                  {\r\n                    \"ID\": 2,\r\n                    \"Name\": \"Email\"\r\n                  }\r\n                ]","operationId":"Common_ContactMethod","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PairDTO"}}}}}},"/api/common/InvestigationDataPoints":{"get":{"tags":["Common"],"summary":"Retrieves a list of investigation data points","description":"<b>JSON Response Parameters:</b>\r\n<table>\r\n  <tr>\r\n    <td>\r\n      <b>FIELD NAME</b>\r\n    </td>\r\n    <td>\r\n      <b>TYPE</b>\r\n    </td>\r\n    <td>\r\n      <b>DESCRIPTION</b>\r\n    </td>\r\n  </tr>\r\n  <tr>\r\n    <td>\r\n      <strong>CategoryId</strong>\r\n    </td>\r\n    <td>Integer</td>\r\n    <td>Category identifier</td>\r\n  </tr>\r\n  <tr>\r\n    <td>\r\n      <strong>CategoryName</strong>\r\n    </td>\r\n    <td>String</td>\r\n    <td>Category name</td>\r\n  </tr>\r\n  <tr>\r\n    <td>\r\n      <strong>DataPointId</strong>\r\n    </td>\r\n    <td>Integer</td>\r\n    <td>Data point identifier</td>\r\n  </tr>\r\n  <tr>\r\n    <td>\r\n      <strong>DataPointName</strong>\r\n    </td>\r\n    <td>String</td>\r\n    <td>Data point name</td>\r\n  </tr>\r\n</table>\r\n<b>JSON Response sample:</b>\r\n            \r\n                [\r\n                  {\r\n                    \"CategoryId\": 1,\r\n                    \"CategoryName\": \"Company Profile and Operations\",\r\n                    \"DataPointId\": 1,\r\n                    \"DataPointName\": \"Operational Status\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 1,\r\n                    \"CategoryName\": \"Company Profile and Operations\",\r\n                    \"DataPointId\": 2,\r\n                    \"DataPointName\": \"Premises\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 1,\r\n                    \"CategoryName\": \"Company Profile and Operations\",\r\n                    \"DataPointId\": 3,\r\n                    \"DataPointName\": \"Number of Employees\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 1,\r\n                    \"CategoryName\": \"Company Profile and Operations\",\r\n                    \"DataPointId\": 4,\r\n                    \"DataPointName\": \"Registration Details / Legal Entity Info\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 2,\r\n                    \"CategoryName\": \"Ownership and Management\",\r\n                    \"DataPointId\": 5,\r\n                    \"DataPointName\": \"Shareholders / Ownership\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 2,\r\n                    \"CategoryName\": \"Ownership and Management\",\r\n                    \"DataPointId\": 6,\r\n                    \"DataPointName\": \"Directors / Key Management\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 3,\r\n                    \"CategoryName\": \"Business Operations and Risk Overview\",\r\n                    \"DataPointId\": 7,\r\n                    \"DataPointName\": \"Number of Employees\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 3,\r\n                    \"CategoryName\": \"Business Operations and Risk Overview\",\r\n                    \"DataPointId\": 8,\r\n                    \"DataPointName\": \"Industry and Related News\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 3,\r\n                    \"CategoryName\": \"Business Operations and Risk Overview\",\r\n                    \"DataPointId\": 9,\r\n                    \"DataPointName\": \"Import and Export Activities\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 3,\r\n                    \"CategoryName\": \"Business Operations and Risk Overview\",\r\n                    \"DataPointId\": 10,\r\n                    \"DataPointName\": \"Method of Payment\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 3,\r\n                    \"CategoryName\": \"Business Operations and Risk Overview\",\r\n                    \"DataPointId\": 11,\r\n                    \"DataPointName\": \"Trade Suppliers and Key Partners\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 3,\r\n                    \"CategoryName\": \"Business Operations and Risk Overview\",\r\n                    \"DataPointId\": 12,\r\n                    \"DataPointName\": \"Legal and Insolvency Information\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 4,\r\n                    \"CategoryName\": \"Financial Position and Exposure\",\r\n                    \"DataPointId\": 13,\r\n                    \"DataPointName\": \"Full Financials\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 4,\r\n                    \"CategoryName\": \"Financial Position and Exposure\",\r\n                    \"DataPointId\": 14,\r\n                    \"DataPointName\": \"Partial Financial\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 4,\r\n                    \"CategoryName\": \"Financial Position and Exposure\",\r\n                    \"DataPointId\": 15,\r\n                    \"DataPointName\": \"Trade Reference / Outstanding Debts\"\r\n                  },\r\n                  {\r\n                    \"CategoryId\": 4,\r\n                    \"CategoryName\": \"Financial Position and Exposure\",\r\n                    \"DataPointId\": 16,\r\n                    \"DataPointName\": \"Banks / Financials Relationships\"\r\n                  }\r\n                ]","operationId":"Common_InvestigationDataPoints","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/common/Countries":{"get":{"tags":["Common"],"summary":"Retrieves country IDs","description":"JSON Response Parameters:\r\n\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><strong>ID</strong></td><td>Integer</td><td>Country identifier</td></tr><tr><td><strong>Country</strong></td><td>String</td><td>Country name</td></tr></tbody></table><b>JSON Response sample:</b>\r\n\r\n        {\r\n        \t\"ID\": 2,\r\n        \t\"Country\": \"Afghanistan\",\r\n        \t\"CountryCode\": \"AF\"\r\n        },\r\n        {\r\n        \t\"ID\": 473,\r\n        \t\"Country\": \"Aland Islands\",\r\n        \t\"CountryCode\": \"AX\"\r\n        },\r\n        {\r\n            \"ID\": 4,\r\n        \t\"Country\": \"Albania\",\r\n        \t\"CountryCode\": \"AL\"\r\n        },\r\n        {\r\n            \"ID\": 5,\r\n        \t\"Country\": \"Algeria\",\r\n        \t\"CountryCode\": \"DZ\"\r\n        },\r\n        {\r\n            \"ID\": 136,\r\n        \t\"Country\": \"American Samoa\",\r\n        \t\"CountryCode\": \"AS\"\r\n        },\r\n        {\r\n            \"ID\": 6,\r\n        \t\"Country\": \"Andorra\",\r\n        \t\"CountryCode\": \"AD\"\r\n        },\r\n        {\r\n            \"ID\": 7,\r\n        \t\"Country\": \"Angola\",\r\n        \t\"CountryCode\": \"AO\"\r\n        },\r\n        {\r\n            \"ID\": 171,\r\n        \t\"Country\": \"Anguilla\",\r\n        \t\"CountryCode\": \"AI\"\r\n        },\r\n        {\r\n            \"ID\": 360,\r\n        \t\"Country\": \"Antarctica\",\r\n        \t\"CountryCode\": \"AQ\"\r\n        },\r\n        {\r\n            \"ID\": 488,\r\n        \t\"Country\": \"Antigua and Barbuda\",\r\n        \t\"CountryCode\": \"AG\"\r\n        },\r\n        {\r\n            \"ID\": 10,\r\n        \t\"Country\": \"Argentina\",\r\n        \t\"CountryCode\": \"AR\"\r\n        },\r\n        {\r\n            \"ID\": 11,\r\n        \t\"Country\": \"Armenia\",\r\n        \t\"CountryCode\": \"AM\"\r\n        },\r\n        {\r\n            \"ID\": 172,\r\n        \t\"Country\": \"Aruba\",\r\n        \t\"CountryCode\": \"AW\"\r\n        },\r\n        {\r\n            \"ID\": 12,\r\n        \t\"Country\": \"Australia\",\r\n        \t\"CountryCode\": \"AU\"\r\n        },\r\n        {\r\n            \"ID\": 13,\r\n        \t\"Country\": \"Austria\",\r\n        \t\"CountryCode\": \"AT\"\r\n        },\r\n        {\r\n            \"ID\": 431,\r\n        \t\"Country\": \"Azerbaijan\",\r\n        \t\"CountryCode\": \"AZ\"\r\n        },\r\n        {\r\n            \"ID\": 15,\r\n        \t\"Country\": \"Bahamas\",\r\n        \t\"CountryCode\": \"BS\"\r\n        },\r\n        {\r\n            \"ID\": 16,\r\n        \t\"Country\": \"Bahrain\",\r\n        \t\"CountryCode\": \"BH\"\r\n        },\r\n        {\r\n            \"ID\": 17,\r\n        \t\"Country\": \"Bangladesh\",\r\n        \t\"CountryCode\": \"BD\"\r\n        },\r\n        {\r\n            \"ID\": 18,\r\n        \t\"Country\": \"Barbados\",\r\n        \t\"CountryCode\": \"BB\"\r\n        },\r\n        {\r\n            \"ID\": 485,\r\n        \t\"Country\": \"Bashkortostan\",\r\n        \t\"CountryCode\": \"RU\"\r\n        },\r\n        {\r\n            \"ID\": 456,\r\n        \t\"Country\": \"Belarus\",\r\n        \t\"CountryCode\": \"BY\"\r\n        },\r\n        {\r\n            \"ID\": 20,\r\n        \t\"Country\": \"Belgium\",\r\n        \t\"CountryCode\": \"BE\"\r\n        },\r\n        {\r\n            \"ID\": 21,\r\n        \t\"Country\": \"Belize\",\r\n        \t\"CountryCode\": \"BZ\"\r\n        },\r\n        {\r\n            \"ID\": 22,\r\n        \t\"Country\": \"Benin\",\r\n        \t\"CountryCode\": \"BJ\"\r\n        },\r\n        {\r\n            \"ID\": 71,\r\n        \t\"Country\": \"Bermuda\",\r\n        \t\"CountryCode\": \"BM\"\r\n        },\r\n        {\r\n            \"ID\": 23,\r\n        \t\"Country\": \"Bhutan\",\r\n        \t\"CountryCode\": \"BT\"\r\n        },\r\n        {\r\n            \"ID\": 432,\r\n        \t\"Country\": \"Bolivia, (Plurinational State Of)\",\r\n        \t\"CountryCode\": \"BO\"\r\n        },\r\n        {\r\n            \"ID\": 474,\r\n        \t\"Country\": \"Bonaire, Saint Eustatius And Saba\",\r\n        \t\"CountryCode\": \"BQ\"\r\n        },\r\n        {\r\n            \"ID\": 25,\r\n        \t\"Country\": \"Bosnia and Herzegovina\",\r\n        \t\"CountryCode\": \"BA\"\r\n        },\r\n        {\r\n            \"ID\": 176,\r\n        \t\"Country\": \"Botswana\",\r\n        \t\"CountryCode\": \"BW\"\r\n        },\r\n        {\r\n            \"ID\": 175,\r\n        \t\"Country\": \"Bouvet Island\",\r\n        \t\"CountryCode\": \"BV\"\r\n        },\r\n        {\r\n            \"ID\": 26,\r\n        \t\"Country\": \"Brazil\",\r\n        \t\"CountryCode\": \"BR\"\r\n        },\r\n        {\r\n            \"ID\": 366,\r\n        \t\"Country\": \"British Indian Ocean Territory\",\r\n        \t\"CountryCode\": \"IO\"\r\n        },\r\n        {\r\n            \"ID\": 468,\r\n        \t\"Country\": \"Brunei Darussalam\",\r\n        \t\"CountryCode\": \"BN\"\r\n        },\r\n        {\r\n            \"ID\": 27,\r\n        \t\"Country\": \"Bulgaria\",\r\n        \t\"CountryCode\": \"BG\"\r\n        },\r\n        {\r\n            \"ID\": 173,\r\n        \t\"Country\": \"Burkina Faso\",\r\n        \t\"CountryCode\": \"BF\"\r\n        },\r\n        {\r\n            \"ID\": 28,\r\n        \t\"Country\": \"Burundi\",\r\n        \t\"CountryCode\": \"BI\"\r\n        },\r\n        {\r\n            \"ID\": 197,\r\n        \t\"Country\": \"Cambodia\",\r\n        \t\"CountryCode\": \"KH\"\r\n        },\r\n        {\r\n            \"ID\": 30,\r\n        \t\"Country\": \"Cameroon\",\r\n        \t\"CountryCode\": \"CM\"\r\n        },\r\n        {\r\n            \"ID\": 31,\r\n        \t\"Country\": \"Canada\",\r\n        \t\"CountryCode\": \"CA\"\r\n        },\r\n        {\r\n            \"ID\": 433,\r\n        \t\"Country\": \"Canary Islands\",\r\n        \t\"CountryCode\": \"\"\r\n        },\r\n        {\r\n            \"ID\": 32,\r\n        \t\"Country\": \"Cape Verde\",\r\n        \t\"CountryCode\": \"CV\"\r\n        },\r\n        {\r\n            \"ID\": 72,\r\n        \t\"Country\": \"Cayman Islands (the)\",\r\n        \t\"CountryCode\": \"KY\"\r\n        \r\n        },\r\n        {\r\n            \"ID\": 177,\r\n        \t\"Country\": \"Central African Republic (the)\",\r\n        \t\"CountryCode\": \"CF\"\r\n        },\r\n        {\r\n            \"ID\": 226,\r\n        \t\"Country\": \"Chad\",\r\n        \t\"CountryCode\": \"TD\"\r\n        },\r\n        {\r\n            \"ID\": 34,\r\n        \t\"Country\": \"Chile\",\r\n        \t\"CountryCode\": \"CL\"\r\n        },\r\n        {\r\n            \"ID\": 35,\r\n        \t\"Country\": \"China\",\r\n        \t\"CountryCode\": \"CN\"\r\n        },\r\n        {\r\n            \"ID\": 457,\r\n        \t\"Country\": \"Christmas Island\",\r\n        \t\"CountryCode\": \"CX\"\r\n        },\r\n        {\r\n            \"ID\": 73,\r\n        \t\"Country\": \"Cocos (Keeling) Islands\",\r\n        \t\"CountryCode\": \"CC\"\r\n        },\r\n        {\r\n            \"ID\": 38,\r\n        \t\"Country\": \"Colombia\",\r\n        \t\"CountryCode\": \"CO\"\r\n        },\r\n        {\r\n            \"ID\": 199,\r\n        \t\"Country\": \"Comoros (the)\",\r\n        \t\"CountryCode\": \"KM\"\r\n        },\r\n        {\r\n            \"ID\": 470,\r\n        \t\"Country\": \"Congo (the Democratic Republic of the) \",\r\n        \t\"CountryCode\": \"CD\"\r\n        },\r\n        {\r\n            \"ID\": 434,\r\n        \t\"Country\": \"Congo (the)\",\r\n        \t\"CountryCode\": \"CG\"\r\n        },\r\n        {\r\n            \"ID\": 178,\r\n        \t\"Country\": \"Cook Islands (the)\",\r\n        \t\"CountryCode\": \"CK\"\r\n        },\r\n        {\r\n            \"ID\": 42,\r\n        \t\"Country\": \"Costa Rica\",\r\n        \t\"CountryCode\": \"CR\"\r\n        },\r\n        {\r\n            \"ID\": 435,\r\n        \t\"Country\": \"Côte d'Ivoire\",\r\n        \t\"CountryCode\": \"CI\"\r\n        },\r\n        {\r\n            \"ID\": 43,\r\n        \t\"Country\": \"Croatia\",\r\n        \t\"CountryCode\": \"HR\"\r\n        },\r\n        {\r\n            \"ID\": 44,\r\n        \t\"Country\": \"Cuba\",\r\n        \t\"CountryCode\": \"CU\"\r\n        },\r\n        {\r\n            \"ID\": 451,\r\n        \t\"Country\": \"Curacao\",\r\n        \t\"CountryCode\": \"CW\"\r\n        },\r\n        {\r\n            \"ID\": 36,\r\n        \t\"Country\": \"Cyprus\",\r\n        \t\"CountryCode\": \"CY\"\r\n        },\r\n        {\r\n            \"ID\": 447,\r\n        \t\"Country\": \"Cyprus, Northern (Occupied)\",\r\n        \t\"CountryCode\": \"CY\"\r\n        },\r\n        {\r\n            \"ID\": 33,\r\n        \t\"Country\": \"Czechia\",\r\n        \t\"CountryCode\": \"CZ\"\r\n        },\r\n        {\r\n            \"ID\": 45,\r\n        \t\"Country\": \"Denmark\",\r\n        \t\"CountryCode\": \"DK\"\r\n        },\r\n        {\r\n            \"ID\": 180,\r\n        \t\"Country\": \"Djibouti\",\r\n        \t\"CountryCode\": \"DJ\"\r\n        },\r\n        {\r\n            \"ID\": 46,\r\n        \t\"Country\": \"Dominica\",\r\n        \t\"CountryCode\": \"DM\"\r\n        },\r\n        {\r\n            \"ID\": 130,\r\n        \t\"Country\": \"Dominican Republic (the)\",\r\n        \t\"CountryCode\": \"DO\"\r\n        },\r\n        {\r\n            \"ID\": 47,\r\n        \t\"Country\": \"Ecuador\",\r\n        \t\"CountryCode\": \"EC\" \r\n        },\r\n        {\r\n            \"ID\": 48,\r\n        \t\"Country\": \"Egypt\",\r\n        \t\"CountryCode\": \"EG\" \r\n        },\r\n        {\r\n            \"ID\": 225,\r\n        \t\"Country\": \"El Salvador\",\r\n        \t\"CountryCode\": \"SV\" \r\n        },\r\n        {\r\n            \"ID\": 189,\r\n        \t\"Country\": \"Equatorial Guinea\",\r\n        \t\"CountryCode\": \"GQ\" \r\n        },\r\n        {\r\n            \"ID\": 181,\r\n        \t\"Country\": \"Eritrea\",\r\n        \t\"CountryCode\": \"ER\" \r\n        },\r\n        {\r\n            \"ID\": 50,\r\n        \t\"Country\": \"Estonia\",\r\n        \t\"CountryCode\": \"EE\" \r\n        },\r\n        {\r\n            \"ID\": 291,\r\n        \t\"Country\": \"Eswatini (Kingdom of, previously Swaziland)\",\r\n        \t\"CountryCode\": \"SZ\" \r\n        },\r\n        {\r\n            \"ID\": 51,\r\n        \t\"Country\": \"Ethiopia\",\r\n        \t\"CountryCode\": \"ET\" \r\n        },\r\n        {\r\n            \"ID\": 74,\r\n        \t\"Country\": \"Falkland Islands (Malvinas)\",\r\n        \t\"CountryCode\": \"FK\" \r\n        },\r\n        {\r\n            \"ID\": 184,\r\n        \t\"Country\": \"Faroe Islands (the)\",\r\n        \t\"CountryCode\": \"FO\" \r\n        },\r\n        {\r\n            \"ID\": 182,\r\n        \t\"Country\": \"Fiji\",\r\n        \t\"CountryCode\": \"FJ\" \r\n        },\r\n        {\r\n            \"ID\": 54,\r\n        \t\"Country\": \"Finland\",\r\n        \t\"CountryCode\": \"FI\" \r\n        },\r\n        {\r\n            \"ID\": 55,\r\n        \t\"Country\": \"France\",\r\n        \t\"CountryCode\": \"FR\" \r\n        },\r\n        {\r\n            \"ID\": 186,\r\n        \t\"Country\": \"French Guiana\",\r\n        \t\"CountryCode\": \"GF\"\r\n        },\r\n        {\r\n            \"ID\": 125,\r\n        \t\"Country\": \"French Polynesia\",\r\n        \t\"CountryCode\": \"PF\"\r\n        },\r\n        {\r\n            \"ID\": 56,\r\n        \t\"Country\": \"Gabon\",\r\n        \t\"CountryCode\": \"GA\"\r\n        },\r\n        {\r\n            \"ID\": 57,\r\n        \t\"Country\": \"Gambia (the)\",\r\n        \t\"CountryCode\": \"GM\"\r\n        },\r\n        {\r\n            \"ID\": 292,\r\n        \t\"Country\": \"Georgia\",\r\n        \t\"CountryCode\": \"GE\"\r\n        },\r\n        {\r\n            \"ID\": 58,\r\n        \t\"Country\": \"Germany\",\r\n        \t\"CountryCode\": \"DE\"\r\n        },\r\n        {\r\n            \"ID\": 187,\r\n        \t\"Country\": \"Ghana\",\r\n        \t\"CountryCode\": \"GH\"\r\n        },\r\n        {\r\n            \"ID\": 59,\r\n        \t\"Country\": \"Gibraltar\",\r\n        \t\"CountryCode\": \"GI\"\r\n        },\r\n        {\r\n            \"ID\": 60,\r\n        \t\"Country\": \"Greece\",\r\n        \t\"CountryCode\": \"GR\"\r\n        },\r\n        {\r\n            \"ID\": 364,\r\n        \t\"Country\": \"Greenland\",\r\n        \t\"CountryCode\": \"GL\"\r\n        },\r\n        {\r\n            \"ID\": 185,\r\n        \t\"Country\": \"Grenada\",\r\n        \t\"CountryCode\": \"GD\"\r\n        },\r\n        {\r\n            \"ID\": 188,\r\n        \t\"Country\": \"Guadeloupe\",\r\n        \t\"CountryCode\": \"GP\"\r\n        },\r\n        {\r\n            \"ID\": 191,\r\n        \t\"Country\": \"Guam\",\r\n        \t\"CountryCode\": \"GU\"\r\n        },\r\n        {\r\n            \"ID\": 62,\r\n        \t\"Country\": \"Guatemala\",\r\n        \t\"CountryCode\": \"GT\"\r\n        },\r\n        {\r\n            \"ID\": 455,\r\n        \t\"Country\": \"Guernsey\",\r\n        \t\"CountryCode\": \"GG\"\r\n        },\r\n        {\r\n            \"ID\": 63,\r\n        \t\"Country\": \"Guinea\",\r\n        \t\"CountryCode\": \"GN\"\r\n        },\r\n        {\r\n            \"ID\": 64,\r\n        \t\"Country\": \"Guinea-Bissau\",\r\n        \t\"CountryCode\": \"GW\"\r\n        },\r\n        {\r\n            \"ID\": 192,\r\n        \t\"Country\": \"Guyana\",\r\n        \t\"CountryCode\": \"GY\"\r\n        },\r\n        {\r\n            \"ID\": 194,\r\n        \t\"Country\": \"Haiti\",\r\n        \t\"CountryCode\": \"HT\"\r\n        },\r\n        {\r\n            \"ID\": 193,\r\n        \t\"Country\": \"Heard and McDonald Islands\",\r\n        \t\"CountryCode\": \"HM\"\r\n        },\r\n        {\r\n            \"ID\": 459,\r\n        \t\"Country\": \"Holy See (Vatican City State)\",\r\n        \t\"CountryCode\": \"VA\"\r\n        },\r\n        {\r\n            \"ID\": 65,\r\n        \t\"Country\": \"Honduras\",\r\n        \t\"CountryCode\": \"HN\"\r\n        },\r\n        {\r\n            \"ID\": 66,\r\n        \t\"Country\": \"Hong Kong\",\r\n        \t\"CountryCode\": \"HK\"\r\n        },\r\n        {\r\n            \"ID\": 160,\r\n        \t\"Country\": \"Hungary\",\r\n        \t\"CountryCode\": \"HU\"\r\n        },\r\n        {\r\n            \"ID\": 83,\r\n        \t\"Country\": \"Iceland\",\r\n        \t\"CountryCode\": \"IS\"\r\n        },\r\n        {\r\n            \"ID\": 69,\r\n        \t\"Country\": \"India\",\r\n        \t\"CountryCode\": \"IN\"\r\n        },\r\n        {\r\n            \"ID\": 70,\r\n        \t\"Country\": \"Indonesia\",\r\n        \t\"CountryCode\": \"ID\"\r\n        },\r\n        {\r\n            \"ID\": 81,\r\n        \t\"Country\": \"Iran (Islamic Republic of)\",\r\n        \t\"CountryCode\": \"IR\"\r\n        },\r\n        {\r\n            \"ID\": 80,\r\n        \t\"Country\": \"Iraq\",\r\n        \t\"CountryCode\": \"IQ\"\r\n        },\r\n        {\r\n            \"ID\": 82,\r\n        \t\"Country\": \"Ireland\",\r\n        \t\"CountryCode\": \"IE\"\r\n        },\r\n        {\r\n            \"ID\": 365,\r\n        \t\"Country\": \"Isle of Man\",\r\n        \t\"CountryCode\": \"IM\"\r\n        },\r\n        {\r\n            \"ID\": 84,\r\n        \t\"Country\": \"Israel\",\r\n        \t\"CountryCode\": \"IL\"\r\n        },\r\n        {\r\n            \"ID\": 85,\r\n        \t\"Country\": \"Italy\",\r\n        \t\"CountryCode\": \"IT\"\r\n        },\r\n        {\r\n            \"ID\": 195,\r\n        \t\"Country\": \"Jamaica\",\r\n        \t\"CountryCode\": \"JM\"\r\n        },\r\n        {\r\n            \"ID\": 87,\r\n        \t\"Country\": \"Japan\",\r\n        \t\"CountryCode\": \"JP\"\r\n        },\r\n        {\r\n            \"ID\": 454,\r\n        \t\"Country\": \"Jersey\",\r\n        \t\"CountryCode\": \"JE\"\r\n        },\r\n        {\r\n            \"ID\": 79,\r\n        \t\"Country\": \"Jordan\",\r\n        \t\"CountryCode\": \"JO\"\r\n        },\r\n        {\r\n            \"ID\": 88,\r\n        \t\"Country\": \"Kazakhstan\",\r\n        \t\"CountryCode\": \"KZ\"\r\n        },\r\n        {\r\n            \"ID\": 89,\r\n        \t\"Country\": \"Kenya\",\r\n        \t\"CountryCode\": \"KE\"\r\n        },\r\n        {\r\n            \"ID\": 198,\r\n        \t\"Country\": \"Kiribati\",\r\n        \t\"CountryCode\": \"KI\"\r\n        },\r\n        {\r\n            \"ID\": 475,\r\n        \t\"Country\": \"Korea (the Democratic People's Republic Of)\",\r\n        \t\"CountryCode\": \"KP\"\r\n        },\r\n        {\r\n            \"ID\": 436,\r\n        \t\"Country\": \"Korea, (the Republic Of)\",\r\n        \t\"CountryCode\": \"KR\"\r\n        },\r\n        {\r\n            \"ID\": 490,\r\n        \t\"Country\": \"Kosovo\",\r\n        \t\"CountryCode\": \"XK\"\r\n        },\r\n        {\r\n            \"ID\": 90,\r\n        \t\"Country\": \"Kuwait\",\r\n        \t\"CountryCode\": \"KW\"\r\n        },\r\n        {\r\n            \"ID\": 196,\r\n        \t\"Country\": \"Kyrgyzstan\",\r\n        \t\"CountryCode\": \"KG\"\r\n        },\r\n        {\r\n            \"ID\": 452,\r\n        \t\"Country\": \"Lao People's Democratic Republic (the)\",\r\n        \t\"CountryCode\": \"LA\"\r\n        },\r\n        {\r\n            \"ID\": 437,\r\n        \t\"Country\": \"Latvia\",\r\n        \t\"CountryCode\": \"LV\"\r\n        },\r\n        {\r\n            \"ID\": 93,\r\n        \t\"Country\": \"Lebanon\",\r\n        \t\"CountryCode\": \"LB\"\r\n        },\r\n        {\r\n            \"ID\": 460,\r\n        \t\"Country\": \"Lesotho\",\r\n        \t\"CountryCode\": \"LS\"\r\n        },\r\n        {\r\n            \"ID\": 94,\r\n        \t\"Country\": \"Liberia\",\r\n        \t\"CountryCode\": \"LR\"\r\n        },\r\n        {\r\n            \"ID\": 438,\r\n        \t\"Country\": \"Libya\",\r\n        \t\"CountryCode\": \"LY\"\r\n        },\r\n        {\r\n            \"ID\": 96,\r\n        \t\"Country\": \"Liechtenstein\",\r\n        \t\"CountryCode\": \"LI\"\r\n        },\r\n        {\r\n            \"ID\": 97,\r\n        \t\"Country\": \"Lithuania\",\r\n        \t\"CountryCode\": \"LT\"\r\n        },\r\n        {\r\n            \"ID\": 98,\r\n        \t\"Country\": \"Luxembourg\",\r\n        \t\"CountryCode\": \"LU\"\r\n        },\r\n        {\r\n            \"ID\": 99,\r\n        \t\"Country\": \"Macao\",\r\n        \t\"CountryCode\": \"MO\"\r\n        },\r\n        {\r\n            \"ID\": 100,\r\n        \t\"Country\": \"Macedonia (the Former Yugoslav Republic of)\",\r\n        \t\"CountryCode\": \"MK\"\r\n        },\r\n        {\r\n            \"ID\": 101,\r\n        \t\"Country\": \"Madagascar\",\r\n        \t\"CountryCode\": \"MG\"\r\n        },\r\n        {\r\n            \"ID\": 209,\r\n        \t\"Country\": \"Malawi\",\r\n        \t\"CountryCode\": \"MW\"\r\n        },\r\n        {\r\n            \"ID\": 102,\r\n        \t\"Country\": \"Malaysia\",\r\n        \t\"CountryCode\": \"MY\"\r\n        },\r\n        {\r\n            \"ID\": 208,\r\n        \t\"Country\": \"Maldives\",\r\n        \t\"CountryCode\": \"MV\"\r\n        },\r\n        {\r\n            \"ID\": 103,\r\n        \t\"Country\": \"Mali\",\r\n        \t\"CountryCode\": \"ML\"\r\n        },\r\n        {\r\n            \"ID\": 104,\r\n        \t\"Country\": \"Malta\",\r\n        \t\"CountryCode\": \"MT\"\r\n        },\r\n        {\r\n            \"ID\": 461,\r\n        \t\"Country\": \"Marshall Islands (the)\",\r\n        \t\"CountryCode\": \"MH\"\r\n        },\r\n        {\r\n            \"ID\": 205,\r\n        \t\"Country\": \"Martinique\",\r\n        \t\"CountryCode\": \"MQ\"\r\n        },\r\n        {\r\n            \"ID\": 107,\r\n        \t\"Country\": \"Mauritania\",\r\n        \t\"CountryCode\": \"MR\"\r\n        },\r\n        {\r\n            \"ID\": 207,\r\n        \t\"Country\": \"Mauritius\",\r\n        \t\"CountryCode\": \"MU\"\r\n        },\r\n        {\r\n            \"ID\": 237,\r\n        \t\"Country\": \"Mayotte\",\r\n        \t\"CountryCode\": \"YT\"\r\n        },\r\n        {\r\n            \"ID\": 108,\r\n        \t\"Country\": \"Mexico\",\r\n        \t\"CountryCode\": \"MX\"\r\n        },\r\n        {\r\n            \"ID\": 183,\r\n        \t\"Country\": \"Micronesia (Federated States of)\",\r\n        \t\"CountryCode\": \"FM\"\r\n        },\r\n        {\r\n            \"ID\": 109,\r\n        \t\"Country\": \"Moldova (the Republic of)\",\r\n        \t\"CountryCode\": \"MD\"\r\n        },\r\n        {\r\n            \"ID\": 110,\r\n        \t\"Country\": \"Monaco\",\r\n        \t\"CountryCode\": \"MC\"\r\n        },\r\n        {\r\n            \"ID\": 203,\r\n        \t\"Country\": \"Mongolia\",\r\n        \t\"CountryCode\": \"MN\"\r\n        },\r\n        {\r\n            \"ID\": 477,\r\n        \t\"Country\": \"Montenegro\",\r\n        \t\"CountryCode\": \"ME\"\r\n        },\r\n        {\r\n            \"ID\": 206,\r\n        \t\"Country\": \"Montserrat\",\r\n        \t\"CountryCode\": \"MS\"\r\n        },\r\n        {\r\n            \"ID\": 106,\r\n        \t\"Country\": \"Morocco\",\r\n        \t\"CountryCode\": \"MA\"\r\n        },\r\n        {\r\n            \"ID\": 111,\r\n        \t\"Country\": \"Mozambique\",\r\n        \t\"CountryCode\": \"MZ\"\r\n        },\r\n        {\r\n            \"ID\": 439,\r\n        \t\"Country\": \"Myanmar (formerly Burma)\",\r\n        \t\"CountryCode\": \"MM\"\r\n        },\r\n        {\r\n            \"ID\": 210,\r\n        \t\"Country\": \"Namibia\",\r\n        \t\"CountryCode\": \"NA\"\r\n        },\r\n        {\r\n            \"ID\": 214,\r\n        \t\"Country\": \"Nauru\",\r\n        \t\"CountryCode\": \"NR\"\r\n        },\r\n        {\r\n            \"ID\": 213,\r\n        \t\"Country\": \"Nepal\",\r\n        \t\"CountryCode\": \"NP\"\r\n        },\r\n        {\r\n            \"ID\": 118,\r\n        \t\"Country\": \"Netherlands (the)\",\r\n        \t\"CountryCode\": \"NL\"\r\n        },\r\n        {\r\n            \"ID\": 211,\r\n        \t\"Country\": \"New Caledonia\",\r\n        \t\"CountryCode\": \"NC\"\r\n        },\r\n        {\r\n            \"ID\": 117,\r\n        \t\"Country\": \"New Zealand\",\r\n        \t\"CountryCode\": \"NZ\"\r\n        },\r\n        {\r\n            \"ID\": 112,\r\n        \t\"Country\": \"Nicaragua\",\r\n        \t\"CountryCode\": \"NI\"\r\n        },\r\n        {\r\n            \"ID\": 113,\r\n        \t\"Country\": \"Niger (the)\",\r\n        \t\"CountryCode\": \"NE\"\r\n        },\r\n        {\r\n            \"ID\": 114,\r\n        \t\"Country\": \"Nigeria\",\r\n        \t\"CountryCode\": \"NG\"\r\n        },\r\n        {\r\n            \"ID\": 115,\r\n        \t\"Country\": \"Niue\",\r\n        \t\"CountryCode\": \"NU\"\r\n        },\r\n        {\r\n            \"ID\": 212,\r\n        \t\"Country\": \"Norfolk Island\",\r\n        \t\"CountryCode\": \"NF\"\r\n        },\r\n        {\r\n            \"ID\": 204,\r\n        \t\"Country\": \"Northern Mariana Islands (the)\",\r\n        \t\"CountryCode\": \"MP\"\r\n        },\r\n        {\r\n            \"ID\": 116,\r\n        \t\"Country\": \"Norway\",\r\n        \t\"CountryCode\": \"NO\"\r\n        \r\n        },\r\n        {\r\n            \"ID\": 119,\r\n        \t\"Country\": \"Oman\",\r\n        \t\"CountryCode\": \"OM\"\r\n        },\r\n        {\r\n            \"ID\": 120,\r\n        \t\"Country\": \"Pakistan\",\r\n        \t\"CountryCode\": \"PK\"\r\n        },\r\n        {\r\n            \"ID\": 218,\r\n        \t\"Country\": \"Palau\",\r\n        \t\"CountryCode\": \"PW\"\r\n        },\r\n        {\r\n            \"ID\": 440,\r\n        \t\"Country\": \"Palestine, State of\",\r\n        \t\"CountryCode\": \"PS\"\r\n        },\r\n        {\r\n            \"ID\": 122,\r\n        \t\"Country\": \"Panama\",\r\n        \t\"CountryCode\": \"PA\"\r\n        },\r\n        {\r\n            \"ID\": 215,\r\n        \t\"Country\": \"Papua New Guinea\",\r\n        \t\"CountryCode\": \"PG\"\r\n        \r\n        },\r\n        {\r\n            \"ID\": 123,\r\n        \t\"Country\": \"Paraguay\",\r\n        \t\"CountryCode\": \"PY\"\r\n        },\r\n        {\r\n            \"ID\": 124,\r\n        \t\"Country\": \"Peru\",\r\n        \t\"CountryCode\": \"PE\"\r\n        },\r\n        {\r\n            \"ID\": 53,\r\n        \t\"Country\": \"Philippines (the)\",\r\n        \t\"CountryCode\": \"PH\"\r\n        },\r\n        {\r\n            \"ID\": 462,\r\n        \t\"Country\": \"Pitcairn Island\",\r\n        \t\"CountryCode\": \"PN\"\r\n        },\r\n        {\r\n            \"ID\": 126,\r\n        \t\"Country\": \"Poland\",\r\n        \t\"CountryCode\": \"PL\"\r\n        },\r\n        {\r\n            \"ID\": 127,\r\n        \t\"Country\": \"Portugal\",\r\n        \t\"CountryCode\": \"PT\"\r\n        },\r\n        {\r\n            \"ID\": 217,\r\n        \t\"Country\": \"Puerto Rico\",\r\n        \t\"CountryCode\": \"PR\"\r\n        },\r\n        {\r\n            \"ID\": 128,\r\n        \t\"Country\": \"Qatar\",\r\n        \t\"CountryCode\": \"QA\"\r\n        \r\n        },\r\n        {\r\n            \"ID\": 443,\r\n        \t\"Country\": \"Réunion\",\r\n        \t\"CountryCode\": \"RE\"\r\n        },\r\n        {\r\n            \"ID\": 131,\r\n        \t\"Country\": \"Romania\",\r\n        \t\"CountryCode\": \"RO\"\r\n        },\r\n        {\r\n            \"ID\": 132,\r\n        \t\"Country\": \"Russian Federation\",\r\n        \t\"CountryCode\": \"RU\"\r\n        },\r\n        {\r\n            \"ID\": 133,\r\n        \t\"Country\": \"Rwanda\",\r\n        \t\"CountryCode\": \"RW\"\r\n        },\r\n        {\r\n            \"ID\": 476,\r\n        \t\"Country\": \"Saint Barthelemy\",\r\n        \t\"CountryCode\": \"BL\"\r\n        },\r\n        {\r\n            \"ID\": 220,\r\n        \t\"Country\": \"Saint Helena, Ascension and Tristan da Cunha\",\r\n        \t\"CountryCode\": \"SH\"\r\n        },\r\n        {\r\n            \"ID\": 200,\r\n        \t\"Country\": \"Saint Kitts and Nevis\",\r\n        \t\"CountryCode\": \"KN\"\r\n        },\r\n        {\r\n            \"ID\": 201,\r\n        \t\"Country\": \"Saint Lucia\",\r\n        \t\"CountryCode\": \"LC\"\r\n        },\r\n        {\r\n            \"ID\": 445,\r\n        \t\"Country\": \"Saint Martin\",\r\n        \t\"CountryCode\": \"MF\"\r\n        },\r\n        {\r\n            \"ID\": 216,\r\n        \t\"Country\": \"Saint Pierre and Miquelon\",\r\n        \t\"CountryCode\": \"PM\"\r\n        },\r\n        {\r\n            \"ID\": 487,\r\n        \t\"Country\": \"Saint Vincent and the Grenadines\",\r\n        \t\"CountryCode\": \"VC\"\r\n        },\r\n        {\r\n            \"ID\": 137,\r\n        \t\"Country\": \"San Marino\",\r\n        \t\"CountryCode\": \"SM\"\r\n        },\r\n        {\r\n            \"ID\": 224,\r\n        \t\"Country\": \"Sao Tome and Principe\",\r\n        \t\"CountryCode\": \"ST\"\r\n        },\r\n        {\r\n            \"ID\": 9,\r\n        \t\"Country\": \"Saudi Arabia\",\r\n        \t\"CountryCode\": \"SA\"\r\n        },\r\n        {\r\n            \"ID\": 138,\r\n        \t\"Country\": \"Senegal\",\r\n        \t\"CountryCode\": \"SN\"\r\n        },\r\n        {\r\n            \"ID\": 469,\r\n        \t\"Country\": \"Serbia\",\r\n        \t\"CountryCode\": \"RS\"\r\n        },\r\n        {\r\n            \"ID\": 140,\r\n        \t\"Country\": \"Seychelles\",\r\n        \t\"CountryCode\": \"SC\"\r\n        },\r\n        {\r\n            \"ID\": 222,\r\n        \t\"Country\": \"Sierra Leone\",\r\n        \t\"CountryCode\": \"SL\"\r\n        },\r\n        {\r\n            \"ID\": 141,\r\n        \t\"Country\": \"Singapore\",\r\n        \t\"CountryCode\": \"SG\"\r\n        },\r\n        {\r\n            \"ID\": 471,\r\n        \t\"Country\": \"Sint Maarten\",\r\n        \t\"CountryCode\": \"SX\"\r\n        },\r\n        {\r\n            \"ID\": 444,\r\n        \t\"Country\": \"Slovakia\",\r\n        \t\"CountryCode\": \"SK\"\r\n        },\r\n        {\r\n            \"ID\": 143,\r\n        \t\"Country\": \"Slovenia\",\r\n        \t\"CountryCode\": \"SI\"\r\n        },\r\n        {\r\n            \"ID\": 219,\r\n        \t\"Country\": \"Solomon Islands\",\r\n        \t\"CountryCode\": \"SB\"\r\n        },\r\n        {\r\n            \"ID\": 144,\r\n        \t\"Country\": \"Somalia\",\r\n        \t\"CountryCode\": \"SO\"\r\n        },\r\n        {\r\n            \"ID\": 3,\r\n        \t\"Country\": \"South Africa\",\r\n        \t\"CountryCode\": \"ZA\"\r\n        },\r\n        {\r\n            \"ID\": 190,\r\n        \t\"Country\": \"South Georgia And The South Sandwich Islands\",\r\n        \t\"CountryCode\": \"GS\"\r\n        },\r\n        {\r\n            \"ID\": 478,\r\n        \t\"Country\": \"South Sudan\",\r\n        \t\"CountryCode\": \"SS\"\r\n        },\r\n        {\r\n            \"ID\": 145,\r\n        \t\"Country\": \"Spain\",\r\n        \t\"CountryCode\": \"ES\"\r\n        },\r\n        {\r\n            \"ID\": 146,\r\n        \t\"Country\": \"Sri Lanka\",\r\n        \t\"CountryCode\": \"LK\"\r\n        },\r\n        {\r\n            \"ID\": 147,\r\n        \t\"Country\": \"Sudan (the)\",\r\n        \t\"CountryCode\": \"SD\"\r\n        \r\n        },\r\n        {\r\n            \"ID\": 223,\r\n        \t\"Country\": \"Suriname\",\r\n        \t\"CountryCode\": \"SR\"\r\n        },\r\n        {\r\n            \"ID\": 221,\r\n        \t\"Country\": \"Svalbard and Jan Mayen Islands\",\r\n        \t\"CountryCode\": \"SJ\"\r\n        },\r\n        {\r\n            \"ID\": 148,\r\n        \t\"Country\": \"Sweden\",\r\n        \t\"CountryCode\": \"SE\"\r\n        },\r\n        {\r\n            \"ID\": 149,\r\n        \t\"Country\": \"Switzerland\",\r\n        \t\"CountryCode\": \"CH\"\r\n        },\r\n        {\r\n            \"ID\": 446,\r\n        \t\"Country\": \"Syrian Arab Republic\",\r\n        \t\"CountryCode\": \"SY\"\r\n        },\r\n        {\r\n            \"ID\": 151,\r\n        \t\"Country\": \"Taiwan (Province of China)\",\r\n        \t\"CountryCode\": \"TW\"\r\n        },\r\n        {\r\n            \"ID\": 464,\r\n        \t\"Country\": \"Tajikistan\",\r\n        \t\"CountryCode\": \"TJ\"\r\n        },\r\n        {\r\n            \"ID\": 152,\r\n        \t\"Country\": \"Tanzania, United Republic Of\",\r\n        \t\"CountryCode\": \"TZ\"\r\n        },\r\n        {\r\n            \"ID\": 153,\r\n        \t\"Country\": \"Thailand\",\r\n        \t\"CountryCode\": \"TH\"\r\n        },\r\n        {\r\n            \"ID\": 458,\r\n        \t\"Country\": \"Timor-Leste, Democratic Republic of\",\r\n        \t\"CountryCode\": \"TL\"\r\n        },\r\n        {\r\n            \"ID\": 154,\r\n        \t\"Country\": \"Togo\",\r\n        \t\"CountryCode\": \"TG\"\r\n        },\r\n        {\r\n            \"ID\": 227,\r\n        \t\"Country\": \"Tokelau\",\r\n        \t\"CountryCode\": \"TK\"\r\n        },\r\n        {\r\n            \"ID\": 155,\r\n        \t\"Country\": \"Tonga\",\r\n        \t\"CountryCode\": \"TO\"\r\n        },\r\n        {\r\n            \"ID\": 229,\r\n        \t\"Country\": \"Trinidad and Tobago\",\r\n        \t\"CountryCode\": \"TT\"\r\n        },\r\n        {\r\n            \"ID\": 156,\r\n        \t\"Country\": \"Tunisia\",\r\n        \t\"CountryCode\": \"TN\"\r\n        },\r\n        {\r\n            \"ID\": 157,\r\n        \t\"Country\": \"Turkey\",\r\n        \t\"CountryCode\": \"TR\"\r\n        },\r\n        {\r\n            \"ID\": 158,\r\n        \t\"Country\": \"Turkmenistan\",\r\n        \t\"CountryCode\": \"TM\"\r\n        },\r\n        {\r\n            \"ID\": 67,\r\n        \t\"Country\": \"Turks and Caicos Islands (the)\",\r\n        \t\"CountryCode\": \"TC\"\r\n        },\r\n        {\r\n            \"ID\": 466,\r\n        \t\"Country\": \"Tuvalu\",\r\n        \t\"CountryCode\": \"TV\"\r\n        },\r\n        {\r\n            \"ID\": 231,\r\n        \t\"Country\": \"Uganda\",\r\n        \t\"CountryCode\": \"UG\"\r\n        },\r\n        {\r\n            \"ID\": 159,\r\n        \t\"Country\": \"Ukraine\",\r\n        \t\"CountryCode\": \"UA\"\r\n        },\r\n        {\r\n            \"ID\": 49,\r\n        \t\"Country\": \"United Arab Emirates (the)\",\r\n        \t\"CountryCode\": \"AE\"\r\n        },\r\n        {\r\n            \"ID\": 105,\r\n        \t\"Country\": \"United Kingdom of Great Britain and Northern Ireland (the)\",\r\n        \t\"CountryCode\": \"GB\"\r\n        },\r\n        {\r\n            \"ID\": 467,\r\n        \t\"Country\": \"United States Minor Outlying Islands\",\r\n        \t\"CountryCode\": \"UM\"\r\n        },\r\n        {\r\n            \"ID\": 134,\r\n        \t\"Country\": \"United States of America (the)\",\r\n        \t\"CountryCode\": \"US\"\r\n        },\r\n        {\r\n            \"ID\": 161,\r\n        \t\"Country\": \"Uruguay\",\r\n        \t\"CountryCode\": \"UY\"\r\n        },\r\n        {\r\n            \"ID\": 162,\r\n        \t\"Country\": \"Uzbekistan\",\r\n        \t\"CountryCode\": \"UZ\"\r\n        },\r\n        {\r\n            \"ID\": 235,\r\n        \t\"Country\": \"Vanuatu,Republic of\",\r\n        \t\"CountryCode\": \"VU\"\r\n        },\r\n        {\r\n            \"ID\": 448,\r\n        \t\"Country\": \"Venezuela (Bolivarian Republic Of)\",\r\n        \t\"CountryCode\": \"VE\"\r\n        },\r\n        {\r\n            \"ID\": 449,\r\n        \t\"Country\": \"Viet Nam\",\r\n        \t\"CountryCode\": \"VN\"\r\n        },\r\n        {\r\n            \"ID\": 453,\r\n        \t\"Country\": \"Virgin Islands (British)\",\r\n        \t\"CountryCode\": \"VG\"\r\n        },\r\n        {\r\n            \"ID\": 450,\r\n        \t\"Country\": \"Virgin Islands (U.S.)\",\r\n        \t\"CountryCode\": \"VI\"\r\n        },\r\n        {\r\n            \"ID\": 236,\r\n        \t\"Country\": \"Wallis and Futuna\",\r\n        \t\"CountryCode\": \"WF\"\r\n        },\r\n        {\r\n            \"ID\": 135,\r\n        \t\"Country\": \"Western Sahara\",\r\n        \t\"CountryCode\": \"EH\"\r\n        },\r\n        {\r\n            \"ID\": 377,\r\n        \t\"Country\": \"Western Samoa\",\r\n        \t\"CountryCode\": \"WS\"\r\n        },\r\n        {\r\n            \"ID\": 165,\r\n        \t\"Country\": \"Yemen\",\r\n        \t\"CountryCode\": \"YE\"\r\n        },\r\n        {\r\n            \"ID\": 167,\r\n        \t\"Country\": \"Zambia\",\r\n        \t\"CountryCode\": \"ZM\"\r\n        },\r\n        {\r\n            \"ID\": 168,\r\n        \t\"Country\": \"Zimbabwe\",\r\n        \t\"CountryCode\": \"ZW\"\r\n        }","operationId":"Common_Countries","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/common/Towns":{"get":{"tags":["Common"],"summary":"Retrieves towns given country, region and district","description":" JSON Response Parameters:\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td>ID</td><td>Integer</td><td>Town identifier</td></tr><tr><td>Town</td><td>String</td><td>Town name</td></tr></tbody></table><br></br><b>JSON Response sample:</b>\r\n \r\n     {\r\n         \"ID\": 109706,\r\n         \"Town\": \"Abu Dhabi\"\r\n     },\r\n     {\r\n         \"ID\": 109705,\r\n         \"Town\": \"Ajman\"\r\n     },\r\n     {\r\n         \"ID\": 109717,\r\n         \"Town\": \"Al Ain\"\r\n     },\r\n     {\r\n         \"ID\": 109720,\r\n         \"Town\": \"Dubai\"\r\n     },\r\n     {\r\n         \"ID\": 109715,\r\n         \"Town\": \"Fujairah\"\r\n     },\r\n     {\r\n         \"ID\": 109719,\r\n         \"Town\": \"Ras Al Khaimah\"\r\n     },\r\n     {\r\n         \"ID\": 109718,\r\n         \"Town\": \"Sharjah\"\r\n     },\r\n     {\r\n         \"ID\": 109709,\r\n         \"Town\": \"Um Al Quwain\"\r\n     }","operationId":"Common_Towns","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"idCountry","in":"query","required":true,"type":"integer","format":"int32"},{"name":"idCountryRegion","in":"query","required":true,"type":"integer","format":"int32"},{"name":"idDistrict","in":"query","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/common/Organizations":{"get":{"tags":["Common"],"summary":"Retrieves organizations","description":"<b>JSON Response Parameters:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <strong>ID</strong>\r\n      </td>\r\n      <td>Integer</td>\r\n      <td>Organization identifier</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>Name</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Organization name</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Common_Organizations","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/common/Registers":{"get":{"tags":["Common"],"summary":"Retrieves registers for given country and/or organization","description":"<b>JSON Request Parameters:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <strong>ID</strong>\r\n      </td>\r\n      <td>Integer</td>\r\n      <td>Register identifier</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>Name</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Register name</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Common_Registers","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"CountryID","in":"query","required":true,"type":"integer","format":"int32"},{"name":"IDOrganisation","in":"query","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/common/LegalForms":{"get":{"tags":["Common"],"summary":"Retrieves Legal forms for given country","description":"<b>JSON Response Parameters:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <strong>ID</strong>\r\n      </td>\r\n      <td>Integer</td>\r\n      <td>Legal form identifier</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>CountryID</strong>\r\n      </td>\r\n      <td>Integer</td>\r\n      <td>Country identifier</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>Name</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Legal form name</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Common_LegalForms","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"CountryID","in":"query","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/common/Categories":{"get":{"tags":["Common"],"summary":"Retrieves product categories","description":"<b>JSON Response Parameters:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <strong>ID</strong>\r\n      </td>\r\n      <td>Integer</td>\r\n      <td>Product category identifier</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>Name</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Product’s category name</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Common_Categories","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/common/Products":{"get":{"tags":["Common"],"summary":"Retrieves available products","description":" JSON Response Parameters:\r\n<table><thead><tr><th><b>FIELD NAME</b></th><th><b>TYPE</b></th><th><b>DESCRIPTION</b></th></tr></thead><tbody><tr><td><strong>ID</strong></td><td>Integer</td><td>Product identifier</td></tr><tr><td><strong>Name</strong></td><td>String</td><td>Product name</td></tr></tbody></table>","operationId":"Common_Products","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"CategoryId","in":"query","required":true,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/common/AvailableProductsByUID":{"post":{"tags":["Common"],"summary":"Check Available Products for UID","description":"  •\tRequires authentication\r\n  \r\n  •\tAppend parameters to URL: UID (string, required)\r\n  \r\n  •\tExample: https://apitest.cedar-rose.com/api/common/AvailableProductsByUID?UID=AEC48633090\r\n  \r\n<b>JSON Response sample:</b>\r\n\r\n    {    \r\n        \"UID\": \"AEC48633090\",\r\n        \"Availability\": [\r\n            {\r\n                \"ProductID\": 284,\r\n                \"ProductName\": \"Company Credit Report\",\r\n                \"SpeedsAvailableforOrder\": \"1,2,3,4\"\r\n            }\r\n        ]\r\n    }","operationId":"Common_AvailableProductByUID","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"UID","in":"query","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/common/Speeds":{"get":{"tags":["Common"],"summary":"Retrieves speeds","description":"<b>JSON Response Parameters:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <strong>ID</strong>\r\n      </td>\r\n      <td>Integer</td>\r\n      <td>Speed identifier</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>Name</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Speed name</td>\r\n    </tr>\r\n  </tbody>\r\n</table>\r\n<b>JSON Response sample:</b>\r\n             \r\n                 {    \r\n                     \"UID\": \"AEC48633090\",\r\n                     \"Availability\": [\r\n                         {\r\n                             \"ProductID\": 284,\r\n                             \"ProductName\": \"Company Credit Report\",\r\n                             \"SpeedsAvailableforOrder\": \"1,2,3,4\"\r\n                         }\r\n                     ]\r\n                 }","operationId":"Common_Speeds","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/common/OrderStatus":{"get":{"tags":["Common"],"summary":"Retrieves Order Status","description":"<b>JSON Response Parameters:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <strong>ID</strong>\r\n      </td>\r\n      <td>Integer</td>\r\n      <td>Identifier of the Order Status</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>Status</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Name of the Order Status</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>StatusDescription</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Description of the Order Status</td>\r\n    </tr>\r\n  </tbody>\r\n</table>\r\n<b>JSON Response sample:</b>\r\n            \r\n                [\r\n                    {\r\n                        \"ID\": 1,\r\n                        \"Status\": \"New\",\r\n                        \"StatusDescription\": \"A new order has been placed, typically in cases requiring a fresh investigation rather than real-time access (for Speeds other than download).\"\r\n                    },\r\n                    {\r\n                        \"ID\": 2,\r\n                        \"Status\": \"Assigned\",\r\n                        \"StatusDescription\": \"The order has been assigned to Cedar Rose, typically in cases requiring a fresh investigation rather than real-time access for (Speeds other than download).\"\r\n                    },\r\n                    {\r\n                        \"ID\": 5,\r\n                        \"Status\": \"Sent\",\r\n                        \"StatusDescription\": \"The record has been delivered as an API response.\"\r\n                    },\r\n                    {\r\n                        \"ID\": 16,\r\n                        \"Status\": \"Deleted\",\r\n                        \"StatusDescription\": \"The request has been deleted through client request.\"\r\n                    }\r\n                ]","operationId":"Common_OrderStatus","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/OrderStatus"}}}}}},"/api/Account/GetResetPasswordToken":{"get":{"tags":["Account"],"summary":"Get Reset Password Token","description":"<b>Request Parameters:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>Email</td>\r\n      <td>string</td>\r\n      <td>Email Address tor receive </td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Account_GetResetPasswordToken","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"model.email","in":"query","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/Account/ResetPassword":{"post":{"tags":["Account"],"summary":"ResetPassword","description":"<b>JSON Request Parameters:</b>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <strong>Username</strong>\r\n      </td>\r\n      <td>string</td>\r\n      <td>Username of the account</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>ResetToken</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Reset Token received to the email address via Get Reset Password Token endpoint</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <strong>newPassword</strong>\r\n      </td>\r\n      <td>String</td>\r\n      <td>New Password</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Account_ResetPassword","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"model","in":"body","required":true,"schema":{"$ref":"#/definitions/ResetPasswordBindingModel"}},{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/Client/GetClientBalances":{"post":{"tags":["Account"],"summary":"Retrieves client balances","description":"<b>JSON Response Paremeters:</b>\r\n<br></br>\r\n<table>\r\n  <thead>\r\n    <tr>\r\n      <th>\r\n        <b>FIELD NAME</b>\r\n      </th>\r\n      <th>\r\n        <b>TYPE</b>\r\n      </th>\r\n      <th>\r\n        <b>DESCRIPTION</b>\r\n      </th>\r\n    </tr>\r\n  </thead>\r\n  <tbody>\r\n    <tr>\r\n      <td>\r\n        <b>AccountBalance</b>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Current account balance</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <b>Discount</b>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Discount for client in percentage</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <b>DownloadBalance</b>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Free download balance</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <b>CurrencyID</b>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Client preferred currency identifier</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <b>CurrencySymbol</b>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Client preferred currency symbol</td>\r\n    </tr>\r\n    <tr>\r\n      <td>\r\n        <b>CurrencyName</b>\r\n      </td>\r\n      <td>String</td>\r\n      <td>Client preferred currency name</td>\r\n    </tr>\r\n  </tbody>\r\n</table>","operationId":"Client_GetClientBalances","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/Client/GetClientOrders":{"post":{"tags":["Account"],"summary":"Retrieves client’s placed order information","description":"<b>JSON Response Example:</b>\r\n            \r\n            {\r\n            \t\t\"Id\": 1413189,\r\n            \t\t\"CompanyName\": \"SAMPLE COMPANY NAME\",\r\n            \t\t\"ProductId\": 284,\r\n            \t\t\"Product\": \"Company Credit Report\",\r\n            \t\t\"StProductType\": \"Company\",\r\n            \t\t\"ProductType\": 1,\r\n            \t\t\"OrderDate\": \"30/03/2022\",\r\n            \t\t\"Invoiced\": false,\r\n            \t\t\"SpeedId\": 2,\r\n            \t\t\"Speed\": \"Download\",\r\n            \t\t\"StatusId\": 5,\r\n            \t\t\"Status\": \"Sent\",\r\n            \t\t\"IDATOM\": 13261149,\r\n            \t\t\"UserId\": 0,\r\n            \t\t\"InvoiceId\": null,\r\n            \t\t\"MonitorId\": 0,\r\n            \t\t\"Username\": \"admin.mohamed\",\r\n            \t\t\"UID\": \"EGC0344627\",\r\n            \t\t\"Page\": 1,\r\n            \t\t\"PageSize\": null\r\n            },\r\n            {\r\n            \t\t\"Id\": 1413188,\r\n            \t\t\"CompanyName\": \"SAMPLE COMPANY NAME\",\r\n            \t\t\"ProductId\": 284,\r\n            \t\t\"Product\": \"Company Credit Report\",\r\n            \t\t\"StProductType\": \"Company\",\r\n            \t\t\"ProductType\": 1,\r\n            \t\t\"OrderDate\": \"30/03/2022\",\r\n            \t\t\"Invoiced\": false,\r\n            \t\t\"SpeedId\": 2,\r\n            \t\t\"Speed\": \"Download\",\r\n            \t\t\"StatusId\": 5,\r\n            \t\t\"Status\": \"Sent\",\r\n            \t\t\"IDATOM\": 13261149,\r\n            \t\t\"UserId\": 0,\r\n            \t\t\"InvoiceId\": null,\r\n            \t\t\"MonitorId\": 0,\r\n            \t\t\"Username\": \"admin.mohamed\",\r\n            \t\t\"UID\": \"EGC0344627\",\r\n            \t\t\"Page\": 1,\r\n            \t\t\"PageSize\": null\r\n            },\r\n            {\r\n            \t\t\"Id\": 1413187,\r\n            \t\t\"CompanyName\": \"SAMPLE COMPANY NAME\",\r\n            \t\t\"ProductId\": 284,\r\n            \t\t\"Product\": \"Company Credit Report\",\r\n            \t\t\"StProductType\": \"Company\",\r\n            \t\t\"ProductType\": 1,\r\n            \t\t\"OrderDate\": \"30/03/2022\",\r\n            \t\t\"Invoiced\": false,\r\n            \t\t\"SpeedId\": 2,\r\n            \t\t\"Speed\": \"Download\",\r\n            \t\t\"StatusId\": 5,\r\n            \t\t\"Status\": \"Sent\",\r\n            \t\t\"IDATOM\": 13261149,\r\n            \t\t\"UserId\": 0,\r\n            \t\t\"InvoiceId\": null,\r\n            \t\t\"MonitorId\": 0,\r\n            \t\t\"Username\": \"admin.mohamed\",\r\n            \t\t\"UID\": \"EGC0344627\",\r\n            \t\t\"Page\": 1,\r\n            \t\t\"PageSize\": null\r\n            }","operationId":"Client_GetClientOrders","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"Bearer token","required":true,"type":"string","default":"mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ"}],"responses":{"400":{"description":"If the item is null"}}}},"/api/User/Login":{"post":{"tags":["Authentication"],"summary":"Login","operationId":"OAuth2TokenPost","consumes":["application/x-www-form-url-encoded"],"produces":["application/json"],"parameters":[{"name":"username","in":"formData","type":"string"},{"name":"password","in":"formData","type":"string"},{"name":"grant_type","in":"formData","type":"string"}],"responses":{"200":{"description":"Success","schema":{"type":"object","properties":{"access_token":{"type":"string"},"token_type":{"type":"string"},"userName":{"type":"string"},".issued":{"type":"string"},".expires":{"type":"string"}}}}}}}},"definitions":{"CustomerMetricsRequest":{"type":"object","properties":{"start_date":{"pattern":"^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[012])/\\d{4}$","type":"string"},"end_date":{"pattern":"^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[012])/\\d{4}$","type":"string"},"Username":{"type":"string"}}},"CompanySearchDTO":{"type":"object","properties":{"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int32","type":"integer"},"CountryID":{"format":"int32","type":"integer"},"Name":{"type":"string"},"LocalName":{"type":"string"},"RegisterNumber":{"type":"string"},"SearchTypeId":{"type":"string"},"FuzzySearch":{"format":"int32","type":"integer"},"Town":{"type":"string"},"POBox":{"type":"string"},"Street":{"type":"string"},"PostalCode":{"type":"string"}}},"CompanySearchResultDTO":{"type":"object","properties":{"Name":{"type":"string"},"NameLocal":{"type":"string"},"UID":{"type":"string"},"CommercialRegister":{"type":"string"},"SubjectCountryID":{"format":"int32","type":"integer"},"Country":{"type":"string"},"OfficeUnit":{"type":"string"},"Floor":{"type":"string"},"BuildingNo":{"type":"string"},"BuildingName":{"type":"string"},"PlotNo":{"type":"string"},"BlockNo":{"type":"string"},"StreetNumber":{"type":"string"},"Town":{"type":"string"},"POBox":{"type":"string"},"Street":{"type":"string"},"Area":{"type":"string"},"PostalCode":{"type":"string"},"AddressInfo":{"type":"string"},"UpdatedDate":{"type":"string"},"Status":{"type":"string"},"ReferenceNo":{"type":"string"},"TotalRecords":{"format":"int32","type":"integer"},"FuzzySearch":{"format":"int32","type":"integer"},"MatchingRate":{"format":"double","type":"number"}}},"CompanyAvailableSections":{"type":"object","properties":{"MainName":{"type":"string"},"DateUpdated":{"type":"string"},"IsAvailable":{"type":"boolean"}}},"ReceiveJsonReport":{"type":"object","properties":{"Orderid":{"format":"int32","type":"integer"},"StatusCode":{"type":"string"},"Message":{"type":"string"},"jsonData":{"type":"object"}}},"RecievePdfReport":{"type":"object","properties":{"orderid":{"format":"int32","type":"integer"},"statusCode":{"type":"string"},"message":{"type":"string"},"pdfData":{"type":"string"}}},"OrderDTO":{"type":"object","properties":{"SubjectName":{"type":"string"},"UID":{"type":"string"},"ProductId":{"format":"int32","type":"integer"},"SpeedId":{"format":"int32","type":"integer"},"SubjectCountryID":{"format":"int32","type":"integer"},"IDATOM":{"format":"int32","type":"integer"},"AdditionalInfo":{"type":"string"},"SubjectDetails":{"type":"string"},"TradingName":{"type":"string"},"CustomerReference":{"type":"string"},"AddMonitoring":{"format":"int32","type":"integer"},"PrivateFinancials":{"format":"int32","type":"integer"}}},"ResponseOrderDTO":{"type":"object","properties":{"Price":{"format":"double","type":"number"},"VAT":{"format":"double","type":"number"},"AutoRiskIndicator":{"type":"boolean"},"AutoRiskPrice":{"format":"double","type":"number"},"AutoRiskVAT":{"format":"double","type":"number"},"UID":{"type":"string"},"DueDate":{"type":"string"},"Content":{"type":"string"},"Currency":{"type":"string"},"OrderID":{"format":"int32","type":"integer"},"StatusID":{"format":"int32","type":"integer"}}},"ResponseOrderFiles":{"type":"object","properties":{"Files":{"type":"array","items":{"$ref":"#/definitions/OrderFiles"}},"Message":{"type":"string"}}},"OrderFiles":{"type":"object","properties":{"ResponseCode":{"format":"int32","type":"integer"},"FileName":{"type":"string"},"Message":{"type":"string"}}},"FileTypes":{"type":"object","properties":{"Company":{"type":"array","items":{"$ref":"#/definitions/PairDTO"}},"Person":{"type":"array","items":{"$ref":"#/definitions/PairDTO"}}}},"PairDTO":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"Name":{"type":"string"}}},"DueDateDTO":{"type":"object","properties":{"DueDate":{"type":"string"},"EditorDueDate":{"type":"string"},"ActualDate":{"type":"string"},"PenaltyDueDate":{"type":"string"}}},"OrderStatusDTO":{"type":"object","properties":{"Status":{"type":"string"},"OrderId":{"format":"int32","type":"integer"},"Content":{"type":"string"},"DueDate":{"type":"string"}}},"MonitoringOrderPDF":{"type":"object","properties":{"MonitoringUpdateID":{"format":"int32","type":"integer"},"statusCode":{"type":"string"},"message":{"type":"string"},"pdfData":{"type":"string"}}},"MonitoringOrderXML":{"type":"object","properties":{"MonitoringUpdateID":{"format":"int32","type":"integer"},"statusCode":{"type":"string"},"message":{"type":"string"},"xml":{"type":"string"}}},"MonitoringOrderJSON":{"type":"object","properties":{"MonitoringUpdateID":{"format":"int32","type":"integer"},"statusCode":{"type":"string"},"message":{"type":"string"},"jsonData":{"type":"string"}}},"KYBInputModel":{"type":"object","properties":{"searchId":{"format":"int32","type":"integer"},"countryId":{"format":"int32","type":"integer"},"name":{"type":"string"},"registerNumber":{"type":"string"},"city":{"type":"string"},"postalCode":{"type":"string"},"clientReference":{"type":"string"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"UID":{"type":"string"},"fuzzySearch":{"format":"int32","type":"integer"}}},"KYBSearch":{"type":"object","properties":{"UID":{"type":"string"},"searchId":{"format":"int32","type":"integer"},"nameWeight":{"format":"int32","type":"integer"},"regNoWeight":{"format":"int32","type":"integer"},"postalCodeWeight":{"format":"int32","type":"integer"},"cityWeight":{"format":"int32","type":"integer"},"minPercent":{"format":"int32","type":"integer"},"maxRecords":{"format":"int32","type":"integer"},"countryId":{"format":"int32","type":"integer"},"name":{"type":"string"},"registerNumber":{"type":"string"},"city":{"type":"string"},"postalCode":{"type":"string"},"clientReference":{"type":"string"},"userId":{"format":"int32","type":"integer"},"fuzzySearch":{"format":"int32","type":"integer"},"searchDate":{"type":"string"},"totalResults":{"format":"int32","type":"integer"},"successful":{"format":"int32","type":"integer"},"reduceBalance":{"format":"int32","type":"integer"},"price":{"format":"double","type":"number"},"vat":{"format":"double","type":"number"},"currency":{"type":"string"},"subscriptionStartDate":{"type":"string"},"subscriptionEndDate":{"type":"string"},"subscriptionMonthStartDate":{"type":"string"},"subscriptionMonthEndDate":{"type":"string"},"currencyRate":{"format":"int32","type":"integer"},"searchResult":{"type":"array","items":{"$ref":"#/definitions/KYBSearchResult"}},"crComply":{"type":"array","items":{"$ref":"#/definitions/CRComply"}}}},"KYBSearchResult":{"type":"object","properties":{"UID":{"type":"string"},"name":{"type":"string"},"tradingName":{"type":"string"},"registerNumber":{"type":"string"},"city":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"status":{"type":"string"},"legalForm":{"type":"string"},"issueDate":{"type":"string"},"expiryDate":{"type":"string"},"score":{"format":"double","type":"number"},"display":{"format":"int32","type":"integer"},"reduceBalance":{"format":"int32","type":"integer"},"price":{"format":"double","type":"number"},"vat":{"format":"double","type":"number"},"currency":{"type":"string"},"subscriptionStartDate":{"type":"string"},"subscriptionEndDate":{"type":"string"},"subscriptionMonthStartDate":{"type":"string"},"subscriptionMonthEndDate":{"type":"string"},"currencyRate":{"format":"int32","type":"integer"},"crComplyHits":{"format":"int32","type":"integer"},"updatedDate":{"type":"string"},"fuzzySearch":{"format":"int32","type":"integer"}}},"CRComply":{"type":"object","properties":{"UID":{"type":"string"},"name":{"type":"string"},"crComplyHits":{"format":"int32","type":"integer"},"orderId":{"format":"int32","type":"integer"},"complianceReduceBalance":{"type":"boolean"},"price":{"format":"double","type":"number"},"vat":{"format":"double","type":"number"},"currency":{"type":"string"},"currencyRate":{"format":"int32","type":"integer"},"crComplyMonitor":{"format":"int32","type":"integer"}}},"KYBSearchAllResults":{"type":"object","properties":{"searchId":{"format":"int32","type":"integer"},"country":{"type":"string"},"name":{"type":"string"},"registerNumber":{"type":"string"},"clientReference":{"type":"string"},"userId":{"format":"int32","type":"integer"},"searchDate":{"type":"string"},"totalResults":{"format":"int32","type":"integer"},"displayedUIDs":{"type":"string"}}},"ClientBlance":{"type":"object","properties":{"subscriptionStartDate":{"type":"string","readOnly":true},"subscriptionEndDate":{"type":"string","readOnly":true},"kybTotalBalance":{"format":"int32","type":"integer"},"currentMonthStartDate":{"type":"string","readOnly":true},"currentMonthEndDate":{"type":"string","readOnly":true},"currentMonthBalance":{"format":"int32","type":"integer"},"crComplyBalance":{"format":"int32","type":"integer"}}},"KYBSettings":{"type":"object","properties":{"nameWeight":{"format":"int32","type":"integer"},"regNoWeight":{"format":"int32","type":"integer"},"minPercent":{"format":"int32","type":"integer"},"maxRecords":{"format":"int32","type":"integer"},"postalCodeWeight":{"format":"int32","type":"integer"},"cityWeight":{"format":"int32","type":"integer"},"crComplyFuzziness":{"format":"int32","type":"integer"},"crComplyMonitor":{"format":"int32","type":"integer"},"crComplySources":{"type":"array","items":{"$ref":"#/definitions/CRComplySources"}}}},"CRComplySources":{"type":"object","properties":{"xmlValue":{"type":"string"}}},"PSRequestDTO":{"type":"object","properties":{"FirstName":{"type":"string"},"MiddleName":{"type":"string"},"LastName":{"type":"string"},"UID":{"type":"string"},"YearOfbirth":{"format":"int32","type":"integer"},"MonthOfBirth":{"format":"int32","type":"integer"},"DayOfBirth":{"format":"int32","type":"integer"},"isFormer":{"type":"boolean"},"isExact":{"type":"boolean"},"LanguageId":{"format":"int32","type":"integer"},"IdentityNumber":{"type":"string"},"NationalityCountryId":{"format":"int32","type":"integer"},"ReturnMessage":{"type":"string"}}},"EIDVRequestDTO":{"type":"object","properties":{"FirstName":{"type":"string"},"MiddleName1":{"type":"string"},"MiddleName2":{"type":"string"},"MiddleName3":{"type":"string"},"LastName":{"type":"string"},"NationalId":{"type":"string"},"Birthdate":{"type":"string"},"CivilRegNo":{"type":"string"},"RegTown":{"format":"int32","type":"integer"},"CountryId":{"format":"int32","type":"integer"},"advanceSearch":{"type":"boolean"},"MiddleName":{"type":"string"},"BirthDateDay":{"format":"int32","type":"integer"},"Lang":{"format":"int32","type":"integer"},"fullName":{"type":"string"},"birthDate":{"type":"string"},"surname":{"type":"string"},"name":{"type":"string"},"patronymic":{"type":"string"},"pNumber":{"type":"string"},"iNumber":{"type":"string"},"Phone":{"type":"string"},"Forename":{"type":"string"},"Surname":{"type":"string"},"DOB":{"type":"string"},"Request":{"type":"array","items":{"$ref":"#/definitions/EIDVTRWhereDTO"}}}},"EIDVTRWhereDTO":{"type":"object","properties":{"Name":{"type":"string"},"Value":{"type":"string"},"Primary":{"type":"boolean"},"Like":{"type":"boolean"},"Response":{"type":"string"}}},"EIDVFlexibleResponseDTO":{"type":"object","properties":{"Name":{"type":"string"},"Evaluation":{"type":"string"}}},"EIDVDTO":{"type":"object","properties":{"config":{"$ref":"#/definitions/Config"},"Propertyfields":{"$ref":"#/definitions/Propertyfields"}}},"Config":{"type":"object","properties":{"cascade":{"format":"int32","type":"integer"},"cascadetype":{"format":"int32","type":"integer"},"source":{"type":"string"}}},"Propertyfields":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"middlename1":{"type":"string"},"fullname":{"type":"string"},"dob":{"type":"string"},"building":{"type":"string"},"officeunit":{"type":"string"},"street":{"type":"string"},"fulladdress":{"type":"string"},"city":{"type":"string"},"district":{"type":"string"},"postalcode":{"type":"string"},"countrycode":{"type":"string"},"nationalid":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"gender":{"type":"string"},"state":{"type":"string"},"requestId":{"type":"string"}}},"Fieldvalidation":{"type":"object","properties":{"cascade":{"format":"int32","type":"integer"},"countryCode":{"type":"string"},"source":{"type":"string"}}},"InterviewOutcomeDTO":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"Name":{"type":"string"},"Description":{"type":"string"}}},"InvestigationDataPointsDTO":{"type":"object","properties":{"CategoryId":{"format":"int32","type":"integer"},"CategoryName":{"type":"string"},"DataPointId":{"format":"int32","type":"integer"},"DataPointName":{"type":"string"}}},"CountryDTO":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"Country":{"type":"string"},"CountryCode":{"type":"string"}}},"TownDTO":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"Town":{"type":"string"}}},"LegalFormsDTO":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"CountryID":{"format":"int32","type":"integer"},"Description":{"type":"string"}}},"AvailableProductsDTO":{"type":"object","properties":{"UID":{"type":"string"},"Availability":{"type":"array","items":{"$ref":"#/definitions/Availability"}}}},"Availability":{"type":"object","properties":{"ProductID":{"format":"int32","type":"integer"},"ProductName":{"type":"string"},"SpeedsAvailableforOrder":{"type":"string"}}},"OrderStatus":{"type":"object","properties":{"ID":{"format":"int32","type":"integer"},"Status":{"type":"string"},"StatusDescription":{"type":"string"}}},"RegisterExternalBindingModel":{"required":["Email"],"type":"object","properties":{"Email":{"type":"string"}}},"ResetPasswordBindingModel":{"required":["UserName","ResetToken","NewPassword"],"type":"object","properties":{"UserName":{"type":"string"},"ResetToken":{"type":"string"},"NewPassword":{"maxLength":100,"minLength":6,"type":"string"}}},"IdentityResult":{"type":"object","properties":{"Succeeded":{"type":"boolean","readOnly":true},"Errors":{"type":"array","items":{"type":"string"},"readOnly":true}}},"ClientBalanceResponseDTO":{"type":"object","properties":{"AccountBalance":{"type":"string"},"Discount":{"type":"string"},"DownloadBalance":{"type":"string"},"CurrencyID":{"type":"string"},"CurrencySymbol":{"type":"string"},"CurrencyName":{"type":"string"}}},"MyOrder":{"type":"object","properties":{"Id":{"format":"int32","type":"integer"},"CompanyName":{"type":"string"},"ProductId":{"format":"int32","type":"integer"},"Product":{"type":"string"},"StProductType":{"type":"string"},"ProductType":{"format":"int32","type":"integer"},"OrderDate":{"type":"string"},"Invoiced":{"type":"boolean"},"SpeedId":{"format":"int32","type":"integer"},"Speed":{"type":"string"},"StatusId":{"format":"int32","type":"integer"},"Status":{"type":"string"},"IDATOM":{"format":"int32","type":"integer"},"UserId":{"format":"int32","type":"integer"},"InvoiceId":{"format":"int32","type":"integer"},"MonitorId":{"format":"int32","type":"integer"},"Username":{"type":"string"},"UID":{"type":"string"},"Page":{"format":"int32","type":"integer"},"PageSize":{"format":"int64","type":"integer"}}}},"securityDefinitions":{"Bearer":{"type":"apiKey","description":"Filling bearer token here","name":"Authorization","in":"header"}},"tags":[{"name":"Introduction","description":"**Restful Web Services**\r\n\r\nCedar Rose implements RESTful web services over HTTPS, with a JSON response, and thus, we can integrate with any web-based solution.\r\n\r\n**General RESTful Response Guide**\r\n\r\n• HTTP Code 200: Success\r\n\r\n• HTTP Code 400: Business Error\r\n\r\n• HTTP Code 500: Technical Error\r\n\r\nJSON property names are case sensitive. Therefore, if the web service expects \"Name\", then \"name\" wouldn't be valid. See example:\r\n\r\n{Name: \"cedar rose\"} // valid\r\n\r\n{name: \"cedar rose\"} // not valid\r\n\r\nJSON property string values are NOT case sensitive. See example:\r\n\r\n{Name:\"cedar rose\"} is the same as {Name: \"Cedar Rose\"}\r\n\r\n**Responses & Errors**\r\n\r\nWe use standard HTTP status codes to indicate the success or failure of a request to our API.\r\n\r\nSuccessful requests to our API will have a 200 HTTP status code; the “status” and “content” key-value pairs will detail the status message and the content of the response.\r\n\r\n{ \"status\": \"success\", \"content\": \"... API response goes here ...\" }\r\n\r\nUnsuccessful requests to our API will have a non-200 HTTP status code and will contain \"code\", \"message\" and \"status\" fields. The \"message\" field will contain any further information about the unsuccessful request.\r\n\r\n{ \"code\": 500, \"message\": \"Internal Server Error\", \"status\": \"failure\" }\r\n\r\nNote that the message may have more details about the error.\r\n"},{"name":"Authentication","description":"For authentication, a username and password are required; if the client hasn’t been provided with one, please contact Cedar Rose.\r\n\r\nDuring the login request, and in addition to the username and password, the request body should contain \"grant_type=password\".\r\n\r\nAfter a successful login, the system will respond with an \"access_token\" which should be used in all other requests henceforth in the authorization header as Bearer token authentication.\r\n\r\n**Sandbox API:** https://apitest.cedar-rose.com/api/User/Login\r\n\r\n**Production API:** https://api.cedar-rose.com/api/User/Login\r\n\r\n**Login Request**\r\n\r\n• Method: POST\r\n\r\n• Header: Content-Type: application/x-www-form-urlencoded\r\n\r\n• Request Body (example):\r\n\r\n  • grant_type=password\r\n\r\n  • &username= `username`\r\n\r\n  • &password= `password`\r\n\r\n**Login Response (example)**\r\n\r\n• .expires: Mon, 15 Jun 22:00\r\n\r\n• .issued: Mon, 15 Jun 13:00\r\n\r\n• access_token: BfZPnuyPeZn8e-I…\r\n\r\n• token_type: bearer\r\n\r\n• userName: `username`\r\n\r\n"},{"name":"Error Messages and Codes","description":"**1. `200` - OK**\r\n\r\nThe request was successful, and the response contains the expected data.\r\n\r\n• Requested Data Not Available:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"No Result Found\"\r\n\r\n• Subscription Period Ended:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"Subscription expired\"\r\n\r\n• Balance Limit Reached for the Month:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"Monthly balance finished\"\r\n\r\n• Search Query Returned Excessive Results:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"Too many Results. Please refine your search.\"\r\n\r\n• Record Associated with a Different Client:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"The record belongs to another client.\"\r\n\r\n**2. `203` - Non-Authoritative Information**\r\n\r\nThe request was successful, but the returned information may be from a different source than the original server.\r\n\r\n**3. `400` - Bad Request**\r\n\r\nErrors that occur due to business logic not being satisfied or validated when making a request. These include:\r\n\r\n• Across all endpoints where CountryId is required:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir; \"CountryId is required\"\r\n\r\n• Across report endpoints when OrderId is not found:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"OrderId not found.\"\r\n\r\n• When placing orders:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir; \"UID is required for Download speed\"\r\n\r\n• Login:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir; \"Username and/or password invalid\"\r\n\r\n• In Company/Search:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir; \"Fuzzy Search Not Available for this Country\"\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir; \"Name is required\"\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir; \"UID is required for SearchTypeID 5\"\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir; \"More than one result for UID \"\r\n\r\n• When required parameters like OrderId, ProductId, etc., are 0:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir; \"Parameter Value Invalid\"\r\n\r\n• Error encountered in **Files/OrderFileUpload**\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"FileId not found.\"\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"File cannot be deleted. Order is already sent.\"\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"Exceeded File Upload Limit (Max 5).\"\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"File Upload not allowed.\"\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"FileTypeID {0} is not applicable to Person/Company Order.\"\r\n\r\n**4. `401` - Unauthorized**\r\n\r\nThe authorization was denied for the specific request.\r\n\r\n**5. `403` - Forbidden**\r\n\r\nThe user attempted to access order details that do not belong to their account.\r\n\r\n**6. `417` - Expectation Failed**\r\n\r\nThe server cannot meet the requirements of the Expect request-header field.\r\n\r\n**7. `500` - Internal Server Error**\r\n\r\n An error indicating that something went wrong on the server and it needs investigating. The message will be \"Something went wrong!\"\r\n\r\n• Request Processing Delayed or Server Took Too Long to Respond:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"The operation has timed out\"\r\n\r\n• Operation Timed Out or Request Aborted:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"The request was aborted: The operation has timed out.\"\r\n\r\n• Order Placement Failure Due to Processing Issues:\r\n\r\n &#160;&#160;&#160;&#160;&#160;&cir;  \"Failed to place order.\"\r\n\r\n**8. `503` - Service Unavailable**\r\n\r\nThe authorization was denied for the specific request.\r\n\r\n For **RequestOrder** following are the negative StatusIDs\r\n\r\n<table>\r\n<thead>\r\n<tr>\r\n<th><b>StatusID</b></th>\r\n<th><b>MESSAGE</b></th>\r\n</tr>\r\n</thead>\r\n<tbody>\r\n<tr><td><strong>-1</strong></td><td>This UID/Subject was not found</td></tr>\r\n<tr><td><strong>-2</strong></td><td>This UID/Subject is not available</td></tr>\r\n<tr><td><strong>-3</strong></td><td>This speed is not available for this product</td></tr>\r\n<tr><td><strong>-4</strong></td><td>Credit Limit exceeded</td></tr>\r\n</tbody>\r\n</table>\r\n"},{"name":"Orders API","description":"Orders API lets you search for a company/organization and place Credit Report Orders that can be retrieved when they are ready in either XML,JSON or PDF formats."},{"name":"CR KYB API","description":"Thorough and reliable due diligence or Know Your Business (KYB) processes can often be lengthy and expensive, depending on multiple information sources and manual, paper-based interactions.\r\n\r\nCedar Rose KYB provides a solution to this problem, - fast-tracking due diligence procedures while at the same time ensuring high quality, reliable and up-to-date information verifying the legitimacy and registered status of any company you do business with."},{"name":"CR IDentify API","description":"CR Identify verifies the identity of your customers, suppliers or hires instantly.\r\nCR Identify collects data from governments, business registers, mobile networks, utility companies and more to form a powerful, global database that delivers reports and eIDV fast, -so that you can make smart and informed business decisions quickly.\r\nTYPE OF SOURCES\r\n*Telco: Data from Telecommunication companies\r\n\r\nGovernment: Data from Corporate Registers Records, Voters Lists, etc.\r\n\r\nConsumer: Public Announcements, Utility Companies, Mortgages, University Records, etc.\r\n\r\nCredit: Data collected from various financial institutions and Credit Bureau."},{"name":"CR Comply API","description":"CR Comply is an automated all-in-one compliance screening tool to assess third-party risk levels and accelerate the customer on-boarding process. Uncover sanctioned entities, in PEPs (Politically Exposed Persons) and adverse media on companies and people.\r\n\r\nThe CR Comply API enables you to integrate your systems with our services to automate many of the functions available through the web user interface. Our API follows the REST convention and accepts and returns JSON data.\r\n\r\nAll API requests must be made over HTTPS; calls made over plain HTTP will fail. API requests without authentication will also fail - see the Authentication section for information on correctly authenticating calls to the CR Comply API.\r\n"},{"name":"Placing FI Orders","description":"1. `api/Order/RequestOrder`\r\n   Fresh Investigations are placed when using speed 1, 3, or 4.\r\n   Content will be empty.\r\n   The order will be available by EOD on DueDate (Due date can be found in the response).\r\n\r\n2. `api/Order/CheckOrderStatus?OrderID={ORDER_ID}`\r\n   If the order is not ready, the response will show \"Status\": \"0\" and the content will be empty.\r\n   If the order is ready, the response will show \"Status\": \"1\" and the content will be the report content in XML format.\r\n\r\n3. `api/company/GetJsonForOrder?OrderId={ORDER_ID}`\r\n   Retrieves the report in JSON format.\r\n\r\n4. `api/Company/ReceivePdfReport?OrderID={ORDER_ID}`\r\n   Retrieves the report as Base64 encoded PDF data.\r\n\r\nAdditionally, for ordering \"Fresh Investigation\" reports, you have two options:\r\n\r\n- Use our webhook, which must be configured beforehand. The webhook sends a request notifying about the Order Status along with an XML report of the placed order. This request is sent to an endpoint configured on your side to receive this notification from our system. The attached documentation provides more details about the flow and usage.\r\n\r\n- Or, place fresh investigations normally as outlined above. We would emulate the fresh investigation flow by manually pushing it through the system. In this case, we need to organize a testing session to perform the necessary manual actions for the Fresh Investigation flow. Note that, for the sandbox, we will not be updating any company information, but we will need to perform manual actions to push the Fresh Investigation order through the workflow.\r\n"},{"name":"Webhook","description":"**Introduction**\r\n\r\nFresh Investigation Order Webhook is an automated request sent to a pre-configured Client Endpoint notifying about the Order Status and the XML report for a specific OrderId.\r\n\r\n**Webhook Overview**\r\n\r\n1. Login to the API to obtain the `access_token`.\r\n2. Search for a company.\r\n3. Use “RequestOrder” endpoint to place an order using subject name, SubjectCountryId and SpeedId (1 -Regular, 3- Urgent, 4-24H).\r\n4. Webhook Configuration:\r\n   a. If a webhook is configured, Cedar Rose will send a request to your configured ClientUrl.\r\n   b. If not, then, the endpoint “CheckOrderStatus” can be used to check the order status and obtain the XML.\r\n5. The webhook will trigger a request to the configured ClientUrl with the relevant order details and the XML report of the order placed.\r\n6. When the webhook receives a response from the configured ClientUrl – the system will only check the response code and not check any response content that is received.\r\n   a. If it’s a 200 (OK) the webhook will not trigger another request to that specific order.\r\n   b. If it’s anything other than response code (500, 400, etc.) – the webhook will keep sending a request until it reaches a value (MaximumAttempts – default value is 999) – at that point, the webhook will stop sending requests altogether for that orderId.\r\n7. Once the order status is received, you can download the order in any format using the corresponding API endpoint (i.e. PDF using ReceivePdfReport, JSON using ReceiveJsonReport).\r\nWebhook Configuration\r\nTo opt-in for Fresh Investigation OrderStatus webhook, contact your account manager requesting access.\r\n\r\n**Sample Webhook Request**\r\nFollowing is a sample webhook request that will be received by the configured Client Endpoint. The format is JSON.\r\n\r\n{\r\n\r\n  \"Status\": 5,\r\n\r\n  \"OrderId\": 1471964,\r\n\r\n  \"Content\": \"<root></root>\"\r\n\r\n}\r\n\r\nPlease note: The system will not read the Response Received from the Configured Client Endpoint. The system will only check for the response HTTP Status code and proceed with the flow as mentioned above.\r\n"}]}