{"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"],"operationId":"Reporting_CustomerMetrics","consumes":["application/json","text/json","application/x-www-form-urlencoded"],"produces":["application/json","text/json"],"parameters":[{"name":"customerMetricsRequest","in":"body","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":"OK","schema":{"type":"object"}}}}},"/api/Company/Search":{"post":{"tags":["Orders API"],"summary":"Search by country and name and/or registers","description":" JSON Request Parameters:\r\n
FIELD NAMETYPEDESCRIPTION
SearchTypeId (required)stringDefines search input, 0 = name , 4 = register number
CountryID (required)IntegerCountry filter.
Page (required)IntegerNumber of pages to return. Default value 1
PageSize (required)IntegerNumber of results in each page. Default value 10
NameStringEnglish name, Arabic name, or register number. Can contain % in the start, middle, and/or end. (required if SearchTypeId = 1)
TownStringTown of company's primary address.
StreetStringStreet of company's primary address.
PostalCodeStringPostal code of company's primary address.
POBoxStringCompany's POBox.
RegisterNumberStringCompany's registration number. Used when SearchTypeId = 4
FuzzySearchbitBy default, FuzzySearch =1 for all searches. Specify FuzzySearch = 0 to disable Fuzzy Search and retrieve exact match.


JSON Response Parameters:

FIELD NAMETYPEDESCRIPTION
NameStringCompany's name
NameLocalStringName in local script
UIDStringCountry code + Cedar Rose reference number
CommercialRegisterStringCompany's registration number
SubjectCountryIdIntegerCountry identifier
CountryStringCountry name
TownStringTown name of company's primary address
POBoxStringPOBox of company's primary address
StreetStringStreet name of company's primary address
AreaStringArea name of company's primary address
PostalCodeStringPostal code of company's primary address
AddressInfoStringAdditional address information
UpdatedDateStringDate when company information was last updated. Format yyyy-MM-dd
StatusStringActive/Inactive status of company. NULL if status not available
ReferenceNoStringCompany's reference number
fuzzySearchbit1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn't belong to Fuzzy Search performed
MatchingRatedecimalFuzzy Search score of Company Name that ranges between values (0.0 – 1.0) which is based on the input Company Name provided
JSON Request sample:\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 JSON Response sample:\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 entity","description":"JSON Response sample:\r\n \r\n {\r\n \t\"MainName\": \"Shareholders\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Premises\",\r\n \t\"DateUpdated\": \"09/07/2015\",\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Activities\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Managers\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Legal Form\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Financials\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Capital\",\r\n \t\"DateUpdated\": \"17/09/2018\",\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Employees\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Adverse Media\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Bankruptcies\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Addresses\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Career\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Directorship\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Criminal Records\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Person Comment\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Default Cases\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Internet Portals\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Legal Procedures\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Gazette\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Reputation\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Politically Exposed\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Publications And Media\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Certifications\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Country Disclaimer\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Clients\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Brands\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Commerce\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Logos\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Production Capacity\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Registers\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Short Name\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Credit Rating\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Date Registered\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Affiliates\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Groups\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Global Compliance Check\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Date of Birth\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Gender\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Deceased Date\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Country Overview\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Trading Names\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Name\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Country Disclaimer\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": true\r\n },\r\n {\r\n \t\"MainName\": \"Former Names\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"History\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Status\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Source and Intelligence\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"CR Score\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Shareholders Shares\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"TRI_Stars\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n },\r\n {\r\n \t\"MainName\": \"Investments\",\r\n \t\"DateUpdated\": null,\r\n \t\"IsAvailable\": false\r\n }","operationId":"Company_AvailableSectionsByUID","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/Company/ReceiveJsonReport":{"get":{"tags":["Orders API"],"summary":"Receive report in JSON format","description":"JSON Response sample:\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":"JSON Response sample:\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"],"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":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ResponseOrderDTO"}}}}}},"/api/order/Files/OrderFileUpload":{"post":{"tags":["Orders API"],"summary":"OrderFileUpload","description":" JSON Request Parameters:\r\n
FIELD NAMETYPEDESCRIPTION
OrderIdIntegerOrder Identifier
FileTypeIdIntegerFile Type identifier (refer Get File Types)
File.doc,.docx,.pdf,.jpg,.jpeg,.pngFile to be uploaded associated with the order


JSON Response sample:\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":"JSON Response sample:\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":"JSON Response sample:\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":"Request Parameters:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n ProductId\r\n StringProduct identifier
\r\n SpeedId\r\n StringSpeed Identifier
\r\n SubjectCountryId\r\n StringCountry Identifier
\r\n

\r\nResponse Parameters:\r\n

\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n amount\r\n DecimalCost of order
","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":"Request Parameters:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n ProductId\r\n StringProduct identifier
\r\n SpeedId\r\n StringSpeed Identifier
\r\n SubjectCountryId\r\n StringLast name
\r\n UID\r\n StringCountry Identifier
\r\n

\r\nResponse Parameters:\r\n

\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n DueDate\r\n StringDue date for report delivery. Date format dd/mm/yyyy
","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":"JSON Response Parameters:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n Status\r\n Integer
\r\n Content\r\n StringXML of the report
\r\n DueDate\r\n StringDue Date of the Order
","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"],"operationId":"Monitoring_GetMonitoringOrderPDF","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"MonitoringUpdateID","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":{"$ref":"#/definitions/MonitoringOrderPDF"}}}}},"/api/monitoring/GetMonitoringOrderXml":{"get":{"tags":["Monitoring"],"operationId":"Monitoring_GetMonitoringOrderXML","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"MonitoringUpdateID","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":{"$ref":"#/definitions/MonitoringOrderXML"}}}}},"/api/monitoring/GetMonitoringOrderJson":{"get":{"tags":["Monitoring"],"operationId":"Monitoring_GetMonitoringOrderJSON","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"MonitoringUpdateID","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":{"$ref":"#/definitions/MonitoringOrderJSON"}}}}},"/api/kyb/search":{"post":{"tags":["CR KYB API"],"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":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/KYBSearch"}}}}}},"/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
FIELD NAMETYPEDESCRIPTION
UIDStringEntity Unique identifier
nameStringEntity name
tradingNameStringTrade Name matching the Search Input name
registerNumberStringEntity registration number
cityStringCity of entity’s primary address
addressStringAdditional information for entity’s primary address
postalCodeStringPostal code of entity’s primary address
statusStringEntity’s status
legalFormStringLegal Type of the Company
scoreStringEntity’s score
displayInteger1 (result displayed) OR 0 (result not displayed)
IssueDateStringRegister’s Issue Date
ExpiryDateStringRegister’s Expiry Date
fuzzySearchbit1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn’t belong to Fuzzy Search performed


JSON Response sample:\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
FIELD NAMETYPEDESCRIPTION
UIDStringEntity Unique identifier
nameStringEntity name
tradingNameStringTrade Name matching the Search Input name
registerNumberStringEntity registration number
cityStringCity of entity’s primary address
addressStringAdditional information for entity’s primary address
postalCodeStringPostal code of entity’s primary address
statusStringEntity’s status
legalFormStringLegal Type of the Company
scoreStringEntity’s score
displayInteger1 (result displayed) OR 0 (result not displayed)
IssueDateStringRegister’s Issue Date
ExpiryDateStringRegister’s Expiry Date
fuzzySearchbit1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn’t belong to Fuzzy Search performed


JSON Response sample:\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

JSON Response sample:\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":"JSON Response sample:\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":"JSON Response sample:\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
FIELD NAMETYPEDESCRIPTION
nameWeightIntegerWeight for name as per client’s settings
regNoWeightIntegerWeight for name as per client’s settings
minPercentIntegerMinimum threshold for matching and fetching results
maxRecordsIntegerMaximum number of records per response
postalCodeWeightIntegerWeight for name as per client’s settings
cityWeightIntegerWeight for city as per client’s settings
crComplyFuzzinessIntegerDefines the fuzziness for CR Comply searches.
crComplyMonitorBooleanDefines if search will be monitored.
crComplySourcesArrayDefines CR Comply filters.


JSON Response sample:\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
FIELD NAMETYPEDESCRIPTION
nameWeightIntegerWeight for name as per client’s settings
regNoWeightIntegerWeight for name as per client’s settings
minPercentIntegerMinimum threshold for matching and fetching results
maxRecordsIntegerMaximum number of records per response
postalCodeWeightIntegerWeight for name as per client’s settings
cityWeightIntegerWeight for city as per client’s settings
crComplyFuzzinessIntegerDefines the fuzziness for CR Comply searches.
crComplyMonitorBooleanDefines if search will be monitored.
crComplySourcesArrayDefines CR Comply filters.


JSON Request sample:\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

JSON Response sample:\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
FIELD NAMETYPEDESCRIPTION
searchIdIntegerKYB Search identifier
nameStringEntity name
UIDStringEntity Unique identifier
registerNumberStringEntity registration number


JSON Request sample:\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":"JSON Response sample:\r\n\r\n \r\n \r\n SAMPLE COMPANY PRIVATE LIMITED\r\n 30 Apr 2021 01:17 PM\r\n 0%\r\n Company\r\n \r\n Sanctions\r\n Warnings\r\n \r\n 0\r\n \r\n \r\n","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"],"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":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/PSRequestDTO"}}}}}},"/api/Person/FlexibleEIDV":{"post":{"tags":["CR IDentify API"],"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":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EIDVFlexibleResponseDTO"}}}}}},"/api/EIDV/EIDVIdentifySearch":{"post":{"tags":["CR IDentify API"],"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":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/EIDV/fieldvalidation":{"post":{"tags":["CR IDentify API"],"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":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/compliance/searches":{"get":{"tags":["CR Comply API"],"summary":"Get a list of your previous searches","description":"URL PARAMETERS:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n DESCRIPTION\r\n
assignee_idShow searches assigned to a specific user
searcher_idShow searches performed by a specific user
risk_levelShow 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
submitted_termShow searches where the term is unsanitised and includes symbols and punctuation marks
match_statusShow 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
search_termSearches that match search term (3 characters min)
created_at_fromSearches made from date (yyyy-mm-dd)
created_at_toSearches made to date (yyyy-mm-dd)
tagsSearches registered against given tags, comma separated represented as 'name:value', eg 'internal_ref:1234' or internal_ref:1234,t_type:custom'
client_refShow searches with the same client reference
monitoredSearches with a specific monitored status, eg. suspended for suspended searches, un-suspended for actively monitored searches and false for searches which are not monitored
\r\n

\r\nSorting parameters:\r\n

\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n DESCRIPTION\r\n
sort_byOne of 'id', 'created_at', 'updated_at', 'assignee_id', 'searcher_id'
sort_dirOne of 'ASC, 'DESC'
\r\n

\r\nPagination parameters:\r\n

\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n DESCRIPTION\r\n
per_pageNumber of searches to return per \"page\" (integer, max 100)
pageWhich page to fetch (integer)
","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":"URL PARAMETERS:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
search_term (required)String/ObjectA string representing the name of the entity or an Object
client_ref (optional, max 255 characters))StringYour reference for this person/entity for which you are searching. Used for tracking searches and auto-whitelisting recurring results
search_profile (optional)StringThe 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
fuzziness (optional)Float(0.0 to 1.0)Determines how closely the returned results must match the supplied name. Overridden by exact_match
offset (optional)Integer(default 0)Match results from the database, starting from the offset value
limit (optional)Integer(default 100, Max 100)Match results from the database, taking up to this many matches each search
filters (optional)ObjectSpecify filters within the search to narrow down the results. These are specified below, and are all optional
tags (optional)ObjectObject of name => value pairs (name must be string), must be existing tags
filters (optional)ObjectSpecify filters within the search to narrow down the results. These are specified below, and are all optional
country_codes (optional)Array of ISO 3166-1 alpha-2 Results are filtered by the entity nationality or country of residence
exact_match (optional)BooleanExact match disables all standard and optional matching behaviours 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviours (standard and optional)
\r\n

\r\nFilters in searches:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
typesArray of stringsOne or more of:
\r\n •\tsanction
\r\n •\twarning
\r\n •\tfitness-probity
\r\n •\tpep
\r\n •\tpep-class-1
\r\n •\tpep-class-2
\r\n •\tpep-class-3
\r\n •\tpep-class-4

\r\n \r\n Classic Adverse Media Taxonomy:
\r\n •\tadverse-media
\r\n •\tadverse-media-financial-crime
\r\n •\tadverse-media-violent-crime
\r\n •\tadverse-media-sexual-crime
\r\n •\tadverse-media-terrorism
\r\n •\tadverse-media-fraud
\r\n •\tadverse-media-narcotics
\r\n •\tadverse-media-general

\r\n \r\n If you use FATF-aligned Adverse Media Taxonomy:
\r\n •\tadverse-media-v2-property
\r\n •\tadverse-media-v2-financial-aml-cft
\r\n •\tadverse-media-v2-fraud-linked
\r\n •\tadverse-media-v2-narcotics-aml-cft
\r\n •\tadverse-media-v2-violence-aml-cft
\r\n •\tadverse-media-v2-terrorism
\r\n •\tadverse-media-v2-cybercrime
\r\n •\tadverse-media-v2-general-aml-cft
\r\n •\tadverse-media-v2-regulatory
\r\n •\tadverse-media-v2-financial-difficulty
\r\n •\tadverse-media-v2-violence-non-aml-cft
\r\n •\tadverse-media-v2-other-financial
\r\n •\tadverse-media-v2-other-serious
\r\n •\tadverse-media-v2-other-minor\r\n \r\n
birth_yearIntegerYear of birth, if known
remove_deceased\"1\" or \"0\"A flag which when set, removes deceased people from search results
country_codesArray of ISO 3166-1 alpha-2 stringsResults filtered by nationality or country of residence.Country code filtering applies to:
\r\n •\tEntity of type PEP only
\r\n •\tEntity of type PEP with Adverse Media
\r\n •\tEntity that has 1 country value or more (only one must match)

\r\n \r\n Country code filtering does not apply to (i.e. results will still appear regardless of the country filter):
\r\n •\tEntity on sanction lists will always appear regardless of other status (PEP, Adverse media)
\r\n •\tEntity that has adverse media mentions only
\r\n •\tEntity that does not have a country assigned\r\n
entity_typeentity_type String (one of):\r\n •\t\"person\"
\r\n •\t\"company\"
\r\n • \"organisation\"
\r\n •\t\"vessel\"
\r\n •\t\"aircraft\"\r\n 		Entity type filter is not a hard filter between different entity types. It only optimizes the matching logic to the relevant entity type.Matching:
\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).
\r\n •\tEquivalent names considered specifically for different entity types (\"Robert\" and \"Bob\" versus \"Investment\" and \"Inversion\").
\r\n •\tInitial matching between individual (\"Carl W. Litsch\") versus company acronyms (\"KFC\").
\r\n Optional: If missing, default rules and logic are applied.\r\n
","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"],"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":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/compliance/searches/{id}/details":{"get":{"tags":["CR Comply API"],"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":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/compliance/searches/{id}/monitors":{"get":{"tags":["CR Comply API"],"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":{"200":{"description":"OK","schema":{"type":"object"}}}},"post":{"tags":["CR Comply API"],"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":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/compliance/searches/{id}/monitors/differences":{"get":{"tags":["CR Comply API"],"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":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/compliance/searches/{id}/update":{"post":{"tags":["CR Comply API"],"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":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/compliance/searches/{id}/entities":{"post":{"tags":["CR Comply API"],"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":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/compliance/searches/{id}/comments":{"get":{"tags":["CR Comply API"],"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":{"200":{"description":"OK","schema":{"type":"object"}}}},"post":{"tags":["CR Comply API"],"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":{"200":{"description":"OK","schema":{"type":"object"}}}}},"/api/common/InterviewOutcome":{"get":{"tags":["Common"],"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"],"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"],"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"],"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":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/InvestigationDataPointsDTO"}}}}}},"/api/common/Countries":{"get":{"tags":["Common"],"summary":"Retrieves country IDs","description":"JSON Response Parameters:\r\n\r\n
FIELD NAMETYPEDESCRIPTION
IDIntegerCountry identifier
CountryStringCountry name
JSON Response sample:\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
FIELD NAMETYPEDESCRIPTION
IDIntegerTown identifier
TownStringTown name


JSON Response sample:\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":"JSON Response Parameters:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n ID\r\n IntegerOrganization identifier
\r\n Name\r\n StringOrganization name
","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":"JSON Request Parameters:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n ID\r\n IntegerRegister identifier
\r\n Name\r\n StringRegister name
","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":"JSON Response Parameters:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n ID\r\n IntegerLegal form identifier
\r\n CountryID\r\n IntegerCountry identifier
\r\n Name\r\n StringLegal form name
","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":"JSON Response Parameters:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n ID\r\n IntegerProduct category identifier
\r\n Name\r\n StringProduct’s category name
","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
FIELD NAMETYPEDESCRIPTION
IDIntegerProduct identifier
NameStringProduct name
","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":"AvailableProductsByUID","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\nJSON Response sample:\r\n\r\n { \r\n \"UID\": \"AEC48633090\",\r\n \"Availability\": [\r\n {\r\n \"ProductID\": 671,\r\n \"ProductName\": \"CR Comply\",\r\n \"SpeedsAvailableforOrder\": \"2\"\r\n },\r\n {\r\n \"ProductID\": 269,\r\n \"ProductName\": \"Corporate Record Report from Cedar Rose\",\r\n \"SpeedsAvailableforOrder\": \"1,2,3,4\"\r\n },\r\n {\r\n \"ProductID\": 273,\r\n \"ProductName\": \"Court Records Search on a Company\",\r\n \"SpeedsAvailableforOrder\": \"1,2,3,4\"\r\n },\r\n {\r\n \"ProductID\": 270,\r\n \"ProductName\": \"Directorships and Shares Held by a Company\",\r\n \"SpeedsAvailableforOrder\": \"1,2,3,4\"\r\n },\r\n {\r\n \"ProductID\": 261,\r\n \"ProductName\": \"Business Information Report\",\r\n \"SpeedsAvailableforOrder\": \"1,2,3,4\"\r\n },\r\n {\r\n \"ProductID\": 547,\r\n \"ProductName\": \"Company Profile Report\",\r\n \"SpeedsAvailableforOrder\": \"1,2,3,4\"\r\n },\r\n {\r\n \"ProductID\": 284,\r\n \"ProductName\": \"Company Credit Report\",\r\n \"SpeedsAvailableforOrder\": \"1,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":"JSON Response Parameters:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n ID\r\n IntegerSpeed identifier
\r\n Name\r\n StringSpeed name
","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"],"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":"Request Parameters:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
EmailstringEmail Address tor receive
","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":"JSON Request Parameters:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n Username\r\n stringUsername of the account
\r\n ResetToken\r\n StringReset Token received to the email address via Get Reset Password Token endpoint
\r\n newPassword\r\n StringNew Password
","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":"JSON Response Paremeters:\r\n

\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
\r\n FIELD NAME\r\n \r\n TYPE\r\n \r\n DESCRIPTION\r\n
\r\n AccountBalance\r\n StringCurrent account balance
\r\n Discount\r\n StringDiscount for client in percentage
\r\n DownloadBalance\r\n StringFree download balance
\r\n CurrencyID\r\n StringClient preferred currency identifier
\r\n CurrencySymbol\r\n StringClient preferred currency symbol
\r\n CurrencyName\r\n StringClient preferred currency name
","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":"JSON Response Example:\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      ○ \"No Result Found\"\r\n\r\n• Subscription Period Ended:\r\n\r\n      ○ \"Subscription expired\"\r\n\r\n• Balance Limit Reached for the Month:\r\n\r\n      ○ \"Monthly balance finished\"\r\n\r\n• Search Query Returned Excessive Results:\r\n\r\n      ○ \"Too many Results. Please refine your search.\"\r\n\r\n• Record Associated with a Different Client:\r\n\r\n      ○ \"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      ○ \"CountryId is required\"\r\n\r\n• Across report endpoints when OrderId is not found:\r\n\r\n      ○ \"OrderId not found.\"\r\n\r\n• When placing orders:\r\n\r\n      ○ \"UID is required for Download speed\"\r\n\r\n• Login:\r\n\r\n      ○ \"Username and/or password invalid\"\r\n\r\n• In Company/Search:\r\n\r\n      ○ \"Fuzzy Search Not Available for this Country\"\r\n\r\n      ○ \"Name is required\"\r\n\r\n      ○ \"UID is required for SearchTypeID 5\"\r\n\r\n      ○ \"More than one result for UID \"\r\n\r\n• When required parameters like OrderId, ProductId, etc., are 0:\r\n\r\n      ○ \"Parameter Value Invalid\"\r\n\r\n• Error encountered in **Files/OrderFileUpload**\r\n\r\n      ○ \"FileId not found.\"\r\n\r\n      ○ \"File cannot be deleted. Order is already sent.\"\r\n\r\n      ○ \"Exceeded File Upload Limit (Max 5).\"\r\n\r\n      ○ \"File Upload not allowed.\"\r\n\r\n      ○ \"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      ○ \"The operation has timed out\"\r\n\r\n• Operation Timed Out or Request Aborted:\r\n\r\n      ○ \"The request was aborted: The operation has timed out.\"\r\n\r\n• Order Placement Failure Due to Processing Issues:\r\n\r\n      ○ \"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\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
StatusIDMESSAGE
-1This UID/Subject was not found
-2This UID/Subject is not available
-3This speed is not available for this product
-4Credit Limit exceeded
\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\": \"\"\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"}]}