Download OpenAPI specification:Download
Restful Web Services
Cedar Rose implements RESTful web services over HTTPS, with a JSON response, and thus, we can integrate with any web-based solution.
General RESTful Response Guide
• HTTP Code 200: Success
• HTTP Code 400: Business Error
• HTTP Code 500: Technical Error
JSON property names are case sensitive. Therefore, if the web service expects "Name", then "name" wouldn't be valid. See example:
{Name: "cedar rose"} // valid
{name: "cedar rose"} // not valid
JSON property string values are NOT case sensitive. See example:
{Name:"cedar rose"} is the same as {Name: "Cedar Rose"}
Responses & Errors
We use standard HTTP status codes to indicate the success or failure of a request to our API.
Successful 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.
{ "status": "success", "content": "... API response goes here ..." }
Unsuccessful 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.
{ "code": 500, "message": "Internal Server Error", "status": "failure" }
Note that the message may have more details about the error.
For authentication, a username and password are required; if the client hasn’t been provided with one, please contact Cedar Rose.
During the login request, and in addition to the username and password, the request body should contain "grant_type=password".
After 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.
Sandbox API: https://apitest.cedar-rose.com/api/User/Login
Production API: https://api.cedar-rose.com/api/User/Login
Login Request
• Method: POST
• Header: Content-Type: application/x-www-form-urlencoded
• Request Body (example):
• grant_type=password
• &username= username
• &password= password
Login Response (example)
• .expires: Mon, 15 Jun 22:00
• .issued: Mon, 15 Jun 13:00
• access_token: BfZPnuyPeZn8e-I…
• token_type: bearer
• userName: username
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.
JSON Request Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| SearchTypeId (required) | string | Defines search input, 0 = name , 4 = register number, 2 = address |
| CountryID (required) | Integer | Country filter. |
| Page (required) | Integer | Number of pages to return. Default value 1 |
| PageSize (required) | Integer | Number of results in each page. Default value 10 |
| Name | String | English name, Arabic name, or register number. Can contain % in the start, middle, and/or end. (required if SearchTypeId = 0) |
| RegisterNumber | String | Company's registration number. Used when SearchTypeId = 4 |
| Town | String | Town name of company's primary address. Used when SearchTypeId = 2 |
| POBox | String | POBox of company's primary address. Used when SearchTypeId = 2 |
| Street | String | Street name of company's primary address. Used when SearchTypeId = 2 |
| PostalCode | String | Postal code of company's primary address. Used when SearchTypeId = 2 |
| FuzzySearch | bit | By default, FuzzySearch =1 for all searches. Specify FuzzySearch = 0 to disable Fuzzy Search and retrieve exact match. |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| Name | String | Company's name |
| NameLocal | String | Name in local script |
| UID | String | Country code + Cedar Rose reference number |
| CommercialRegister | String | Company's registration number |
| SubjectCountryId | Integer | Country identifier |
| Country | String | Country name |
| Town | String | Town name of company's primary address |
| POBox | String | POBox of company's primary address |
| Street | String | Street name of company's primary address |
| Area | String | Area name of company's primary address |
| PostalCode | String | Postal code of company's primary address |
| AddressInfo | String | Additional address information |
| UpdatedDate | String | Date when company information was last updated. Format yyyy-MM-dd |
| Status | String | Active/Inactive status of company. NULL if status not available |
| ReferenceNo | String | Company's reference number |
| fuzzySearch | bit | 1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn't belong to Fuzzy Search performed |
| MatchingRate | decimal | Fuzzy Search score of Company Name that ranges between values (0.0 – 1.0) which is based on the input Company Name provided |
{
"SearchTypeId": "0",
"CountryID": 48,
"Name": "SAMPLE COMPANY NAME",
"Page": 1,
"PageSize": 10
}
JSON Response sample:
{
"Name": "SAMPLE COMPANY NAME",
"NameLocal": "",
"UID": "CYC0344627",
"CommercialRegister": "12345",
"SubjectCountryID": 36,
"Country": "Cyprus",
"Town": "Limassol",
"AddressInfo": " Limassol",
"UpdatedDate": "2020-08-27",
"ReferenceNo": "34534534",
"TotalRecords": 1
}
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| Page | integer <int32> |
| PageSize | integer <int32> |
| CountryID | integer <int32> |
| Name | string |
| LocalName | string |
| RegisterNumber | string |
| SearchTypeId | string |
| FuzzySearch | integer <int32> |
{- "Page": 0,
- "PageSize": 0,
- "CountryID": 0,
- "Name": "string",
- "LocalName": "string",
- "RegisterNumber": "string",
- "SearchTypeId": "string",
- "FuzzySearch": 0
}JSON Request Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| Name (required) | string | English name, Arabic name, or register number. Can contain % in the start, middle, and/or end. |
| CountryID (required) | Integer | Country filter. |
| FuzzySearch | bit | By default, FuzzySearch =1 for all searches. Specify FuzzySearch=0 to disable Fuzzy Search and retrieve exact match. |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| IDATOM | String | Cedar Rose Company ID (serial number) |
| UID | String | country code + Cedar Rose reference number |
| Name | String | comma delimited list of trading names that are like the search filter |
| CommercialRegister | String | Main Commercial Register Number |
| Country | String | Country Name |
| Town | String | Town Name |
| POBox | String | POBOX Number |
| ReferenceNo | String | Additional Serial Number |
| Street | String | Street Name |
| Area | String | Area Name |
| PostalCode | String | Postal Code |
| RegisteredName | String | Company English Name (and Arabic name if available) |
| CountryId | String | Country identifier |
| fuzzySearch | bit | 1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn’t belong to Fuzzy Search performed |
| MatchingRate | decimal | Fuzzy Search score of Company Name that ranges between values (0.0 – 1.0) which is based on the input Company Name provided |
{
"CountryID": 36,
"Name": "SAMPLE COMPANY NAME"
}
JSON Response sample:
{
"IDATOM": "13261149",
"UID": "EGC0344627",
"Name": "SAMPLE COMPANY NAME",
"CommercialRegister": "4276",
"country": "Egypt",
"town": "Cairo",
"POBox": null,
"ReferenceNo": "344627",
"Street": null,
"Area": "Mearag (El) City, Maadi",
"PostalCode": null,
"RegisteredName": "KANDIL GLASS SAE, قنديل جلاس ش.م.م",
"CountryID": "48"
}
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| Page | integer <int32> |
| PageSize | integer <int32> |
| CountryID | integer <int32> |
| Name | string |
| LocalName | string |
| RegisterNumber | string |
| SearchTypeId | string |
| FuzzySearch | integer <int32> |
{- "Page": 0,
- "PageSize": 0,
- "CountryID": 0,
- "Name": "string",
- "LocalName": "string",
- "RegisterNumber": "string",
- "SearchTypeId": "string",
- "FuzzySearch": 0
}JSON Response sample:
{
"MainName": "Shareholders",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Premises",
"DateUpdated": "09/07/2015",
"IsAvailable": true
},
{
"MainName": "Activities",
"DateUpdated": null,
"IsAvailable": true
},
{
"MainName": "Managers",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Legal Form",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Financials",
"DateUpdated": null,
"IsAvailable": true
},
{
"MainName": "Capital",
"DateUpdated": "17/09/2018",
"IsAvailable": true
},
{
"MainName": "Employees",
"DateUpdated": null,
"IsAvailable": true
},
{
"MainName": "Adverse Media",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Bankruptcies",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Addresses",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Career",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Directorship",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Criminal Records",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Person Comment",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Default Cases",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Internet Portals",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Legal Procedures",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Gazette",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Reputation",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Politically Exposed",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Publications And Media",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Certifications",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Country Disclaimer",
"DateUpdated": null,
"IsAvailable": true
},
{
"MainName": "Clients",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Brands",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Commerce",
"DateUpdated": null,
"IsAvailable": true
},
{
"MainName": "Logos",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Production Capacity",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Registers",
"DateUpdated": null,
"IsAvailable": true
},
{
"MainName": "Short Name",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Credit Rating",
"DateUpdated": null,
"IsAvailable": true
},
{
"MainName": "Date Registered",
"DateUpdated": null,
"IsAvailable": true
},
{
"MainName": "Affiliates",
"DateUpdated": null,
"IsAvailable": true
},
{
"MainName": "Groups",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Global Compliance Check",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Date of Birth",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Gender",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Deceased Date",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Country Overview",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Trading Names",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Name",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Country Disclaimer",
"DateUpdated": null,
"IsAvailable": true
},
{
"MainName": "Former Names",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "History",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Status",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "Source and Intelligence",
"DateUpdated": null,
"IsAvailable": false
},
{
"MainName": "CR Score",
"DateUpdated": null,
"IsAvailable": false
}
| UID required | string |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
JSON Response sample:
{
"orderid": 1413189,
"statusCode": "200",
"message": "Success",
"jsonData": "{ REPORT DATA AS JSON }"
}
| OrderId required | string |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
JSON Response sample:
{
"orderid": 1413189,
"statusCode": "200",
"message": "Success",
"pdfData": "base64 encoded PDF file"
}
| OrderID required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
JSON Request Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| SubjectName (required*) | String | The available name of the company. Required to include either SubjectName or IDATOM |
| ProductId (required) | String | serial number of the requested product (example: 284 is the serial number of Company Credit Report) |
| SpeedId (required) | String | serial number of the requested Speed (example: 1 is the serial number of the regular speed) |
| SubjectCountryID (required) | String | serial number of the Country of the order |
| UID (required*) | String | serial number of the company (if available). Required to include either SubjectName or UID. For Download speeds (speedId = 2), UID is required. |
| AdditionalInfo | String | additional info that you would like to include in your request |
| SubjectDetails | String | available details about the company |
| TradingName | String | available trading names of the company |
| CustomerReference | String | could be your serial number or project ID or purchase number or just "0" |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| Price | String | the price amount of the order, according to the product, speed, and country |
| VAT | String | the VAT amount |
| DueDate | String | the Due Date of the order, according to product, speed, country, holidays... |
| UID | String | country code + Cedar Rose reference number |
| Content | String (XML) | you will receive xml design separately according to the product |
{
"ProductId": "547",
"SpeedId": "2",
"SubjectCountryId": "9",
"UID": "BHC0057425",
"CustomerReference": "TEST"
}
JSON Response Sample:
{
"Name": "SAMPLE COMPANY NAME",
"NameLocal": "",
"UID": "CYC0344627",
"CommercialRegister": "12345",
"SubjectCountryID": 36,
"Country": "Cyprus",
"Town": "Limassol",
"AddressInfo": " Limassol",
"UpdatedDate": "2020-08-27",
"ReferenceNo": "34534534",
"TotalRecords": 1
}
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| SubjectName | string |
| UID | string |
| ProductId | integer <int32> |
| SpeedId | integer <int32> |
| SubjectCountryID | integer <int32> |
| IDATOM | integer <int32> |
| AdditionalInfo | string |
| SubjectDetails | string |
| TradingName | string |
| CustomerReference | string |
{- "SubjectName": "string",
- "UID": "string",
- "ProductId": 0,
- "SpeedId": 0,
- "SubjectCountryID": 0,
- "IDATOM": 0,
- "AdditionalInfo": "string",
- "SubjectDetails": "string",
- "TradingName": "string",
- "CustomerReference": "string"
}JSON Request Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| OrderId | Integer | Order Identifier |
| FileTypeId | Integer | File Type identifier (refer Get File Types) |
| File | .doc,.docx,.pdf,.jpg,.jpeg,.png | File to be uploaded associated with the order |
{
"Files": [
{
"ResponseCode": 3,
"FileName": "CR Identify Report.pdf",
"Message": "'CR Identify Report.pdf' exceeds maximum File Size."
}
],
"Message": "0 out of 1 files Uploaded Sucessfully"
}
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| OrderId required | string Order identifier |
| FileTypeId required | string File type identifier |
| File required | string <binary> File to upload |
JSON Response sample:
{
"Company": [
{
"ID": 20,
"Name": "Approved Electronic Copy of Commercial License"
},
{
"ID": 17,
"Name": "Certificate Copy of Change of name"
},
{
"ID": 18,
"Name": "Certificate Copy of Financials"
},
{
"ID": 1,
"Name": "Certified Copy of Articles of Association"
},
{
"ID": 2,
"Name": "Certified Copy of Certificate of Directors"
},
{
"ID": 3,
"Name": "Certified Copy of Certificate of Directors and Secretary"
},
{
"ID": 4,
"Name": "Certified Copy of Certificate of Good Standing"
},
{
"ID": 5,
"Name": "Certified Copy of Certificate of Incorporation"
},
{
"ID": 11,
"Name": "Certified Copy of Certificate of Particulars of Directors/shareholders"
},
{
"ID": 6,
"Name": "Certified Copy of Certificate of Registered Office Address"
},
{
"ID": 7,
"Name": "Certified Copy of Certificate of Share Capital"
},
{
"ID": 8,
"Name": "Certified Copy of Certificate of Shareholders"
},
{
"ID":16,
"Name": "Certified Copy of Chamber of Commerce and Industry Membership"
},
{
"ID": 13,
"Name": "Certified Copy of Extract of Commercial Register"
},
{
"ID": 12,
"Name": "Certified Copy of Licence"
},
{
"ID": 9,
"Name": "Certified Copy of Memorandum of Articles and Associations"
},
{
"ID": 10,
"Name": "Certified Copy of Memorandum of Association"
},
{
"ID": 14,
"Name": "Copy of Filed Financial Statement or Annual Return"
},
{
"ID": 15,
"Name": "Copy of Published Financial Statement or Annual Return"
}
],
"Person": [
{
"ID": 1,
"Name": "Person File Upload"
}
]
}
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
JSON Response sample:
[
{
"Id": 73120,
"FileName": "ADIP-OM301_Step1_Count.txt",
"FileType": "Testing",
"FileTypeId": 1
},
{
"Id": 73121,
"FileName": "ADIP-OM301_Step1_Count.txt",
"FileType": "Testing",
"FileTypeId": 1
}
]
| OrderId required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| OrderId required | integer <int32> |
| FileId required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
[- {
- "Files": [
- {
- "ResponseCode": 0,
- "FileName": "string",
- "Message": "string"
}
], - "Message": "string"
}
]Request Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| ProductId | String | Product identifier |
| SpeedId | String | Speed Identifier |
| SubjectCountryId | String | Country Identifier |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| amount | Decimal | Cost of order |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| SubjectName | string |
| UID | string |
| ProductId | integer <int32> |
| SpeedId | integer <int32> |
| SubjectCountryID | integer <int32> |
| IDATOM | integer <int32> |
| AdditionalInfo | string |
| SubjectDetails | string |
| TradingName | string |
| CustomerReference | string |
{- "SubjectName": "string",
- "UID": "string",
- "ProductId": 0,
- "SpeedId": 0,
- "SubjectCountryID": 0,
- "IDATOM": 0,
- "AdditionalInfo": "string",
- "SubjectDetails": "string",
- "TradingName": "string",
- "CustomerReference": "string"
}Request Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| ProductId | String | Product identifier |
| SpeedId | String | Speed Identifier |
| SubjectCountryId | String | Last name |
| UID | String | Country Identifier |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| DueDate | String | Due date for report delivery. Date format dd/mm/yyyy |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| SubjectName | string |
| UID | string |
| ProductId | integer <int32> |
| SpeedId | integer <int32> |
| SubjectCountryID | integer <int32> |
| IDATOM | integer <int32> |
| AdditionalInfo | string |
| SubjectDetails | string |
| TradingName | string |
| CustomerReference | string |
{- "SubjectName": "string",
- "UID": "string",
- "ProductId": 0,
- "SpeedId": 0,
- "SubjectCountryID": 0,
- "IDATOM": 0,
- "AdditionalInfo": "string",
- "SubjectDetails": "string",
- "TradingName": "string",
- "CustomerReference": "string"
}JSON Response Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| Status | Integer | |
| Content | String | XML of the report |
| DueDate | String | Due Date of the Order |
| OrderID required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| OrderID required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
[- {
- "CurrentStatusID": 0,
- "Content": "string",
- "OrderID": 0,
- "ClientID": 0,
- "IDATOM": 0,
- "UID": "string",
- "ProductId": 0,
- "DueDate": "string"
}
]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.
Cedar 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.
JSON Request Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| countryId (required) | string | Defines search input, 0 = name, 2 = address, 4 = register number |
| CountryID (required) | Integer | Country identifier |
| name () | String | Entity name |
| registerNumber () | String | Company registration number |
| city | String | City of company’s primary address |
| postalCode | String | Postal code of company’s primary address |
| clientReference | String | Client reference number |
| UID (*) | String | Unique Identifier of Company |
| FuzzySearch | bit | By default, FuzzySearch =1 for all searches. Specify FuzzySearch=0 to disable Fuzzy Search and retrieve exact match. |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| UID | String | Entity Unique identifier |
| name | String | Entity name |
| tradingName | String | Trade Name matching the Search Input name |
| registerNumber | String | Entity registration number |
| city | String | City of entity’s primary address |
| address | String | Additional information for entity’s primary address |
| postalCode | String | Postal code of entity’s primary address |
| status | String | Entity’s status |
| legalForm | String | Legal Type of the Company |
| score | String | Entity’s score |
| display | Integer | 1 (result displayed) OR 0 (result not displayed) |
| IssueDate | String | Register’s Issue Date |
| ExpiryDate | String | Register’s Expiry Date |
| fuzzySearch | bit | 1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn’t belong to Fuzzy Search performed |
{
"countryId": 69,
"name": "SAMPLE COMPANY NAME",
"registerNumber": "U63000MH2004PTC148761",
"city": "Mumbai City",
"postalCode": "400093",
"clientReference": "ref1234567",
"UID": "INC1020024374"
}
JSON Response sample:
[
{
"UID": null,
"searchId": 1325,
"nameWeight": 45,
"regNoWeight": 35,
"postalCodeWeight": 35,
"cityWeight": 11,
"minPercent": 80,
"maxRecords": 10,
"countryId": 69,
"name": "SAMPLE COMPANY NAME",
"registerNumber": "U1234567890",
"city": "Mumbai City",
"postalCode": "400090",
"clientReference": "ref1234567",
"userId": 486,
"searchDate": "2022-03-30 17:20:40",
"totalResults": 1,
"successful": 1,
"reduceBalance": null,
"price": null,
"vat": 0.0,
"currency": "EUR",
"subscriptionStartDate": "2021-06-01",
"subscriptionEndDate": "2022-08-30",
"subscriptionMonthStartDate": null,
"subscriptionMonthEndDate": null,
"currencyRate": null,
"searchResult": [
{
"UID": "INC1234567890",
"name": "SAMPLE COMPANY NAME",
"registerNumber": "U1234567890",
"city": "Mumbai City",
"address": "Postal Code : 400090, Street : Sample Apartments, City : Mumbai City",
"postalCode": "400090",
"status": "Active",
"legalForm": "",
"score": 99.0,
"display": 1,
"reduceBalance": null,
"price": null,
"vat": null,
"currency": null,
"subscriptionStartDate": null,
"subscriptionEndDate": null,
"subscriptionMonthStartDate": null,
"subscriptionMonthEndDate": null,
"currencyRate": null,
"crComplyHits": null,
"updatedDate": null
}
],
"crComply": null
}
]
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| searchId | integer <int32> |
| countryId | integer <int32> |
| name | string |
| registerNumber | string |
| city | string |
| postalCode | string |
| clientReference | string |
| startDate | string <date-time> |
| endDate | string <date-time> |
| UID | string |
| fuzzySearch | integer <int32> |
{- "searchId": 0,
- "countryId": 0,
- "name": "string",
- "registerNumber": "string",
- "city": "string",
- "postalCode": "string",
- "clientReference": "string",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "UID": "string",
- "fuzzySearch": 0
}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:
• Appending searchId to URL. SearchId is the unique identifier in response from POST search.
• Appending UID for an entity returned in POST Search. UID is the unique identifier of an entity returned from POST Search searchResults.
JSON Response Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| UID | String | Entity Unique identifier |
| name | String | Entity name |
| tradingName | String | Trade Name matching the Search Input name |
| registerNumber | String | Entity registration number |
| city | String | City of entity’s primary address |
| address | String | Additional information for entity’s primary address |
| postalCode | String | Postal code of entity’s primary address |
| status | String | Entity’s status |
| legalForm | String | Legal Type of the Company |
| score | String | Entity’s score |
| display | Integer | 1 (result displayed) OR 0 (result not displayed) |
| IssueDate | String | Register’s Issue Date |
| ExpiryDate | String | Register’s Expiry Date |
| fuzzySearch | bit | 1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn’t belong to Fuzzy Search performed |
[
{
"UID": null,
"searchId": 1073,
"nameWeight": 5,
"regNoWeight": 4,
"postalCodeWeight": 4,
"cityWeight": 2,
"minPercent": 1,
"maxRecords": 10,
"countryId": 69,
"name": "SAMPLE COMPANY NAME",
"registerNumber": "U63000MH2004PTC148761",
"city": "Mumbai City",
"postalCode": "400093",
"clientReference": "ref1234567",
"userId": 486,
"searchDate": "2021-05-05 08:23:19",
"totalResults": 1,
"successful": 1,
"reduceBalance": 1,
"price": null,
"vat": null,
"currency": "EUR",
"subscriptionStartDate": "2021-02-13",
"subscriptionEndDate": "2021-08-13",
"subscriptionMonthStartDate": "2021-04-12",
"subscriptionMonthEndDate": "2021-05-11",
"currencyRate": null,
"searchResult": [
{
"UID": "INC1020024322",
"name": "SAMPLE COMPANY NAME",
"registerNumber": "U63000MH2004PTC148761",
"city": "Mumbai City",
"address": "Postal Code : 400093, Street : Jayant Apartments, City : Mumbai City",
"postalCode": "400093",
"status": "Active",
"legalForm": "",
"score": 99.0,
"display": 1,
"reduceBalance": null,
"price": null,
"vat": null,
"currency": null,
"subscriptionStartDate": null,
"subscriptionEndDate": null,
"subscriptionMonthStartDate": null,
"subscriptionMonthEndDate": null,
"currencyRate": null,
"crComplyHits": null,
"updatedDate": null
}
],
"crComply": null
}
]
| searchId required | integer <int32> |
| UID required | string |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
JSON Response Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| UID | String | Entity Unique identifier |
| name | String | Entity name |
| tradingName | String | Trade Name matching the Search Input name |
| registerNumber | String | Entity registration number |
| city | String | City of entity’s primary address |
| address | String | Additional information for entity’s primary address |
| postalCode | String | Postal code of entity’s primary address |
| status | String | Entity’s status |
| legalForm | String | Legal Type of the Company |
| score | String | Entity’s score |
| display | Integer | 1 (result displayed) OR 0 (result not displayed) |
| IssueDate | String | Register’s Issue Date |
| ExpiryDate | String | Register’s Expiry Date |
| fuzzySearch | bit | 1 if the Search Result belongs to Fuzzy Search, 0 if the result doesn’t belong to Fuzzy Search performed |
[
{
"UID": null,
"searchId": 1325,
"nameWeight": 45,
"regNoWeight": 35,
"postalCodeWeight": 35,
"cityWeight": 11,
"minPercent": 80,
"maxRecords": 10,
"countryId": 69,
"name": "SAMPLE COMPANY NAME",
"registerNumber": "U1234567890",
"city": "Mumbai City",
"postalCode": "400090",
"clientReference": "ref1234567",
"userId": 486,
"searchDate": "2022-03-30 17:20:40",
"totalResults": 1,
"successful": 1,
"reduceBalance": null,
"price": null,
"vat": 0.0,
"currency": "EUR",
"subscriptionStartDate": "2021-06-01",
"subscriptionEndDate": "2022-08-30",
"subscriptionMonthStartDate": null,
"subscriptionMonthEndDate": null,
"currencyRate": null,
"searchResult": [
{
"UID": "INC1234567890",
"name": "SAMPLE COMPANY NAME",
"registerNumber": "U1234567890",
"city": "Mumbai City",
"address": "Postal Code : 400090, Street : Sample Apartments, City : Mumbai City",
"postalCode": "400090",
"status": "Active",
"legalForm": "",
"score": 99.0,
"display": 1,
"reduceBalance": null,
"price": null,
"vat": null,
"currency": null,
"subscriptionStartDate": null,
"subscriptionEndDate": null,
"subscriptionMonthStartDate": null,
"subscriptionMonthEndDate": null,
"currencyRate": null,
"crComplyHits": null,
"updatedDate": null
}
],
"crComply": null
}
]
| searchId required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
JSON Request sample:
{
"searchId": 111,
"countryId": 69,
"name": "SAMPLE COMPANY NAME",
"registerNumber": "",
"clientReference": "ref1234567",
"userId": 16337,
"startDate": "2021-04-25",
"endDate": "2021-04-30"
}
JSON Response sample:
[
{
"searchId": 111,
"country": "India",
"name": "SAMPLE COMPANY NAME",
"registerNumber": "U63000MH2004PTC148761",
"clientReference": "ref1234567",
"userId": 16337,
"searchDate": "4/30/2021 3:45:32 PM",
"totalResults": 1,
"displayedUIDs": "INC1020024374"
}
]
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
{ }JSON Response sample:
{
"subscriptionStartDate": "2021-04-26",
"subscriptionEndDate": "2021-10-25",
"kybTotalBalance": 3540,
"currentMonthStartDate": "2021-04-25",
"currentMonthEndDate": "2021-05-25",
"currentMonthBalance": 540,
"crComplyBalance": 0
}
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
JSON Response Parameters :
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| nameWeight | Integer | Weight for name as per client’s settings |
| regNoWeight | Integer | Weight for name as per client’s settings |
| minPercent | Integer | Minimum threshold for matching and fetching results |
| maxRecords | Integer | Maximum number of records per response |
| postalCodeWeight | Integer | Weight for name as per client’s settings |
| cityWeight | Integer | Weight for city as per client’s settings |
| crComplyFuzziness | Integer | Defines the fuzziness for CR Comply searches. |
| crComplyMonitor | Boolean | Defines if search will be monitored. |
| crComplySources | Array | Defines CR Comply filters. |
{
"nameWeight": 50,
"regNoWeight": 40,
"minPercent": 80,
"maxRecords": 10,
"postalCodeWeight": 20,
"cityWeight": 10,
"crComplyFuzziness": 0,
"crComplyMonitor": 1,
"crComplySources": [
{
"xmlValue": "sanction"
},
{
"xmlValue": "warning"
}
]
}
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
JSON Request/Response Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| nameWeight | Integer | Weight for name as per client’s settings |
| regNoWeight | Integer | Weight for name as per client’s settings |
| minPercent | Integer | Minimum threshold for matching and fetching results |
| maxRecords | Integer | Maximum number of records per response |
| postalCodeWeight | Integer | Weight for name as per client’s settings |
| cityWeight | Integer | Weight for city as per client’s settings |
| crComplyFuzziness | Integer | Defines the fuzziness for CR Comply searches. |
| crComplyMonitor | Boolean | Defines if search will be monitored. |
| crComplySources | Array | Defines CR Comply filters. |
{
"nameWeight": 50,
"regNoWeight": 40,
"minPercent": 80,
"maxRecords": 10,
"postalCodeWeight": 30,
"cityWeight": 10,
"crComplyFuzziness": 0,
"crComplyMonitor": 1,
"crComplySources": [
{
"xmlValue": "sanction"
},
{
"xmlValue": "warning"
}
]
}
JSON Response sample:
{
"nameWeight": 50,
"regNoWeight": 40,
"minPercent": 80,
"maxRecords": 10,
"postalCodeWeight": 30,
"cityWeight": 10,
"crComplyFuzziness": 0,
"crComplyMonitor": 1,
"crComplySources": [
{
"xmlValue": "sanction"
},
{
"xmlValue": "warning"
}
]
}
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
{ }JSON Response Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| searchId | Integer | KYB Search identifier |
| name | String | Entity name |
| UID | String | Entity Unique identifier |
| registerNumber | String | Entity registration number |
{
"searchId": 111,
"name": "SAMPLE COMPANY NAME",
"uid": "INC1020024374"
}
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
{ }JSON Response sample:
| crComplyOrderId required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
CR Identify verifies the identity of your customers, suppliers or hires instantly. CR 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. TYPE OF SOURCES *Telco: Data from Telecommunication companies
Government: Data from Corporate Registers Records, Voters Lists, etc.
Consumer: Public Announcements, Utility Companies, Mortgages, University Records, etc.
Credit: Data collected from various financial institutions and Credit Bureau.
JSON Request Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| FirstName | String | First name |
| MiddleName | String | Middle name |
| LastName | String | Last name |
| UID | String | Person’s Unique Identifer |
| YearOfbirth | Integer | Year of birth |
| MonthOfBirth | Integer | Month of birth |
| DayOfBirth | Integer | Day of birth |
| IsFormer | Boolean | |
| isExact | Boolean | Exact match |
| LanguageId | Integer | |
| IdentityNumber | String | Person’s ID number |
| NationalityCountryId | Integer | CountryId of Person’s nationality |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| FirstName | String | First name |
| MiddleName | String | Middle name |
| LastName | String | Last name |
| UID | String | Person’s Unique Identifer |
| YearOfbirth | Integer | Year of birth |
| MonthOfBirth | Integer | Month of birth |
| DayOfBirth | Integer | Day of birth |
| IsFormer | Boolean | |
| isExact | Boolean | Exact match |
| LanguageId | Integer | |
| IdentityNumber | String | Person’s ID number |
| NationalityCountryId | Integer | CountryId of Person’s nationality |
{
"FirstName": "Nadine",
"LastName": "I",
"isExact": 0,
"LanguageId": 1
}
JSON Response sample:
[
{
"FirstName": "Jane",
"MiddleName": "Available",
"LastName": "Doe",
"UID": "ZZP01234567",
"YearOfbirth": "Not Available ",
"MonthOfBirth": "Not Available ",
"DayOfBirth": "Not Available ",
"isFormer": "Available",
"IdentityNumber": "Not Available "
},
{
"FirstName": "Jane",
"MiddleName": "Available",
"LastName": "Doe",
"UID": "LBP701234292",
"YearOfbirth": "Not Available ",
"MonthOfBirth": "Not Available ",
"DayOfBirth": "Not Available ",
"isFormer": "Available",
"IdentityNumber": "Not Available "
}
]
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| FirstName | string |
| MiddleName | string |
| LastName | string |
| UID | string |
| YearOfbirth | integer <int32> |
| MonthOfBirth | integer <int32> |
| DayOfBirth | integer <int32> |
| isFormer | boolean |
| isExact | boolean |
| LanguageId | integer <int32> |
| IdentityNumber | string |
| NationalityCountryId | integer <int32> |
| ReturnMessage | string |
{- "FirstName": "string",
- "MiddleName": "string",
- "LastName": "string",
- "UID": "string",
- "YearOfbirth": 0,
- "MonthOfBirth": 0,
- "DayOfBirth": 0,
- "isFormer": true,
- "isExact": true,
- "LanguageId": 0,
- "IdentityNumber": "string",
- "NationalityCountryId": 0,
- "ReturnMessage": "string"
}• Authentication required
• All Request Fields are optional except Country.
• The field/s included in the client’s request and is/are specified as “Primary” = true, this or these fields will be used to search for the person through Cedar Rose database.
• If the person is found, the field/s included in the client’s request and are or is specified as "Primary"=false, this or these fields will be compared to correspondent fields of the found person in the Cedar Rose database and an evaluation will be included in the response.
• "Like" = true can be added to the request body to check if part of the object exists, if not added it will be false by default. “Like” does not apply to NationalId or BirthDate.
Header
• Content-Type: application/json
• Authorization: Bearer {TOKEN_FROM_LOGIN}
JSON Request Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| FirstName | String | |
| LastName | String | |
| MiddleName | String | |
| MiddleName2 | String | |
| MiddleName3 | String | |
| MiddleName4 | String | |
| NationalId | String | |
| BirthDate | String | Format: Year-Month-Day |
| CountryId (required) | Integer |
The web service will return 1 record having the best score, containing a list of all fields (in addition to the record score), and each field has the below format:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| Name | String | |
| Evaluation | String |
The Evaluation Options are Matching, Not Matching, Not Available, Not Received.
The following 2 options work for primary and non-primary fields: Matching, Not Received.
Not Matching: is only used for non-primary fields
In case the record was found according to primary fields, but a certain non-primary field was empty in our database, the field will return “Not Available” in the response.
JSON Request sample:
Point Source:
{
"CountryID": "93",
"Request": [
{
"Name": "FirstName",
"Value": "Nad",
"Primary": true,
"Like": true
},
{
"Name": "LastName",
"Value": "Ibrahim",
"Primary": true
}
]
}
Cascade 1x1:
{
"CountryID": "9",
"Request": [
{
"Name": "FirstName",
"Value": "Mashaal",
"Primary": true
},
{
"Name": "Birthdate",
"Value": "1981-12-17",
"Primary": true
}
]
}
JSON Response sample
Point Source:
[
{
"Name": "FirstName",
"Evaluation": "Not Matching"
},
{
"Name": "LastName",
"Evaluation": "Matching"
},
{
"Name": "Score",
"Evaluation": "15.00"
}
]
Cascade 1x1:
[
{
"Name": "FirstName",
"Evaluation": "Matching"
},
{
"Name": "Birthdate",
"Evaluation": "Matching"
},
{
"Name": "Score",
"Evaluation": "35.00"
}
]
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| FirstName | string |
| MiddleName1 | string |
| MiddleName2 | string |
| MiddleName3 | string |
| LastName | string |
| NationalId | string |
| Birthdate | string |
| CivilRegNo | string |
| RegTown | integer <int32> |
| CountryId | integer <int32> |
| advanceSearch | boolean |
| MiddleName | string |
| BirthDateDay | integer <int32> |
| Lang | integer <int32> |
| fullName | string |
| birthDate | string |
| surname | string |
| name | string |
| patronymic | string |
| pNumber | string |
| iNumber | string |
| Phone | string |
| Forename | string |
| Surname | string |
| DOB | string |
Array of objects (EIDVTRWhereDTO) |
{- "FirstName": "string",
- "MiddleName1": "string",
- "MiddleName2": "string",
- "MiddleName3": "string",
- "LastName": "string",
- "NationalId": "string",
- "Birthdate": "string",
- "CivilRegNo": "string",
- "RegTown": 0,
- "CountryId": 0,
- "advanceSearch": true,
- "MiddleName": "string",
- "BirthDateDay": 0,
- "Lang": 0,
- "fullName": "string",
- "birthDate": "string",
- "surname": "string",
- "name": "string",
- "patronymic": "string",
- "pNumber": "string",
- "iNumber": "string",
- "Phone": "string",
- "Forename": "string",
- "Surname": "string",
- "DOB": "string",
- "Request": [
- {
- "Name": "string",
- "Value": "string",
- "Primary": true,
- "Like": true,
- "Response": "string"
}
]
}Search is performed only when recommended fields are provided.
“Source” is not applicable for Cascade Mode(cascade=1)
• Cascade=1: Cascade Mode
• Cascade=0: Point Source Mode
• Cascadetype=1: 1x1 Identity Verification
• Cascadetype=2: 2x2 Identity Verification
JSON Request sample:
Point Source:
{
"config": {
"cascade": 0,
"cascadetype": 1,
"source": "Hutchison"
},
"propertyfields": {
"firstName": "TOM",
"lastName": "CLARKE",
"middleName1": "CLARKE",
"fullName": "TOM CLARKE",
"dob": "1800-01-01",
"email": "",
"gender": "",
"state": "",
"requestId": "",
"building": "19",
"OfficeUnit": "19",
"street": "CASUARINA",
"fullAddress": "19 CASUARINA",
"city": "KILMORE",
"district": "KILMORE",
"postalCode": "3764",
"countryCode": "AT",
"nationalId": "",
"phone": "15555551212 "
}
}
Cascade 1x1:
{
"config": {
"cascade": 1,
"cascadetype": 1,
"source": ""
},
"propertyfields": {
"firstName": "TOM",
"lastName": "CLARKE",
"middleName1": "CLARKE",
"fullName": "TOM CLARKE",
"dob": "1800-01-01",
"email": "",
"gender": "",
"state": "",
"requestId": "",
"building": "19",
"OfficeUnit": "19",
"street": "CASUARINA",
"fullAddress": "19 CASUARINA",
"city": "KILMORE",
"district": "KILMORE",
"postalCode": "3764",
"countryCode": "AU",
"nationalId": "",
"phone": ""
}
}
Cascade 2x2:
{
"config": {
"cascade": 1,
"cascadetype": 2,
"source": ""
},
"propertyfields": {
"firstName": "TOM",
"lastName": "CLARKE",
"middleName1": "CLARKE",
"fullName": "TOM CLARKE",
"dob": "1800-01-01",
"email": "",
"gender": "",
"state": "",
"requestId": "",
"building": "19",
"OfficeUnit": "19",
"street": "CASUARINA",
"fullAddress": "19 CASUARINA",
"city": "KILMORE",
"district": "KILMORE",
"postalCode": "3764",
"countryCode": "AU",
"nationalId": "",
"phone": ""
}
}
JSON Response sample:
Point Source:
{
"results": {
"HUTCHISON": {
"firstname": "Match",
"lastname": "Partial_Match",
"middlename1": "No_Data",
"fullname": "No_Data",
"dob": "Partial_Match",
"email": "No_Data",
"gender": "No_Data",
"state": "No_Data",
"building": "No_Data",
"officeunit": "No_Data",
"street": "No_Data",
"fulladdress": "Partial_Match",
"city": "No_Data",
"district": "No_Data",
"postalcode": "No_Data",
"countrycode": "No_Data",
"nationalid": "No_Data",
"phone": "No_Data"
}
},
"message": "200 OK"
}
Cascade 1x1:
{
"results": [
{
"Government": [
{
"firstname": "Match",
"lastname": "Match",
"middlename1": "No_Data",
"fullname": "Match",
"dob": "No_Match",
"building": "Match",
"officeunit": "No_Data",
"street": "Match",
"fulladdress": "Match",
"city": "Match",
"district": "No_Match",
"postalcode": "Match",
"nationalid": "No_Data_Provided",
"phone": "No_Data_Provided",
"email": "Not Avaliable",
"gender": "Not Avaliable",
"state": "Not Avaliable"
}
]
},
{
"Telco": [
{
"firstname": "Match",
"lastname": "Match",
"middlename1": "No_Data",
"fullname": "Match",
"dob": "No_Match",
"building": "Match",
"officeunit": "No_Data",
"street": "Match",
"fulladdress": "Match",
"city": "Match",
"district": "No_Match",
"postalcode": "Match",
"nationalid": "No_Data_Provided",
"phone": "No_Data_Provided",
"email": "Not Avaliable",
"gender": "Not Avaliable",
"state": "Not Avaliable"
}
]
},
{
"Telco": [
{
"firstname": "Match",
"lastname": "Match",
"middlename1": "No_Data",
"fullname": "Match",
"dob": "No_Match",
"building": "Match",
"officeunit": "No_Data",
"street": "Match",
"fulladdress": "Match",
"city": "Match",
"district": "No_Match",
"postalcode": "Match",
"nationalid": "No_Data_Provided",
"phone": "No_Data_Provided",
"email": "Not Avaliable",
"gender": "Not Avaliable",
"state": "Not Avaliable"
}
]
}
],
"message": "200 OK"
}
Cascade 2x2:
{
"results": [
{
"Government": [
{
"firstname": "Match",
"lastname": "Match",
"middlename1": "No_Data",
"fullname": "Match",
"dob": "No_Data",
"email": "No_Data_Provided",
"gender": "No_Data_Provided",
"state": "No_Data_Provided",
"building": "Match",
"officeunit": "No_Data",
"street": "Match",
"fulladdress": "Match",
"city": "Match",
"district": "No_Data",
"postalcode": "Match",
"nationalid": "No_Data_Provided",
"phone": "No_Data_Provided"
}
]
},
{
"Telco": [
{
"firstname": "Match",
"lastname": "Match",
"middlename1": "No_Data",
"fullname": "Match",
"dob": "No_Data",
"email": "No_Data_Provided",
"gender": "No_Data_Provided",
"state": "No_Data_Provided",
"building": "Match",
"officeunit": "No_Data",
"street": "Match",
"fulladdress": "Match",
"city": "Match",
"district": "No_Data",
"postalcode": "Match",
"nationalid": "No_Data_Provided",
"phone": "No_Data_Provided"
}
]
},
{
"Telco": [
{
"firstname": "Match",
"lastname": "Match",
"middlename1": "No_Data",
"fullname": "Match",
"dob": "No_Data",
"email": "No_Data_Provided",
"gender": "No_Data_Provided",
"state": "No_Data_Provided",
"building": "Match",
"officeunit": "No_Data",
"street": "Match",
"fulladdress": "Match",
"city": "Match",
"district": "No_Data",
"postalcode": "Match",
"nationalid": "No_Data_Provided",
"phone": "No_Data_Provided"
}
]
}
],
"message": "200 OK"
}
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
object (Config) | |
object (Propertyfields) |
{- "config": {
- "cascade": 0,
- "cascadetype": 0,
- "source": "string"
}, - "Propertyfields": {
- "firstname": "string",
- "lastname": "string",
- "middlename1": "string",
- "fullname": "string",
- "dob": "string",
- "building": "string",
- "officeunit": "string",
- "street": "string",
- "fulladdress": "string",
- "city": "string",
- "district": "string",
- "postalcode": "string",
- "countrycode": "string",
- "nationalid": "string",
- "phone": "string",
- "email": "string",
- "gender": "string",
- "state": "string",
- "requestId": "string"
}
}Used to retrieve Recommended, Required and Optional Fields based on “Mode Selection” and “CountryCode” and “Source”.
• Cascade=1: Cascade Mode
• Cascade=0: Point Source Mode
JSON Request Parameters:
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| cascade (required) | Integer | Mode selection |
| countryCode | String | Country Code |
| source | String | Data source |
JSON Request sample:
Point Source:
{
"cascade": 0,
"countryCode": "IN",
"source": "IN1"
}
Cascade 1x1:
{
"cascade": 1,
"countryCode": "IN",
"source": ""
}
JSON Response sample:
Point Source:
{
"results": {
"country": "India",
"countrycodename": "IN",
"source": "IN1",
"firstname": "Required_Field",
"lastname": "Required_Field",
"middlename1": "Recommended_Field",
"fullname": "Not_Recommended",
"dob": "Not_Recommended",
"building": "Not_Recommended",
"officeunit": "Not_Recommended",
"street": "Not_Recommended",
"fulladdress": "Recommended_Field",
"city": "Recommended_Field",
"district": "Not_Recommended",
"postalcode": "Recommended_Field",
"countrycode": "Required_Field",
"nationalid": "Not_Recommended",
"phone": "Not_Recommended",
"state": "Required_Field",
"email": "Not_Recommended",
"requestId": "Required_Field",
"gender": "Recommended_Field",
"idType": "0"
},
"message": "200 OK"
}
Cascade 1x1:
{
"results": {
"country": "India",
"countrycodename": "IN",
"firstname": "Required_Field",
"lastname": "Required_Field",
"middlename1": "Required_Field",
"fullname": "Required_Field",
"dob": "Required_Field",
"building": "Optional_Field",
"officeunit": "Optional_Field",
"street": "Optional_Field",
"fulladdress": "Optional_Field",
"city": "Optional_Field",
"district": "Optional_Field",
"postalcode": "Optional_Field",
"countrycode": "Required_Field",
"nationalid": "Required_Field",
"phone": "Optional_Field",
"state": "Optional_Field",
"email": "Optional_Field",
"gender": "Optional_Field"
},
"message": "200 OK"
}
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
| cascade | integer <int32> |
| countryCode | string |
| source | string |
{- "cascade": 0,
- "countryCode": "string",
- "source": "string"
}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.
The 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.
All 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.
URL PARAMETERS:
| FIELD NAME | DESCRIPTION |
|---|---|
| assignee_id | Show searches assigned to a specific user |
| searcher_id | Show searches performed by a specific user |
| risk_level | Show searches where the risk level is one of the specified options: ('low', 'medium', 'high', 'unknown'). Use commas to separate multiple options, eg and risk_level=medium,high |
| submitted_term | Show searches where the term is unsanitised and includes symbols and punctuation marks |
| match_status | Show searches where the match_status is one of the specified options: ('no_match', 'false_positive', 'potential_match', 'true_positive', 'unknown', 'true_positive_approve', 'true_positive_reject'). Use commas to separate multiple options, eg and match_status=potential_match,true_positive |
| search_term | Searches that match search term (3 characters min) |
| created_at_from | Searches made from date (yyyy-mm-dd) |
| created_at_to | Searches made to date (yyyy-mm-dd) |
| tags | Searches registered against given tags, comma separated represented as 'name:value', eg 'internal_ref:1234' or internal_ref:1234,t_type:custom' |
| client_ref | Show searches with the same client reference |
| monitored | Searches with a specific monitored status, eg. suspended for suspended searches, un-suspended for actively monitored searches and false for searches which are not monitored |
| FIELD NAME | DESCRIPTION |
|---|---|
| sort_by | One of 'id', 'created_at', 'updated_at', 'assignee_id', 'searcher_id' |
| sort_dir | One of 'ASC, 'DESC' |
| FIELD NAME | DESCRIPTION |
|---|---|
| per_page | Number of searches to return per "page" (integer, max 100) |
| page | Which page to fetch (integer) |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
The request should be a JSON object containing the following fields:
search_term: stringfuzziness: doublefilters: objecttags: objectshare_url: integer
JSON Request sample:
{
"search_term": "A Bad Company Ltd",
"fuzziness": 0.6,
"filters": {
"types": [
"sanction",
"warning"
]
},
"tags": {
"name": "value"
},
"share_url": 1
}
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| search_term (required) | String/Object | A string representing the name of the entity or an Object |
| client_ref (optional, max 255 characters)) | String | Your reference for this person/entity for which you are searching. Used for tracking searches and auto-whitelisting recurring results |
| search_profile (optional) | String | The identifier of a search profile (depending on the search profile this is either a slug or a profile id) that can be retrieved from the UI |
| 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) | Object | Specify filters within the search to narrow down the results. These are specified below, and are all optional |
| tags (optional) | Object | Object of name => value pairs (name must be string), must be existing tags |
| filters (optional) | Object | Specify 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) | Boolean | Exact match disables all standard and optional matching behaviours 0% fuzziness disables 1 letter typo matching but keeps all other matching behaviours (standard and optional) |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| types | Array of strings | One or more of: • sanction • warning • fitness-probity • pep • pep-class-1 • pep-class-2 • pep-class-3 • pep-class-4 Classic Adverse Media Taxonomy: • adverse-media • adverse-media-financial-crime • adverse-media-violent-crime • adverse-media-sexual-crime • adverse-media-terrorism • adverse-media-fraud • adverse-media-narcotics • adverse-media-general If you use FATF-aligned Adverse Media Taxonomy: • adverse-media-v2-property • adverse-media-v2-financial-aml-cft • adverse-media-v2-fraud-linked • adverse-media-v2-narcotics-aml-cft • adverse-media-v2-violence-aml-cft • adverse-media-v2-terrorism • adverse-media-v2-cybercrime • adverse-media-v2-general-aml-cft • adverse-media-v2-regulatory • adverse-media-v2-financial-difficulty • adverse-media-v2-violence-non-aml-cft • adverse-media-v2-other-financial • adverse-media-v2-other-serious • adverse-media-v2-other-minor |
| birth_year | Integer | Year of birth, if known |
| remove_deceased | "1" or "0" | A flag which when set, removes deceased people from search results |
| country_codes | Array of ISO 3166-1 alpha-2 strings | Results filtered by nationality or country of residence.Country code filtering applies to: • Entity of type PEP only • Entity of type PEP with Adverse Media • Entity that has 1 country value or more (only one must match) Country code filtering does not apply to (i.e. results will still appear regardless of the country filter): • Entity on sanction lists will always appear regardless of other status (PEP, Adverse media) • Entity that has adverse media mentions only • Entity that does not have a country assigned |
| entity_type | entity_type String (one of):
• "person" • "company" • "organisation" • "vessel" • "aircraft" | Entity type filter is not a hard filter between different entity types. It only optimizes the matching logic to the relevant entity type.Matching: • Depending 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). • Equivalent names considered specifically for different entity types ("Robert" and "Bob" versus "Investment" and "Inversion"). • Initial matching between individual ("Carl W. Litsch") versus company acronyms ("KFC"). Optional: If missing, default rules and logic are applied. |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
URL PARAMETERS:
| FIELD NAME | DESCRIPTION |
|---|---|
| id | Either the numeric search ID, or the search REF |
| id required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
URL PARAMETERS:
| FIELD NAME | DESCRIPTION |
|---|---|
| id | Either the numeric search ID, or the search REF |
| id required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
URL PARAMETERS:
| FIELD NAME | DESCRIPTION |
|---|---|
| id | Either the numeric search ID, or the search REF |
| id required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
URL PARAMETERS:
| FIELD NAME | DESCRIPTION |
|---|---|
| id | Either the numeric search ID, or the search REF |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| is_monitored | Boolean | Start on true and stop on false. For monitored searches, the original search will be updated with the latest results from monitor runs. |
| id required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
URL PARAMETERS:
| FIELD NAME | DESCRIPTION |
|---|---|
| id | Either the numeric search ID, or the search REF |
| date (optional) | The reference date (format: yyyy-mm-dd); if missing, the current day will be used |
| id required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
URL PARAMETERS:
| FIELD NAME | DESCRIPTION |
|---|---|
| id | Either the numeric search ID, or the search REF |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| match_status | String | One of 'unknown', 'no_match', 'potential_match', 'false_positive', 'true_positive', 'true_positive_approve', 'true_positive_reject' |
| risk_level | String | One of 'low', 'medium', 'high', 'unknown' |
| assignee_id | Integer | The ID of the user to whom the case should be assigned |
| limit | Integer | The number of matches retrieved (max. 100) |
| tags | Object | Object of name => value pairs ( name must be string ), must be existing tags |
| id required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
URL PARAMETERS:
| FIELD NAME | DESCRIPTION |
|---|---|
| id | Either the numeric search ID, or the search REF |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| entities | Array | Array of entity ids to be updated (list of strings) |
| match_status | String | One of 'no_match', 'false_positive', 'potential_match', 'true_positive','unknown' |
| risk_level | String | One of 'low', 'medium', 'high', 'unknown' |
| is_whitelisted | Boolean | true or false |
| id required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
URL PARAMETERS:
| FIELD NAME | DESCRIPTION |
|---|---|
| id | Either the numeric search ID, or the search REF |
| id required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
URL PARAMETERS:
| FIELD NAME | DESCRIPTION |
|---|---|
| id | Either the numeric search ID, or the search REF |
| FIELD NAME | TYPE | DESCRIPTION |
|---|---|---|
| comment | String | The comment that will be added |
| entity_id | String | The entity id (required for adding comment on entity) |
| id required | integer <int32> |
| Authorization required | string Default: mPl_X6mXlVfnuXEPZcBOvaNVQgVHMJS7gIWmsKQ-bU5gx5CBU9uD18U4dl1_DpC4GgoEihHNDQ Bearer token |
api/Order/RequestOrder
Fresh Investigations are placed when using speed 1, 3, or 4.
Content will be empty.
The order will be available by EOD on DueDate (Due date can be found in the response).
api/Order/CheckOrderStatus?OrderID={ORDER_ID}
If the order is not ready, the response will show "Status": "0" and the content will be empty.
If the order is ready, the response will show "Status": "1" and the content will be the report content in XML format.
api/company/GetJsonForOrder?OrderId={ORDER_ID}
Retrieves the report in JSON format.
api/Company/ReceivePdfReport?OrderID={ORDER_ID}
Retrieves the report as Base64 encoded PDF data.
Additionally, for ordering "Fresh Investigation" reports, you have two options:
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.
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.
Introduction
Fresh 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.
Webhook Overview
access_token.Sample Webhook Request Following is a sample webhook request that will be received by the configured Client Endpoint. The format is JSON.
{
"Status": 5,
"OrderId": 1471964,
"Content": "
}
Please 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.