Introduction
Cedar Rose "Company Flexible API" has the following Advantages:
RESTful Web Services
Cedar Rose implements RESTful web services over HTTP, with a JSON response, and thus, we can integrate with any web based solution.
LOGIN
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 with all other requests henceforth and the response will be in JSON.
Company Quick Search
- No need to login - A request returns zero to 100 records. Therefore, "Page" and "PageSize" are not needed.
- api.cedar-rose.com/api/company/CompanyQuickSearch
- Post
- Content-Type: application/json
(application/x-www-form-urlencoded)
| Name | Type | Description | Required |
| Name | string | English name, Arabic name, or register number. Can contain % in the start, middle, and/or end. | Required |
| CountryID | integer | Country Filter | optional (required, if searching by register number) |
| 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 similar to the search filter |
| CommedricalRegister | 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) |
Company Flexible Search
- No need to login- If not fine-tuned, a request might return thousands of records. Therefore, "Page" and "PageSize" should be provided. “Page” is the page number, and “PageSize” is the number of items per page. If not provided, "Page" and "PageSize" will both have a value of 1, so it will only return one record. Moreover, "PageSize" valid value ranges from 1 to 50.
- api.cedar-rose.com/api/company/FlexibleSearchCompany
- Post
- Content-Type: application/json
| Name | Type | Description | Required |
| SelectFields | array of strings | Columns of the response. Example: companyname, CountryName (complete list available in sample) | Required |
| AllFilters | array of objects (Filter: FilterName, FilterValues) | List of filters | Required |
| FilterName | string | Example: companyname, RegisterNumber (complete list available in sample) | Required |
| FilterValues | array of objects (From, To) | Required | |
| From | String | if the filter is not a range, this parameter is considered as the filter value | Required |
| To | String | this parameter is only filled if he filter contains a range | Optional |
| Name | Type | Description |
| CompanyName | String | Company English Name |
| CompanyLocalName | String | Company Arabic Name |
| UID | String | country code + Cedar Rose reference number |
| CountryName | String | Country Name |
| RegisterNumber | String | Main Commercial Register Number |
| IDATOM | String | Cedar Rose Company ID (serial number) |
| ManagerName | String | Manager Name |
| LegalFormID | String | the serial number of the company Legal Form |
Company Available Data
This company returns:
Person Directorship/Shareholding Search
- login is needed-
- api.cedar-rose.com/api/Person/PersonSearch
- Post
- Content-Type: application/json
| Name | Type | Description | Required |
| FirstName | nvarchar(50) | No | |
| MiddleName | nvarchar(50) | No | |
| LastName | nvarchar(50) | No | |
| UID | nvarchar(50) | No | |
| YearOfbirth | int | No | |
| MonthOfBirth | int | No | |
| DayOfBirth | int | No | |
| IsFormer | bit | No | |
| isExact | bit | No | |
| LanguageId | int | No | |
| IdentityNumber | nvarchar(50) | No | |
| NationalityCountryId | int | No |
| Name | Type | Description |
| FirstName | nvarchar(50) | |
| MiddleName | nvarchar(50) | |
| LastName | nvarchar(50) | |
| UID | nvarchar(50) | |
| YearOfbirth | int | |
| MonthOfBirth | int | |
| DayOfBirth | int | |
| IsFormer | bit | |
| isExact | bit | |
| LanguageId | int | |
| IdentityNumber | nvarchar(50) | |
| NationalityCountryId | int |
Place Order (or Download)
- login is required
- api.cedar-rose.com/api/Order/RequestOrder
- Post
- Content-Type: application/json
- Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y…
- Kindly Note that you should place the "access_token" in place of the underlined characters
| Name | Type | Description | Required |
| SubjectName | String | The available name of the company | Required to include either SubjectName or IDATOM |
| ProductId | String | serial number of the requested product (example: 284 is the serial number of Company Credit Report) | Required |
| SpeedId | String | serial number of the requested Speed (example: 1 is the serial number of the redular speed) | Required |
| SubjectCountryID | String | serial number of the Country of the order | Required |
| IDATOM | String | serial number of the company (if available) | Required to include either SubjectName or IDATOM |
| AdditionalInfo | String | additional info that you would like to include in your request | Optional |
| SubjectDetails | String | available details about the company | Optional |
| TradingName | String | available trading names of the company | Optional |
| CustomerReference | String | could be your serial number or project ID or purchase number or just "0" | required |
| 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 |
| Currency | String | Currency (ISO 4217 Currency Code) |
| OrderID | Int | Order ID of the placed order |
| Content | String (XML) | you will receive xml design separately according to the product |
Supporting Functions
- URL: api.cedar-rose.com/api/common/Categories
- Method: GET
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Response: ID (int), Name (String)
- URL: api.cedar-rose.com/api/common/Products
- Method: GET
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Append to URL: CategoryId (int) [0=All Company Products or 99=All Person Products or CategoryId], required)
- Response: ID (int), Name (String)
- URL: api.cedar-rose.com/api/common/Speeds
- Method: GET
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Response: ID (int), Name (String)
- URL: api.cedar-rose.com/api/Order/GetPricebySpeedId
- Method: POST
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- JSON Parameters: ProductId, SpeedId, SubjectCountryID (String, Required). example: {"ProductId": "284", "SpeedId": "2", "SubjectCountryId": "9"}
- Response: amount (decimal)
- URL: api.cedar-rose.com/api/Order/OrderDueDate
- Method: POST
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- JSON Parameters: ProductId, SpeedId, SubjectCountryID (String, Required). example: {"ProductId": "284", "SpeedId": "2", "SubjectCountryId": "9"}
- Response: DueDate (date)
- URL: https://api.cedar-rose.com/api/company/AvailableSectionsByUIDProduct
- Method: POST
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Append to URL: UID (String), ProductId (int)
- Response: XML of the Product Available Sections
- URL: api.cedar-rose.com/api/common/countries
- Method: GET
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Response: ID (int), Country (String)
- URL: https://api.cedar-rose.com/api/common/Nationalities
- Method: GET
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Response: ID (int), Nationality (String), CountryID (String)
- URL: api.cedar-rose.com/api/Common/Organizations
- Method: GET
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Response: ID (int), Name (String)
- URL: api.cedar-rose.com/api/Common/Registers
- Method: GET
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Append to URL: IDOrganisation, CountryID
- Response: ID (int), Name (String)
- URL: api.cedar-rose.com/api/Common/LegalForms
- Method: GET
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Append to URL: CountryID
- Response: ID (int), CountryID(int), Name (String)
- URL: https://api.cedar-rose.com/api/client/GetClientBalances
- Method: POST
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Response: AccountBalance (String), Discount (String), DownloadBalance (String), CurrencyID (String), CurrencySymbol (String), CurrencyName (String)
- URL: https://api.cedar-rose.com/api/client/GetClientOrders
- Method: POST
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Response: MainName (String), DateUpdated(String), IsAvailable (Boolean)
- URL: https://api.cedar-rose.com/api/order/CheckOrderStatus
- Method: POST
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Append to URL: OrderID (int)
- Response: Status (int), Content (XML of the Report)
- URL: https://api.cedar-rose.com/api/order/sendOrderReport
- Method: POST
- Header Content-Type: application/json
- Header Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y… (Kindly Note that you should place the "access_token" in place of the underlined characters)
- Append to URL: OrderID (int)
- Response: PDF File
FAQs
Please note that our database contains millions of records and when the API searches a company name it also searches the trading names, the former names, the branch names and so on.
- use the “country” filter in your API company searches.
- try to avoid searching for companies using “one word” only.
- if you use “one word” searches or short searches, please avoid using words that are very common, example “International” which is present in thousands of companies names in all the countries we cover.
- avoid using the “contains” filter when you can use other options like “Exact”, “Starts With”, “Ends With”. Example: you can search for “Cedar Rose%” instead of “%Cedar Rose%” when searching for Cedar Rose Int. Services Ltd.
- We are referring to native/Arabic as we are adding Persian names in our database to companies and individuals.
- When Searching for an Individual:
Searching through our API will enable users to use both native/Arabic and Latin/Romanised characters when searching for an individual relations for Directorship/Shareholding in our database.
The result returns findings in the same language used for searching i.e. either Arabic or Latin/Romanised as searched.
We believe the search language option will add greater accuracy for matching even if the search used is a fuzzy search. I believe fuzzy searches are usually done when the analyst is not sure of the spelling and particularly when converting from native i.e. Arabic to Latin/Romanised characters, but in this case of ours, we offer searching with both types characters.
- When Searching for a company:
Currently searching through our API enables users to use Latin/Romanised characters only when searching for a company relations for Directorship/Shareholding. However, we have scheduled and by end of December for this service to also offer native/Arabic as well as the Latin/Romanised characters search.
.