Cedar Rose "EIDV Flexible API" has the following Advantages:

Flexible "Search Parameters"
  • Company Name: English, Arabic
  • Address Details: Country, Region, District, Town, Area, Street, Building, P.O. Box, Postal Code
  • Register Details: Country, Organization, Register, Number
  • Name of a Shareholder or a Director (mostly CEO)
"Secondary Parameters"
  • Company Name: English, Arabic
  • Address Details: Country, Region, District, Town, Area, Street, Building, P.O. Box, Postal Code
  • Register Details: Country, Organization, Register, Number
  • Name of a Shareholder or a Director (mostly CEO)

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.

General RESTful Response Guide
  • HTTP Code 200: Success
  • HTTP Code 400: Error
JSON Property Name

JSON property names are case sensitive. Therefore, if the web service expects "Name", then "name" wouldn't be valid.

Example:


{Name: "cedar rose"} // valid
{name: "cedar rose"} // not valid

JSON Property Value

JSON property string values are NOT case sensitive.

Example:


{Name: "cedar rose"} is sme as Name
{name: "Cedar Rose"}

Login

Cedar Rose implements RESTful web services over HTTP, with a JSON response, and thus, we can integrate with any web based solution.

Login Request
  • URL: https://api.cedar-rose.com/api/User/Login
  • Method: POST
  • Header: Content-Type: application/x-www-form-urlencoded
  • Request Body (example): grant_type=password&username=email1@gmail.com&password=P@ssword123
Login Response (example)
  • .expires: Mon, 15 Jun 22:00
  • .issued: Mon, 15 Jun 13:00
  • access_token: BfZPnuyPeZn8e-I…
  • token_type: bearer
  • userName: email@email.com

General EIDV Request

  • Login is 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.
  • https://api.cedar-rose.com/api/Person/FlexibleEIDV
  • 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
FirstName nvarchar(100) First Name
LastName nvarchar(100) Family Name
MiddleName nvarchar(100) Middle Name 1
MiddleName2 nvarchar(100) Middle Name 2
MiddleName3 nvarchar(100) Middle Name 3
MiddleName4 nvarchar(100) Middle Name 4
NationalId nvarchar(100) National ID Number
BirthDate nvarchar(100). Format: Year-Month-Day Date of Birth
CountryId Integer (Required) Country

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:

Property Name Type
Name nvarchar(100)
Evaluation nvarchar(100)
  • The Evaluation Options are: Matching, Not Matching, Not Existing, 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 Existing” in the response.

Turkey EIDV Request

  • Login is required
  • All Request Fields are optional
  • 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.
  • https://api.cedar-rose.com/api/Person/FlexibleEIDV
  • 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
First nvarchar(100) First Name
Last nvarchar(100) Family Name
Mom_first nvarchar(100) Mother First Name
Dad_first nvarchar(100) Father First Name
Gender nvarchar(100) Gender
birth_city nvarchar(100) City of Birth
id_reg_cit nvarchar(100) Registration City
id_reg_dis nvarchar(100) Registration District
add_city nvarchar(100) Address City
add_dist nvarchar(100) Address District
add_heig nvarchar(100) Address Area
str_addr nvarchar(100) Address Street
door_num nvarchar(100) Door Number
year nvarchar(4) Birth Year
month nvarchar(2) Birth Month
day nvarchar(2) Birth Day
Nation_id nvarchar(100) National ID Number

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:

Property Name Type
Name nvarchar(100)
Evaluation nvarchar(100)
  • The Evaluation Options are: Matching, Not Matching, Not Existing, 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 Existing” in the response.
  • DOB should always be sent in 3 separate fields (year, month, day).

Romania EIDV Request

  • Login is required
  • All Request Fields are optional
  • 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.
  • https://api.cedar-rose.com/api/Person/FlexibleEIDV
  • Post
  • Content-Type: application/json
  • Authorization: Bearer AnJ5YlY4NwrYo9V6Pr4IeEOb1K35Y…
  • Kindly Note that you should place the "access_token" in place of the underlined characters

All fields are optional

Name Type Description
NationalId nvarchar Person unique Id (CNP/National ID)
Forename nvarchar Person first name
Surname nvarchar Person last name
DOB nvarchar Person date of birth (date format: yyyy-mm-dd)
Phone nvarchar Person phone number

{
"statusCode":200,
"Response":"{\"Found\":true}",
"ErrorMessage":null
}

Russia EIDV Request

  • Login is required
  • All Request Fields are optional
  • 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.
  • https://api.cedar-rose.com/api/Person/FlexibleEIDV
  • 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
fullName nvarchar(80) Person Full Name
surname nvarchar(40) Person last Name
name nvarchar(40) Person first Name
patronymic nvarchar(40) Person Middle Name
birthDate nvarchar(10) YYYY-MM-DD
pNumber nvarchar(10) Internal Passport Number
iNumber nvarchar(12) INN number

{ statusCode:200 Response{ {"isFound":true} }

Supporting Functions

  • URL: https://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/towns
  • 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)
  • Required JSON Parameters: idCountry, idCountryRegion, idDistrict.
  • Response: ID (int), Town (String)