Register API NAV

Register API v2.1.5

API Endpoint:

https://graph.ir.ee

The Register API allows apps to read from the Inforegister graph. It is organized around REST and designed to have predictable, resource-oriented URLs. The API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

Basic Authentication

Example Authorization header:

Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Authentication for the API can occur via HTTP Basic Auth. Include Base64 encoded authentication key provided in HTTP Authorization field:

OAuth 2.0 Authentication for Applications

Example Authorization header (token shortened for clarity):

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiOTQ3NTZmZS0wYjA5LTQxZDAtO…

Authentication for the API can occur via OAuth 2.0 client authorization grant using JSON Web Token (JWT). This authentication method is meant to be used by information systems that need to generate Graph API keys on behalf of third-party clients without additional login.

For client credentials grant the following steps are needed:

  1. Create JSON Web Token (JWT) for token request
  2. Make token request with client JSON Web Token (JWT)
  3. Make API request with retrieved token

When the access token expires, a new access token must be requested by repeating the steps described above. When token expires Graph API will respond with error 401 Unauthorized, indicating the token is no longer valid and a new one needs to be requested.

Prerequisites

In order to request Graph API key for third-party clients the application needs to be registered as an authorized client in our authorization server. For registration please contact support@ir.ee.

For application registration PKCS8 format private and public key pairs are needed. This key pair has to be generated by the client. Private key has to be kept secret and is the responsibility of the client.

During registration the client will forward generated public key and receive client identifier value to use for token requests.

Create JSON Web Token (JWT)

JSON Web Token (JWT) setup

{Base64url encoded header}.{Base64url encoded claim set}.{Base64url encoded signature}

A JWT consists of three parts: a header, a claim set, and a signature. The header and claim set are JSON objects, which are encoded using the Base64url encoding. The signature is computed based on the header and claim set Base64url encoded values. The header, claim set, and signature are concatenated together with a period (.) character.


JWT header

JSON representation of the JWT header

{"alg":"RS256","typ":"JWT"}

Corresponding Base64url encoded value of that JWT Header

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9

The header contains two fields: the signature algorithm and the type. Both fields are mandatory and have to contain single specific value. The OAuth 2.0 authentication authorization server for Graph API expects RSA SHA-256 algorithm and the JWT token format to be used.


JWT claim set

Example JWT claim (Line breaks have been added for clarity)

{
    "iss": "https://graph.ir.ee/organizations/ee-11735006",
    "sub": "https://graph.ir.ee/organizations/ee-11016228",
    "aud": "https://id.ir.ee",
    "exp": 1495712778,
    "iat": 1495701678,
    "name": "Zero Technologies OÜ",
    "given_name": "Piret",
    "family_name": "Lattikas",
    "email": "piret.lattikas@zerotech.ee"
}

Corresponding Base64url encoded value of the example claim set

eyJpc3MiOiJodHRwczovL2dyYXBoLmlyLmVlL29yZ2FuaXphdGlvbnMvZWUtMTE3MzUwMDYiLCJzdWIiOiJodHRwczovL2dyYXBoLmlyLmVlL29yZ2FuaXphdGlvbnMvZWUtMTEwMTYyMjgiLCJhdWQiOiJodHRwczovL2lkLmlyLmVlIiwiZXhwIjoxNDk1NzEyNzc4LCJpYXQiOjE0OTU3MDE2NzgsIm5hbWUiOiJaZXJvIFRlY2hub2xvZ2llcyBPw5wiLCJnaXZlbl9uYW1lIjoiUGlyZXQiLCJmYW1pbHlfbmFtZSI6IkxhdHRpa2FzIiwiZW1haWwiOiJwaXJldC5sYXR0aWthc0B6ZXJvdGVjaC5lZSJ9

JWT calim set contains information about the claim, including the issuer and subject of the token. JWT claim is also a JSON object, which has the following fields:

Name Type Required Description
iss string  yes Issuer of the token, reference to client organization.
sub  string yes  Subject reference on behalf of whom the token is requested.
aud  string  yes  Target of the token, has to be set to match authorization server.
exp  long yes Expiration time, should be small enough value to ensure the request token expires after id_token is received.
iat  long yes  Time when the token was issued.
name string no Full name of the subject.
given_name  string  no  Given name of the end-user, required for inforegister scope.
family_name  string  no  Family name of the end-user, required for inforegister scope.
email  string  yes  yes

NB! The dates have to be represented by the number of seconds from 1970-01-01T00:00:00Z UTC until the specified UTC date/time, ignoring leap seconds. (Seconds Since the Epoch)


JWT signature

JWT signature input

{Base64url encoded header}.{Base64url encoded claim set}

Example JWT signature input

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2dyYXBoLmlyLmVlL29yZ2FuaXphdGlvbnMvZWUtMTE3MzUwMDYiLCJzdWIiOiJodHRwczovL2dyYXBoLmlyLmVlL29yZ2FuaXphdGlvbnMvZWUtMTEwMTYyMjgiLCJhdWQiOiJodHRwczovL2lkLmlyLmVlIiwiZXhwIjoxNDk1NzEyNzc4LCJpYXQiOjE0OTU3MDE2NzgsIm5hbWUiOiJaZXJvIFRlY2hub2xvZ2llcyBPw5wiLCJnaXZlbl9uYW1lIjoiUGlyZXQiLCJmYW1pbHlfbmFtZSI6IkxhdHRpa2FzIiwiZW1haWwiOiJwaXJldC5sYXR0aWthc0B6ZXJvdGVjaC5lZSJ9

Generated signature based on the example input in Base64 encoding

xZPW_hFPv-G-5UPl7o6akuAU1P80oCgPhkJi-D0gglwdwytHqJvaONESMD7Pq8a6KiZ1YaqfbqMAyIkdAB5_u1F5-Ns3PLE3e9AnquyXdmJ69SNS0L4viIgYmHUIoZWYinU6IkViv44ikRb1a7EavLNefLPGlXBreDBALSl-RL4

The thorough guide for generation the signature of the JWT is JSON Web Signature (JWS) specification.

The algorithm used for signing must be RSA using SHA-256 hashing algorithm. Sign the input with SHA256withRSA function using the private key generated when registering application as an authorization server client.

The output of signing function is a byte array, which has to be then Base64url encoded.

For full JWT the Base64url encoded header, Base64url encoded claim set and Base64url encoded signature are concatenated together with a period (.) character.

Make token request

Full JWT token example based on above example header, claim set and signature

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2dyYXBoLmlyLmVlL29yZ2FuaXphdGlvbnMvZWUtMTE3MzUwMDYiLCJzdWIiOiJodHRwczovL2dyYXBoLmlyLmVlL29yZ2FuaXphdGlvbnMvZWUtMTEwMTYyMjgiLCJhdWQiOiJodHRwczovL2lkLmlyLmVlIiwiZXhwIjoxNDk1NzEyNzc4LCJpYXQiOjE0OTU3MDE2NzgsIm5hbWUiOiJaZXJvIFRlY2hub2xvZ2llcyBPw5wiLCJnaXZlbl9uYW1lIjoiUGlyZXQiLCJmYW1pbHlfbmFtZSI6IkxhdHRpa2FzIiwiZW1haWwiOiJwaXJldC5sYXR0aWthc0B6ZXJvdGVjaC5lZSJ9.xZPW_hFPv-G-5UPl7o6akuAU1P80oCgPhkJi-D0gglwdwytHqJvaONESMD7Pq8a6KiZ1YaqfbqMAyIkdAB5_u1F5-Ns3PLE3e9AnquyXdmJ69SNS0L4viIgYmHUIoZWYinU6IkViv44ikRb1a7EavLNefLPGlXBreDBALSl-RL4

After composing JWT token it can be used for id_token request. Token request is a HTTPS POST request.
Request is made to the authorization server token endpoint: https://id.ir.ee/token
Request should contain header Content-Type: application/x-www-form-urlencoded and the parameters sent with the request have to be url encoded.

Request

Example request for client identifier example

POST /token HTTP/1.1
Host: id.ir.ee
Content-Type: application/x-www-form-urlencoded

grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Ajwt-bearer&client_id=example&scope=graph-api%20inforegister&assertion=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2dyYXBoLmlyLmVlL29yZ2FuaXphdGlvbnMvZWUtMTE3MzUwMDYiLCJzdWIiOiJodHRwczovL2dyYXBoLmlyLmVlL29yZ2FuaXphdGlvbnMvZWUtMTEwMTYyMjgiLCJhdWQiOiJodHRwczovL2lkLmlyLmVlIiwiZXhwIjoxNDk1NzEyNzc4LCJpYXQiOjE0OTU3MDE2NzgsIm5hbWUiOiJaZXJvIFRlY2hub2xvZ2llcyBPw5wiLCJnaXZlbl9uYW1lIjoiUGlyZXQiLCJmYW1pbHlfbmFtZSI6IkxhdHRpa2FzIiwiZW1haWwiOiJwaXJldC5sYXR0aWthc0B6ZXJvdGVjaC5lZSJ9.xZPW_hFPv-G-5UPl7o6akuAU1P80oCgPhkJi-D0gglwdwytHqJvaONESMD7Pq8a6KiZ1YaqfbqMAyIkdAB5_u1F5-Ns3PLE3e9AnquyXdmJ69SNS0L4viIgYmHUIoZWYinU6IkViv44ikRb1a7EavLNefLPGlXBreDBALSl-RL4
Name Required Description
grant_type yes  For client credentials grant this fields value has to be set to urn:ietf:params:oauth:grant-type:jwt-bearer
client_id yes  Client identifier received during client application registration
scope yes  Scope for which token is requested. Different scopes are separated with space. Possible scopes are described below.
assertion yes  The composed JWT with the signature

The scopes that a specific client will have rights to request access to will be provided during client application registration.

Available scopes

Name Description
graph-api For Graph API HTTP GET endpoints access
inforegister For Inforegister user account access

Response

Example success response (Line breaks added and id_token shortened for clarity)

{
    "id_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiOTQ3NTZmZS0w...",
    "scope": "graph-api inforegister",
    "token_type": "Bearer"
}

Response on a successful request is a JSON object with the following parameters:

Name Required Description
id_token  yes Bearer token to be used for Graph API requests authentication
scope  yes  Specifies the allowed scopes for this token. Multiple scopes are separated by space
token_type  yes Specifies the type of the id_token, which in current case will and should always be Bearer, indicating that this token can be used as bearer token.

In case of an invalid request the reponse from authorization server is HTTP 400 Bad Request. The error response body will contain one of the following error code in plain text:

Code Description
MISSING_GRANT_TYPE No grant_type parameter was provided with the request
UNKNOWN_GRANT_TYPE grant_type parameter contained unknown value
MISSING_CLIENT_ID  No client_id parameter was provided with the request
UNREGISTERED_CLIENT Client identifier provided has not been registered for authorization server
UNAUTHORIZED_CLIENT  Client is not allowed to perform authorization from specified grant_type
SCOPE_MISSING Scope parameter is missing or empty
INVALID_SCOPE Client does not have permission for requested scope(s)
UNAUTHORIZED_ACCOUNT  Subject account does not have rights for requested scopes

Make API request

Example Graph API request to endpoint https://graph.ir.ee/oauth/organizations/ee-11735006
(Token has been shortened for clarity)

GET /oauth/organizations/ee-11735006 HTTP/1.1
Host: graph.ir.ee
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiOTQ3NTZmZS0w...

With the received id_token client application can now make requests to Graph API HTTP GET endpoints. For making request with OAuth Bearer token /oauth prefix needs to be added to the request path as the first URL element.
/oauth endpoint corresponds to API version v3.

The received token should be added to the authorization header as a bearer token.

If the API responds with error 401 Unauthorized and containing error regarding expired token, a new JWT token needs to be requested.

Response codes

API key access errors:

Invalid user credentials error with code 401:

{
    "error": "User not authorised"
}

Expired token error with code 401:

{
    "error": "Bearer token has expired"
}

Unauthorized node (e.g. /contacts) or method (e.g. POST) error with code 403:

{
    "error": "Access to this resource has been disallowed"
}

Rate limit (i.e. API calls per minute) exceeded error with code with code 403:

{
    "error": "Rate limit exceeded"
}

Quota (i.e. API calls per month) exceeded error with code 403:

{
    "error": "Quota exceeded"
}
Code Status Description
200 OK Everything worked as expected
201 Created A new resource has successfully been created. Returns a Location header with a link to the newly created resource
204 No Content Query returned an empty result
400 Bad Request Request could not be understood by the server due to malformed syntax
401 Unauthorized User is not authorized to perform the request
403 Forbidden Access denied for User
404 Not Found API endpoint with specified URL does not exist
500 Internal Error Internal server error

Response sorting

Response can be sorted by adding request parameter "_sort".
"_sort" accepts multiple comma separated parameters.
"_sort=sortProperty"
"_sort=propertyA,propertyB"
"sortProperty" is a parameter which represents property by which response will be sorted.
To reverse the sort order, add "-" in front of the sort parameter.

https://graph.ir.ee/organizations?legal-name=register&_sort=legalName

The result can be sorted by response properties. If default response order should be changed, sort parameter can be added at the end of the request. Sort parameter should match the label of the response field, based on which the result list should be sorted.

Sort parameter

{
   "result":{
      "items":[
         {"...": "..."},
         {
            "_about":"https://graph.ir.ee/organizations/ee-10481070",
            "legalName":"LLOYD'S REGISTER OF SHIPPING EESTI FILIAAL"
         },
         {
            "_about":"https://graph.ir.ee/organizations/ee-11641894",
            "legalName":"LUNIN REGISTER OÜ"
         },
         {
            "_about":"https://graph.ir.ee/organizations/ee-11400820",
            "legalName":"MAKSEHÄIREREGISTER OÜ"
         },
         {"...": "..."}
      ]
   }
}
Name Description
_sort Identifies response properties by which result will be sorted. Multiple properties are comma separated.

Pagination

Page size can be changed to 1-200 by adding query parameter "_pageSize" to the request URI.

https://graph.ir.ee/organizations/ee-11735006/bankruptcy-risk-scores.json?_page=1&min-date=2015-02-14&max-date=2015-09-20&_pageSize=200

Results will be separated into multiple pages if there are more items per page than the limit (default is 50, maximum is 200). Pagination properties are added at the end of the response.

Pagination properties

Example pagination properties:
{
    "...": "...",

    "itemsPerPage": 50, 
    "next": "https://graph.ir.ee/organizations/ee-11735006/bankruptcy-risk-scores.json?_page=1&min-date=2015-02-14&max-date=2015-09-20", 
    "page": 0, 
    "startIndex": 1, 
    "totalResults": 121,

    "...": "..."
}
Name Description
itemsPerPage Number of items per page. Default is 50.
next URI to the next page. Only present if there are multiple pages of results.
page Current page number.
startIndex Starting item number of the page
totalResults Total number of items

Versioning

Example of the unversioned request URL:

https://graph.ir.ee/organizations/ee-11735006

When changes to existing endpoints are made, new version of the API will be released. Previous version endpoint will be supported up to two years.

The API version should be specified by setting it as the first URL element. By default requests to unversioned endpoints will be made against the latest version.

The current documentation endpoint URL’s and examples refer to the latest API version.

Currently supported versions

Example  of the versioned request URLs:

https://graph.ir.ee/v2/organizations/ee-11735006

https://graph.ir.ee/v3/organizations/ee-11735006

Version Description
v1 Initial version of the API (no longer available)
v2 Second version of the API including JSON response date and dateTime format changes
v3 Third version of the API including locations, addresses and address objects structure changes

Inserting a debt

In order to insert a new debt complete the following steps:

  1. Insert initial debt record
  2. Insert debt claim to the debt record
  3. Insert supporting document to the debt claim record
  4. Repeat steps 2 and 3 until all claims regarding the debt record have been added
  5. If needed insert additional organization data
  6. If needed insert additional person data
  7. Finalize inserting debt record

API services

/address-components

Get address components data (Available only through API v3)

Request

Make a HTTP GET to URL

https://graph.ir.ee/address-components/{address-component-id}

Name Type Required Description
address-component-id string yes Identificator of an address component in the national address information system (ADS)

Response

Example query:

https://graph.ir.ee/address-components/1-37

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "componentLevel": "1",
            "componentCode": "37",
            "componentName": "Harju maakond",
            "componentFullName": "Harju maakond",
            "created": "2013-06-17T19:50:40Z",
            "modified": "2014-12-18T16:20:51Z"
        }
    }
}
Name Type Required Description
componentLevel string yes Address component’s hierarchical level
componentCode string yes Address component code in the 32-system. It consists from one up to four characters.
componentName string yes Address component name with the generic term of the acronym as a generic term, if exists.
componentFullName string yes Address component name with a generic term in accordance with the law the prescribed form. Name of a type or its abbreviation, in the absence of equal named.
created dateTime yes Creation date of the address component record
modified dateTime yes As of date of the address component record

/address-objects

Search address objects by type and source id (Available only through API v3)

Request

Make a HTTP GET to URL

https://graph.ir.ee/address-objects?addressObjectType={address-object-type}&origId={original-data-source-id}

Name Type Required Description
address-object-type string yes Identificator of an address object type in the national address information system (ADS). To search for all types use “.*”
original-data-source-id string yes Original characteristic. To search for all source id’s use “.*”

Response

Example query:

https://graph.ir.ee/address-objects?addressObjectType=CU&origId=76001:002:0460

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "oid": "CU00434196",
                "addressObjectType": "CU",
                "origId": "76001:002:0460",
                "fullAddress": "Viljandi maakond, Suure-Jaani vald, Suure-Jaani linn, Lai tn 9",
                "hasLocation": "https://graph.ir.ee/addresses/618072",
                "location":{
                    "x": "6489510.35",
                    "y": "585897.53"
                },
                "hasObjectSite": "https://graph.ir.ee/sites/ee-11896590-registered",
                "duration":{
                    "hasBeginning": {
                        "inXSDDateTime": "2013-04-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                },
                "hasPreviousVersion": "https://graph.ir.ee/address-objects/cu00465196",
                "hasNextVersion": "https://graph.ir.ee/address-objects/cu00465198",
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
oid string yes Identificator of an address object in the national address information system (ADS), identifies over all object types.
addressObjectType string yes Identificator of an address object type in the national address information system (ADS)
origId string no Original object identifier in the source registry. Identifies objects within a type
fullAddress string yes Full address in textual format
hasLocation string no Reference to related address
location object no Address location in L-EST coordinate system
x string no X coordinate in L-EST coordinate system
y string no Y coordinate in L-EST coordinate system
hasObjectSite string no Reference to related site address
duration object no Interval for which the address object is/was valid
hasBeginning object no Address valid object from date
hasEnd object no Address valid object until date
hasPreviousVersion URI no Previous version of address object. Can include a single instance or an array of records.
hasNextVersion URI no Next version of address object. Can include a single instance or an array of records.
modified dateTime yes As of date of the address object record
created dateTime yes Creation date of the address object record

Search address objects by type within the radius of the point (Available only through API v3)

Request

Make a HTTP GET to URL

https://graph.ir.ee/address-objects?addressObjectType={address-object-type}&radius={radius}&latitude={lat}&longitude={lon}

Name Type Required Description
address-object-type string yes Identificator of an address object type in the national address information system (ADS). To search for all types use “.*”
radius string yes Search radius, in meters
lat string yes Latitude of the starting point, L-EST coordinate system
lon string yes Longitude of the starting point, L-EST coordinate system

Response

Example query:

https://graph.ir.ee/address-objects?addressObjectType=CU&radius=10&latitude=6489510.35&longitude=585897.53

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "oid": "CU00434196",
                "addressObjectType": "CU",
                "origId": "76001:002:0460",
                "fullAddress": "Viljandi maakond, Suure-Jaani vald, Suure-Jaani linn, Lai tn 9",
                "hasLocation": "https://graph.ir.ee/addresses/618072",
                "location":{
                    "x": "6489510.35",
                    "y": "585897.53"
                },
                "hasObjectSite": "https://graph.ir.ee/sites/ee-11896590-registered",
                "duration":{
                    "hasBeginning": {
                        "inXSDDateTime": "2013-04-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                },
                "hasPreviousVersion": "https://graph.ir.ee/address-objects/cu00465196",
                "hasNextVersion": "https://graph.ir.ee/address-objects/cu00465198",
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
oid string yes Identificator of an address object in the national address information system (ADS), identifies over all object types.
addressObjectType string yes Identificator of an address object type in the national address information system (ADS)
origId string no Original object identifier in the source registry. Identifies objects within a type
fullAddress string yes Full address in textual format
hasLocation string no Reference to related address
location object no Address location in L-EST coordinate system
x string no X coordinate in L-EST coordinate system
y string no Y coordinate in L-EST coordinate system
hasObjectSite string no Reference to related site address
duration object no Interval for which the address object is/was valid
hasBeginning object no Address valid object from date
hasEnd object no Address valid object until date
hasPreviousVersion URI no Previous version of address object. Can include a single instance or an array of records.
hasNextVersion URI no Next version of address object. Can include a single instance or an array of records.
modified dateTime yes As of date of the address object record
created dateTime yes Creation date of the address object record

Get address object data (Available only through API v2)

Request

Make a HTTP GET to URL

https://graph.ir.ee/address-object/{ADS_OID}

Name Type Required Description
ADS_OID string yes Id of the address object

Response

Example query:

https://graph.ir.ee/address-object/cu03240012

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "oid": "CU03240012",
            "fullAddress": "Harju maakond, Tallinna linn, Nõmme linnaosa, Trummi tn 11b",
            "hasAddress": "https://graph.ir.ee/addresses/343100",
            "hasLocation": "https://graph.ir.ee/locations/harju-maakond-tallinn-nomme-linnaosa-trummi-tn-11b",
            "created": "2013-06-17T19:50:40Z",
            "modified": "2014-12-18T16:20:51Z"
        }
    }
}
Name Type Required Description
oid string yes Address object Id
fullAddress string yes Full address in textual format
hasAddress string yes Address URL
hasLocation string no Address URL
created dateTime no Creation date of the address object record
modified dateTime no As of date of the address object record

Get address object data (Available only through API v3)

Request

Make a HTTP GET to URL

https://graph.ir.ee/address-objects/{ads-oid}

Name Type Required Description
ads-oid string yes Identificator of an address object in the national address information system (ADS), identifies over all object types.

Response

Example query:

https://graph.ir.ee/address-objects/cu00465197

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "oid": "CU00465197",
            "addressObjectType": "CU",
            "origId": "78405:501:3520",
            "fullAddress": "Harju maakond, Tallinn, Mustamäe linnaosa, Ehitajate tee 86",
            "hasLocation": "https://graph.ir.ee/addresses/2123811",
            "location":{
                "x": "6585774.53",
                "y": "537989.70"
            },
            "hasObjectSite": "https://graph.ir.ee/sites/ee-11896590-registered",
            "duration":{
                "hasBeginning": {
                    "inXSDDateTime": "2013-04-13T00:00:00Z"
                },
                "hasEnd": {
                    "inXSDDateTime": "2014-01-12T00:00:00Z"
                }
            },
            "hasPreviousVersion": "https://graph.ir.ee/address-objects/cu00465196",
            "hasNextVersion": "https://graph.ir.ee/address-objects/cu00465198",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
oid string yes Identificator of an address object in the national address information system (ADS), identifies over all object types.
addressObjectType string yes Identificator of an address object type in the national address information system (ADS)
origId string no Original object identifier in the source registry. Identifies objects within a type
fullAddress string yes Full address in textual format
hasLocation string no Reference to related address
location object no Address location in L-EST coordinate system
x string no X coordinate in L-EST coordinate system
y string no Y coordinate in L-EST soordinate system
hasObjectSite string no Reference to related site address
duration object no Interval for which the address object is/was valid
hasBeginning object no Address object valid from date
hasEnd object no Address object valid until date
hasPreviousVersion URI no Previous version of address object. Can include a single instance or an array of records.
hasNextVersion URI no Next version of address object. Can include a single instance or an array of records.
modified dateTime yes As of date of the address object record
created dateTime yes Creation date of the address object record

Get address object organizations

Request

Make a HTTP GET to URL

https://graph.ir.ee/address-objects/{ads-oid}/organizations

Name Type Required Description
ads-oid string yes Identificator of an address object in the national address information system (ADS), identifies over all object types.

Response

Example query:

https://graph.ir.ee/address-objects/er01706684/organizations

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            "https://graph.ir.ee/organizations/ee-10279799",
            "..."
        ]
    }
}
Name Type Required Description
items array yes URIs organization subjects

/addresses

Search for addresses (Available only through API v3)

Request

Make a HTTP GET to URL

https://graph.ir.ee/addresses?street-address={street-name}&locality={city-name}&region={county-name}

Name Type Required Description
street-name string yes Street name. To search for all streets use “.*”
city-name string yes City name. To search for all cities use “.*”
county-name string yes County name. To search for all counties use “.*”

Response

Example query:

https://graph.ir.ee/addresses?street-address=ehitajate+tee+86&locality=tallinn&region=harju

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "adr_id": "2123811",
                "codeAddress": "37784048200000JYH00003EMZ00000000",
                "fullAddress": " Harju maakond, Tallinn, Mustamäe linnaosa, Ehitajate tee 86",
                "countryName": "Eesti",
                "locality": "Tallinn",
                "postalCode": "12915",
                "region": "Harjumaa",
                "streetAddress": "Ehitajate tee 86",
                "hasComponent": "https://graph.ir.ee/address-components/1-37",
                "latitude": "59.408175",
                "longitude": "24.668858",
                "location":{
                    "x": "6585774.21",
                    "y": "537986.86"
                },
                "hasPreviousVersion": "https://graph.ir.ee/addresses/101860",
                "hasNextVersion": "https://graph.ir.ee/addresses/246801",
                "duration":{
                    "hasBeginning": {
                        "inXSDDateTime": "2013-04-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                },
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
adr_id string yes Identificator of an address in the national address information system (ADS)
codeAddress string yes Encoded address
fullAddress string yes Full address in textual format
countryName string no Country name
locality string no The locality (e.g. city or town)
postalCode string no Postal code. Can include a single instance or an array of records
region string no Region (e.g. state or province)
streetAddress string no Street address
hasComponent URI no Reference to related address components. Can include a single instance or an array of records
latitude string no X coordinate in wgs84 coordinate system
longitude string no Y coordinate in wgs84 coordinate system
location object no Address location in L-EST coordinate system
x string no X coordinate in L-EST coordinate system
y string no Y coordinate in L-EST coordinate system
hasPreviousVersion URI no Previous version of address. Can include a single instance or an array of records.
hasNextVersion URI no Next version of address. Can include a single instance or an array of records.
duration object no Interval for which the address is/was valid
hasBeginning object no Address valid from date
hasEnd object no Address valid until date
modified dateTime yes As of date of the address record
created dateTime yes Creation date of the address record

Search addresses by coordinates and radius (Available only through API v3)

Request

Make a HTTP GET to URL

https://graph.ir.ee/addresses?radius={radius}&latitude={lat}&longitude={lon}

Name Type Required Description
radius string yes Search radius, in meters
lat string yes Latitude of the starting point, WGS84 coordinate system
lon string yes Longitude of the starting point, WGS84 coordinate system

Response

Example query:

https://graph.ir.ee/addresses?radius=10&latitude=58.675647&longitude=24.734627

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "adr_id": "2123811",
                "codeAddress": "37784048200000JYH00003EMZ00000000",
                "fullAddress": " Harju maakond, Tallinn, Mustamäe linnaosa, Ehitajate tee 86",
                "countryName": "Eesti",
                "locality": "Tallinn",
                "postalCode": "12915",
                "region": "Harjumaa",
                "streetAddress": "Ehitajate tee 86",
                "hasComponent": "https://graph.ir.ee/address-components/1-37",
                "latitude": "59.408175",
                "longitude": "24.668858",
                "location":{
                    "x": "6585774.21",
                    "y": "537986.86"
                },
                "hasPreviousVersion": "https://graph.ir.ee/addresses/101860",
                "hasNextVersion": "https://graph.ir.ee/addresses/246801",
                "duration":{
                    "hasBeginning": {
                        "inXSDDateTime": "2013-04-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                },
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
adr_id string yes Identificator of an address in the national address information system (ADS)
codeAddress string yes Encoded address
fullAddress string yes Full address in textual format
countryName string no Country name
locality string no The locality (e.g. city or town)
postalCode string no Postal code. Can include a single instance or an array of records
region string no Region (e.g. state or province)
streetAddress string no Street address
hasComponent URI no Reference to related address components. Can include a single instance or an array of records
latitude string no X coordinate in wgs84 coordinate system
longitude string no Y coordinate in wgs84 coordinate system
location object no Address location in L-EST coordinate system
x string no X coordinate in L-EST coordinate system
y string no Y coordinate in L-EST coordinate system
hasPreviousVersion URI no Previous version of address. Can include a single instance or an array of records.
hasNextVersion URI no Next version of address. Can include a single instance or an array of records.
duration object no Interval for which the address is/was valid
hasBeginning object no Address valid from date
hasEnd object no Address valid until date
modified dateTime yes As of date of the address record
created dateTime yes Creation date of the address record

Get address data (Available only through API v2)

Request

Make a HTTP GET to URL

https://graph.ir.ee/addresses/{adr_id}

Name Type Required Description
adr_id string yes Id of the address

Response

Example query:

https://graph.ir.ee/addresses/343100

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "adr_id": "343100",
            "codeAddress": "3778405240000061T00001NQ000000000",
            "fullAddress": "Harju maakond, Tallinna linn, Nõmme linnaosa, Trummi tn 11b",
            "location":{
                "x": "6585774.21",
                "y": "537986.86"
            },
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
adr_id string yes Address Id
codeAddress string yes Encoded address
fullAddress string yes Full address in textual format
location object no Detailed information of location
x string no X coordinate in L EST Coordinate System
y string no Y coordinate in L EST Coordinate System
modified dateTime yes As of date of the address record
created dateTime yes Creation date of the address record

Get address data (Available only through API v3)

Request

Make a HTTP GET to URL

https://graph.ir.ee/addresses/{adr-id}

Name Type Required Description
adr-id string yes Identificator of an address in the national address information system (ADS)

Response

Example query:

https://graph.ir.ee/addresses/2123811

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "adr_id": "2123811",
            "codeAddress": "37784048200000JYH00003EMZ00000000",
            "fullAddress": " Harju maakond, Tallinn, Mustamäe linnaosa, Ehitajate tee 86",
            "countryName": "Eesti",
            "locality": "Tallinn",
            "postalCode": "12915",
            "region": "Harjumaa",
            "streetAddress": "Ehitajate tee 86",
            "hasComponent": "https://graph.ir.ee/address-components/1-37",
            "latitude": "59.408175",
            "longitude": "24.668858",
            "location":{
                "x": "6585774.21",
                "y": "537986.86"
            },
            "hasPreviousVersion": "https://graph.ir.ee/addresses/101860",
            "hasNextVersion": "https://graph.ir.ee/addresses/246801",
            "duration":{
                "hasBeginning": {
                    "inXSDDateTime": "2013-04-13T00:00:00Z"
                },
                "hasEnd": {
                    "inXSDDateTime": "2014-01-12T00:00:00Z"
                }
            },
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
adr_id string yes Identificator of an address in the national address information system (ADS)
codeAddress string yes Encoded address
fullAddress string yes Full address in textual format
countryName string no Country name
locality string no The locality (e.g. city or town)
postalCode string no Postal code. Can include a single instance or an array of records
region string no Region (e.g. state or province)
streetAddress string no Street address
hasComponent URI no Reference to related address components. Can include a single instance or an array of records
latitude string no X coordinate in wgs84 coordinate system
longitude string no Y coordinate in wgs84 coordinate system
location object no Address location in L-EST coordinate system
x string no X coordinate in L-EST coordinate system
y string no Y coordinate in L-EST coordinate system
hasPreviousVersion URI no Previous version of address. Can include a single instance or an array of records.
hasNextVersion URI no Next version of address. Can include a single instance or an array of records.
duration object no Interval for which the address is/was valid
hasBeginning object no Address valid from date
hasEnd object no Address valid until date
modified dateTime yes As of date of the address record
created dateTime yes Creation date of the address record

Get address organizations (Available only through API v3)

Request

Make a HTTP GET to URL

https://graph.ir.ee/addresses/{adr-id}/organizations

Name Type Required Description
adr-id string yes Identificator of an address in the national address information system (ADS)

Response

Example query:

https://graph.ir.ee/addresses/2123811/organizations

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            "https://graph.ir.ee/organizations/ee-10279799",
            "..."
        ]
    }
}
Name Type Required Description
items array yes URIs organization subjects

Request

Make a HTTP GET to URL

https://graph.ir.ee/addresses/{adr-id}/address-objects

Name Type Required Description
adr-id string yes Identificator of an address in the national address information system (ADS)

Response

Example query:

https://graph.ir.ee/addresses/2123811/address-objects

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "oid": "CU00465197",
                "addressObjectType": "CU",
                "origId": "78405:501:3520",
                "fullAddress": "Harju maakond, Tallinn, Mustamäe linnaosa, Ehitajate tee 86",
                "hasLocation": "https://graph.ir.ee/addresses/2123811",
                "location":{
                    "x": "6585774.53",
                    "y": "537989.70"
                },
                "hasObjectSite": "https://graph.ir.ee/sites/ee-11896590-registered",
                "duration":{
                    "hasBeginning": {
                        "inXSDDateTime": "2013-04-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                },
                "hasPreviousVersion": "https://graph.ir.ee/address-objects/cu00465196",
                "hasNextVersion": "https://graph.ir.ee/address-objects/cu00465198",
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
oid string yes Identificator of an address object in the national address information system (ADS), identifies over all object types.
addressObjectType string yes Identificator of an address object type in the national address information system (ADS)
origId string no Original object identifier in the source registry. Identifies objects within a type
fullAddress string yes Full address in textual format
hasLocation string no Reference to related address
location object no Address location in L-EST coordinate system
x string no X coordinate in L-EST coordinate system
y string no Y coordinate in L-EST coordinate system
hasObjectSite string no Reference to related site address
duration object no Interval for which the address object is/was valid
hasBeginning object no Address object valid from date
hasEnd object no Address object valid until date
hasPreviousVersion URI no Previous version of address object. Can include a single instance or an array of records.
hasNextVersion URI no Next version of address object. Can include a single instance or an array of records.
modified dateTime yes As of date of the address object record
created dateTime yes Creation date of the address object record

/cadastral-units

Get cadastral units of certain size and purpose

Request

Make a HTTP GET to URL

https://graph.ir.ee/cadastral-units/{registration-num}

Name Type Required Description
registration-num string yes Cadastral unit registration number

Response

Example query:

https://graph.ir.ee/cadastral-units/78404-409-0121

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "area": "721.0",
            "cadastralRegisterNumber": "78404:409:0121",
            "areaUnit": "m2",
            "hasIntendedUse":{
                "percentage": "100.0",
                "type": "http://graph.ir.ee/land-usage-types/residential"
            },
            "hasAddressObject": "https://graph.ir.ee/address-objects/cu03240012",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
area string yes Area of the cadastral unit
cadastralRegisterNumber string yes Cadastral unit registration number
areaUnit string yes Unit of the area
hasIntendedUse object yes Intended use information
percentage string yes How much of area is used for the certain purpose
type URL yes Intended use type
hasAddressObject object yes Address object URL
modified dateTime yes As of date of the cadastral unit record
created dateTime yes Creation date of the cadastral unit record

Get cadastral units of certain size and purpose

Request

Make a HTTP GET to URL

https://graph.ir.ee/cadastral-units?intended-use={intended-use}&min-area={min-area}&max-area={max-area}&area-unit={unit}

Name Type Required Description
intended-use string yes Intended use of the unit
min-area string yes Min area of the unit
max-area string yes Max area of the unit
area-unit string yes Unit in which min and max area are specified, can be square metre - ‘m2’ or hactare - ‘ha’

Response

Example query:

https://graph.ir.ee/cadastral-units?intended-use=residential&min-area=721&max-area=800&area-unit=m2

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "area": "721.0",
                "areaUnit": "m2",
                "hasIntendedUse":{
                    "percentage": "100.0",
                    "type": "http://graph.ir.ee/land-usage-types/residential"
                },
                "hasAddressObject": "https://graph.ir.ee/address-objects/cu03240012",
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
area string yes Area of the cadastral unit
areaUnit string yes Unit of the area
hasIntendedUse object yes Intended use information
percentage string yes How much of area is used for the certain purpose
type URL yes Intended use type
hasAddressObject object yes Address object URL
modified dateTime yes As of date of the cadastral unit record
created dateTime yes Creation date of the cadastral unit record

Get cadastral units within the radius of the point (Available only through API v2)

Request

Make a HTTP GET to URL

https://graph.ir.ee/cadastral-units?radius={radius}&latitude={lat}&longitude={lon}

Name Type Required Description
radius string yes Search radius
lat string yes Latitude of the starting point, L EST coordinate system
lon string yes Longitude of the starting point, L EST coordinate system

Response

Example query:

https://graph.ir.ee/cadastral-units?radius=50&latitude=6583890.00&longitude=537285.00

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "area": "721.0",
                "areaUnit": "m2",
                "cadastralRegisterNumber": "78404:409:0121",
                "intendedUse":{
                    "percentage": "100.0",
                    "type": "http://graph.ir.ee/land-usage-types/residential"
                },
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
area string yes Area of the cadastral unit
areaUnit string yes Unit of the area
cadastralRegisterNumber string yes Cadastral unit registration number
intendedUse object yes Intended use information
percentage string yes How much of area is used for the certain purpose
type URL yes Intended use type
modified dateTime yes As of date of the cadastral unit record
created dateTime yes Creation date of the cadastral unit record

/claim-documents

Get debt claim document data

Request

Make a HTTP GET to URL

https://graph.ir.ee/claim-documents/{document-id}

Name Type Required Description
document-id string yes Id of the document

Response

Example query:

https://graph.ir.ee/claim-documents/ee-12345678-ee-11735006-m-500

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "documentIdentifier": "M-500",
            "documentType": "http://graph.ir.ee/claim-supporting-document-types/invoice",
            "documentSubject": "http://www.ebusiness-unibw.org/ontologies/pcs2owl/cpa/C_C-tax",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
documentIdentifier string yes Identifier of the document
documentType string no Classification of supporting documents
documentSubject string no Reference to a class in NACE Rev 2 - CPA 2008 classifier
modified dateTime yes As of date of the claim document record
created dateTime yes Creation date of the claim document record

/contacts

Get contact data

Request

Make a HTTP GET to URL

https://graph.ir.ee/contacts/{contact-id}

Name Type Required Description
contact-id string yes Id of the contact

Response

Example query:

https://graph.ir.ee/contacts/ee-11735006

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "hasEmail": "https://graph.ir.ee/organizations/ee-11735006/emails/info@inforegister.ee",
            "hasTelephone": "https://graph.ir.ee/organizations/ee-11735006/telephones/003725045962",
            "hasInstantMessage": "https://graph.ir.ee/organizations/ee-11735006/skype-users/peepkungas",
            "hasURL": "https://graph.ir.ee/organizations/ee-11735006/urls/https-www.inforegister.ee",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
hasEmail URI no URI of an organization’s email subject. Can include a single instance or an array of records
hasTelephone URI no URI of an organization’s telephone subject. Can include a single instance or an array of records
hasInstantMessage URI no URI of an organization’s instant message subject. Can include a single instance or an array of records
hasURL URI no URI of an organization’s url subject. Can include a single instance or an array of records.
modified dateTime yes As of date of the contact record
created dateTime yes Creation date of the contact record

/debt-claims

Get debt claim data

Request

Make a HTTP GET to URL

https://graph.ir.ee/debt-claims/{claim-id}

Name Type Required Description
claim-id string yes Id of the claim

Response in a case of tax-debts

Example query:

https://graph.ir.ee/debt-claims/ee-11735006-interest

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "contestedAmount": "https://graph.ir.ee/monetary-amounts/ee-11735006-interest-2013-06-17-19-50-40-contested-amount",
            "claimAmount": "https://graph.ir.ee/monetary-amounts/ee-11735006-interest-2013-06-17-19-50-40-claim-amount",
            "debtClaimType": "http://graph.ir.ee/tax-debt-types/interest",
            "onScheduleAmount": "https://graph.ir.ee/monetary-amounts/ee-11735006-interest-2013-06-17-19-50-40-on-schedule-amount",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
contestedAmount URI yes Contested amount of the debt claim
claimAmount URI yes Total amount of the debt claim
debtClaimType string yes Classification of the debt claim (For tax debt classification see: http://www.emta.ee/index.php?id=26207&highlight=ljastamise)
onScheduleAmount URI yes Amount, which has been scheduled for payment
modified dateTime yes As of date of the debt claim record
created dateTime yes Creation date of the debt claim record

Response in a case of debts

Example query:

https://graph.ir.ee/debt-claims/ee-12345678-ee-11735006-m-500

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "claimAmount": "https://graph.ir.ee/monetary-amounts/ee-12345678-ee-11735006-m-500-2013-06-17-19-50-40-claim-amount",
            "debtClaimType": "http://graph.ir.ee/claim-types/business-other-payables",
            "issuanceDate": "2010-06-14",
            "dueDate": "2010-02-25",
            "annualInterestRate": "0.00",
            "penalFine": "https://graph.ir.ee/monetary-amounts/ee-12345678-ee-11735006-m-500-2013-06-17-19-50-40-penal-fine",
            "dailyPostMaturityInterestRate": "0.05",
            "hasSupportingDocument": "https://graph.ir.ee/claim-documents/ee-12345678-ee-11735006-m-500",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
claimAmount URI yes Total amount of the debt claim
debtClaimType string no Reference to debt claim type
issuanceDate date no Claim supporting document issuance date, i.e. invoice date
dueDate date yes Due date of the claim
annualInterestRate float no Annual interest rate for the claim
penalFine URI no Penal fine
dailyPostMaturityInterestRate float no Daily post-maturity interest rate
hasSupportingDocument URI yes URI of the supporting document
modified dateTime yes As of date of the debt claim record
created dateTime yes Creation date of the debt claim record

Insert document to a claim

Request

Make a HTTP POST to URL with data added to the request body in a JSON object

https://graph.ir.ee/debt-claims/{debt-claim-id}/claim-documents?graph={graph-uri}

Example query:

https://graph.ir.ee/debt-claims/ee-11735006-ee-37612016781-m-500/claim-documents?graph=https://graph.ir.ee/graphs/persons/ee-37612016781/debts/ee-11735006-ee-37612016781/2015-04-01-08-34-50

{
    "document-identifier": "M-500",
    "document-type": "invoice",
    "document-subject": "C"
}
Name Type Required Description
debt-claim-id string yes Id of the debt claim
graph-uri URL encoded string yes URI of the debt graph
document-identifier string yes Id of the document
document-type string no Classification of supporting documents
document-subject string no Reference to a class in NACE Rev 2 - CPA 2008 classifiers

Response

Example response Location header:

Location: https://graph.ir.ee/claim-documents/ee-11735006-ee-37612016781-m-500?graph=https://graph.ir.ee/graphs/persons/ee-37612016781/debts/ee-11735006-ee-37612016781/2015-04-01-08-34-50

On succesful POST request the response contains status 201 Created and the Location header contains URL encoded URI of the created subject and the graph URI.

/debts

Get debt data

Request

Make a HTTP GET to URL

https://graph.ir.ee/debts/{debt-id}

Name Type Required Description
debt-id string yes Id of the debt

Response

Example query:

https://graph.ir.ee/debts/ee-11735006-ee-37612016781

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "hasCreditor": "https://graph.ir.ee/organizations/ee-11735006",
            "hasDebtor": "https://graph.ir.ee/persons/ee-37612016781",
            "creditorRepresentative": "https://graph.ir.ee/organizations/ee-11043745",
            "debtTotal": "https://graph.ir.ee/monetary-amounts/ee-37612016781-2013-06-17-19-50-04-debt-total",
            "accumulatedInterest": "https://graph.ir.ee/monetary-amounts/ee-37612016781-2013-06-17-19-50-04-accumulated-interest",
            "includesClaim": "https://graph.ir.ee/debt-claims/ee-11735006-ee-37612016781-m-500",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
hasCreditor URI yes URI of the creditor subject
hasDebtor URI yes URI of the debtor subject
creditorRepresentative URI yes URI of the creditor representative subject
debtTotal URI yes The sum of all tax debt claims
accumulatedInterest URI no Accumulated interest as of specific date
includesClaim URI no URI of the debt claim subject. Can include a single URI or an array of URIs
modified dateTime yes As of date of the debt record
created dateTime yes Creation date of the debt record

Insert a debt

Request

Make a HTTP POST to URL with data added to the request body in a JSON object

https://graph.ir.ee/debts

Example query:

https://graph.ir.ee/debts

{
    "representative-country-code": "EE",
    "representative-code": "11043745",
    "representative-type": "Organization",
    "creditor-country-code": "EE",
    "creditor-code": "11735006",
    "creditor-type": "Organization",
    "debtor-country-code": "EE",
    "debtor-code": "37612016781",
    "debtor-type": "Person",
    "currency": "EUR",
    "debt-total": "154.45",
    "interest": "10.12"
}
Name Type Required Description
representative-country-code string yes Code of the country where the representative is registered
representative-code string yes Code of the representative
representative-type string yes Indicates the representative agent type. Can be either “Person” or “Organization”
creditor-country-code string yes Code of the country where the creditor is registered
creditor-code string yes Code of the creditor
creditor-type string yes Indicates the creditor agent type. Can be either “Person” or “Organization”
debtor-country-code string yes Code of the country where the debtor is registered
debtor-code string yes Code of the debtor
debtor-type string yes Indicates the debtor agent type. Can be either “Person” or “Organization”
currency string yes Debt currency
debt-total float yes The sum of all debt claims of a creditor for the specific debtor
interest float no Accumulated interest as of specific date

Response

Example response Location header:

Location: https://graph.ir.ee/debts/ee-11735006-ee-37612016781?graph=https://graph.ir.ee/graphs/persons/ee-37612016781/debts/ee-11735006-ee-37612016781/2015-04-01-08-34-50

On succesful POST request the response contains status 201 Created and the Location header contains URL encoded URI of the created subject and the graph URI.

Insert debt claim to a debt

Request

Make a HTTP POST to URL with data added to the request body in a JSON object

https://graph.ir.ee/debts/{debt-id}/debt-claims?graph={graph-uri}

Example query:

https://graph.ir.ee/debts/ee-11735006-ee-37612016781/debt-claims?graph=https://graph.ir.ee/graphs/persons/ee-37612016781/debts/ee-11735006-ee-37612016781/2015-04-01-08-34-50

{
    "claim-identifier": "m-500",
    "due-date": "2010-02-25",
    "amount": "142.65",
    "currency": "EUR",
    "claim-type": "consumer-hmr-mortgage",
    "issuance-date": "2010-06-14",
    "annual-interest": "0.00",
    "fine": "100.00",
    "daily-interest": "0.05"
}
Name Type Required Description
debt-id string yes Id of the debt
graph-uri URL encoded string yes URI of the debt graph
claim-identifier string yes Identifier of the debt claim. Value corresponds to debt claim document identifier.
due-date date yes Due date of the debt claim
amount float yes The amount of the debt claim
currency string yes Claim currency
claim-type string no Reference to debt claim type
issuance-date date no Claim supporting document issuance date, i.e. invoice date
annual-interest float no Annual interest rate for the claim
fine float no Penal fine
daily-interest float no Daily post-maturity interest rate

Response

Example response Location header:

Location: https://graph.ir.ee/debt-claims/ee-11735006-ee-37612016781-m-500?graph=https://graph.ir.ee/graphs/persons/ee-37612016781/debts/ee-11735006-ee-37612016781/2015-04-01-08-34-50

On succesful POST request the response contains status 201 Created and the Location header contains URL encoded URI of the created subject and the graph URI.

/documents

Search docs by type and update period

Request

Make a HTTP GET to URL

https://graph.ir.ee/documents?type={document-type}?min-documentDate={start-date}&max-documentDate={end-date}&valid={validity}

Name Type Required Description
document-type string yes Type of the documents
start-date date yes Start date of the specified period
end-date date yes End date of the specified period
validity integer yes Document validity status. Can be either 1 or 0.

Response

Example query:

https://graph.ir.ee/documents?type=articles-of-association&min-documentDate=2011-12-21&max-documentDate=2012-09-30&valid=1

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            "https://graph.ir.ee/documents/ee-11735006-2012-09-30-p",
            "..."
        ]
    }
}
Name Type Required Description
items array yes URIs of document subjects

Get document data

Request

Make a HTTP GET to URL

https://graph.ir.ee/documents/{document-id}

Name Type Required Description
document-id string yes Id of the document

Response

Example query:

https://graph.ir.ee/documents/ee-11735006-2013-a-a

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "documentOf": "https://graph.ir.ee/organizations/ee-11735006",
            "creator": "https://graph.ir.ee/organizations/ee-11735006",
            "documentType": "http://graph.ir.ee/document-types/annual-declaration-pdf",
            "format": "application/pdf",
            "identifier": "9001816670",
            "reportType": "http://graph.ir.ee/report-types/annual-declaration",
            "reportYear": "2013",
            "isValid": "1",
            "submitted": "2014-06-29",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
documentOf URI yes URI of the organization subject, which the document belongs to
creator URI yes URI of the organization subject, which is the creator of the document
documentType string yes Reference to a document type.
format string no Format of the document
identifier string yes Document identifier in Estonian business register
reportType string no Reference to the report type
reportYear string no Year of the report
isValid integer yes Document’s validity status.
  • 1 - indicates document is valid
  • 0 - indicates document is invalid
submitted date yes Date of the document submission
modified dateTime yes As of date of the document record
created dateTime yes Creation date of the document record

/finalize-graph

Finalize graph

Request

Make a HTTP POST to URL with data added to the request body in a JSON object

https://graph.ir.ee/finalize-graph

Example query:

https://graph.ir.ee/finalize-graph

{
    "graph": "https://graph.ir.ee/graphs/debts/ee-11735006-ee-37612016781/2015-04-01-08-34-50"
}
Name Type Required Description
graph string yes Reference to the debt graph

Response

On succesful POST request the response contains status 200 OK

/financials

Search organizations by financial element value between upper limit and lower limit

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations?financial-statement-element={elementType}&min-value={min-value}&max-value={max-value}&periodType={periodType}&periodValue={periodValue}

Name Type Required Description
elementType string yes Financial statement element type identifier. Value can be one of the http://graph.ir.ee/financial-statement/MonetaryValueType known types identifier.
min-value decimal yes Lower limit of the value range
max-value decimal yes Upper limit of the value range
periodType string yes Period type identifier. Value can be year or quarter.
periodValue string yes Label of the period.
For period type year the label is the value of the year.
For period type quarter the label is the year value and quarter reference, for example ‘2015-Q1’

Response

Example query:

https://graph.ir.ee/organizations?financial-statement-element=revenue&min-value=500000&max-value=1000000&periodType=year&periodValue=2015

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            "https://graph.ir.ee/organizations/ee-11735006",
            "..."
        ]
    }
}
Name Type Required Description
items array yes URIs of organization subjects

Get financial statement data information

Request

Make a HTTP GET to URL

https://graph.ir.ee/financial-statement-data/{statementId}

Name Type Required Description
statementId string yes Id of the financial statement data object

Response

Example query:

https://graph.ir.ee/financial-statement-data/ee-11735006-year-2015

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "hasRevenue": "https://graph.ir.ee/financial-statement-elements/ee-11735006-year-2015-revenue",
            "hasBalance": "https://graph.ir.ee/financial-statement-elements/ee-11735006-year-2015-balance",
            "hasCurrentAssets": "https://graph.ir.ee/financial-statement-elements/ee-11735006-year-2015-current-assets",
            "hasCapitalAssets": "https://graph.ir.ee/financial-statement-elements/ee-11735006-year-2015-capital-assets",
            "hasCurrentLiabilities": "https://graph.ir.ee/financial-statement-elements/ee-11735006-year-2015-current-liabilities",
            "hasLongTermLiabilities": "https://graph.ir.ee/financial-statement-elements/ee-11735006-year-2015-long-term-liabilities",
            "hasEquityCapital": "https://graph.ir.ee/financial-statement-elements/ee-11735006-year-2015-equity-capital",
            "hasNetIncome": "https://graph.ir.ee/financial-statement-elements/ee-11735006-year-2015-net-income",
            "created": "2016-08-15T12:22:03Z",
            "modified": "2016-08-15T12:22:03Z"
        }
    }
}
Name Type Required Description
hasRevenue URI no Reference to financial statement revenue object
hasBalance URI no Reference to financial statement balance object
hasCurrentAssets URI no Reference to financial statement current assets object
hasCapitalAssets URI no Reference to financial statement capital assets object
hasCurrentLiabilities URI no Reference to financial statement current liabilities object
hasLongTermLiabilities URI no Reference to financial statement long-term liabilities object
hasEquityCapital URI no Reference to financial statement equity capital object
hasNetIncome URI no Reference to financial statement net income object
created dateTime yes Creation date of the financial statement data record
modified dateTime yes As of date of the financial statement data record

Get financial statement element information

Request

Make a HTTP GET to URL

https://graph.ir.ee/financial-statement-elements/{elementId}

Name Type Required Description
elementId string yes Id of the financial statement element object

Response

Example query:

https://graph.ir.ee/financial-statement-elements/ee-11735006-year-2015-revenue

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "value": "727758.0",
            "currency": "EUR",
            "elementType": "http://graph.ir.ee/monetary-value-types/revenue",
            "timestamp": "2015-12-31T21:59:59Z",
            "hasInterval":{
                "periodType": "http://graph.ir.ee/accounting-period-types/year",
                "periodValue": "2015"
            },
            "created": "2016-08-15T12:22:03Z",
            "modified": "2016-08-15T12:22:03Z"
        }
    }
}
Name Type Required Description
value decimal yes Financial statement element monetary value
currency string yes Financial statement element monetary value currency
elementType URI yes Indicates the type of the financial statement element
timestamp dateTime yes Financial report data timestamp
hasInterval object yes Financial statement element period object
periodType URI yes Indicates the type of the accounting period
periodValue string yes Label of the financial statement element period
created dateTime yes Creation date of the financial statement element record
modified dateTime yes As of date of the financial statement element record

Get list of financial statement data subjects with periods for a company

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{orgId}/financial-statement-data

Name Type Required Description
orgId string yes Id of the organization object

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/financial-statement-data

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "_about": "https://graph.ir.ee/financial-statement-data/ee-11735006-year-2015",
                "hasRevenue":{
                    "hasInterval":{
                        "periodType": "http://graph.ir.ee/accounting-period-types/year",
                        "periodValue": "2015"
                    }
                },
                "created": "2016-08-15T12:22:03Z",
                "modified": "2016-08-15T12:22:03Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
_about URI yes Reference to financial statement data subject
hasRevenue object yes Financial statement revenue object
hasInterval object yes Financial statement period object
periodType URI yes Indicates the type of the accounting period
periodValue string yes Label of the financial statement period
created dateTime yes Creation date of the financial statement data record
modified dateTime yes As of date of the financial statement data record

Get list of financial elements for specific period for a company

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{orgId}/financial-statement-elements?periodType={periodType}&periodValue={periodValue}

Name Type Required Description
orgId string yes Id of the organization object
periodType string yes Period type identifier. Value can be year or quarter.
periodValue string yes Label of the period.
For period type year the label is the value of the year.
For period type quarter the label is the year value and quarter reference, for example ‘2015-Q1’

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/financial-statement-elements?periodType=year&periodValue=2015

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "value": "727758.0",
                "currency": "EUR",
                "elementType": "http://graph.ir.ee/monetary-value-types/revenue",
                "timestamp": "2015-12-31T21:59:59Z",
                "hasInterval":{
                    "periodType": "http://graph.ir.ee/accounting-period-types/year",
                    "periodValue": "2015"
                },
                "created": "2016-08-15T12:22:03Z",
                "modified": "2016-08-15T12:22:03Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
value decimal yes Financial statement element monetary value
currency string yes Financial statement element monetary value currency
elementType URI yes Indicates the type of the financial statement element
timestamp dateTime yes Financial report data timestamp
hasInterval object yes Financial statement element period object
periodType URI yes Indicates the type of the accounting period
periodValue string yes Label of the financial statement element period
created dateTime yes Creation date of the financial statement element record
modified dateTime yes As of date of the financial statement element record

Get list of financial elements by type and specific period type for a company

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{orgId}/financial-statement-elements?type={type}&periodType={periodType}

Name Type Required Description
orgId string yes Id of the organization object
type string yes Financial statement element type identifier. Value can be one of the http://graph.ir.ee/financial-statement/MonetaryValueType known types identifier.
periodType string yes Period type identifier. Value can be year or quarter.

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/financial-statement-elements?type=revenue&periodType=year

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "value": "727758.0",
                "currency": "EUR",
                "elementType": "http://graph.ir.ee/monetary-value-types/revenue",
                "timestamp": "2015-12-31T21:59:59Z",
                "hasInterval":{
                    "periodType": "http://graph.ir.ee/accounting-period-types/year",
                    "periodValue": "2015"
                },
                "created": "2016-08-15T12:22:03Z",
                "modified": "2016-08-15T12:22:03Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
value decimal yes Financial statement element monetary value
currency string yes Financial statement element monetary value currency
elementType URI yes Indicates the type of the financial statement element
timestamp dateTime yes Financial report data timestamp
hasInterval object yes Financial statement element period object
periodType URI yes Indicates the type of the accounting period
periodValue string yes Label of the financial statement element period
created dateTime yes Creation date of the financial statement element record
modified dateTime yes As of date of the financial statement element record

Get company latest financials by element type

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{orgId}/financial-statement-elements?type={type}

Name Type Required Description
orgId string yes Id of the organization object
type string yes Financial statement element type identifier. Value can be one of the http://graph.ir.ee/financial-statement/MonetaryValueType known types identifier.

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/financial-statement-elements?type=revenue

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "value": "727758.0",
            "currency": "EUR",
            "elementType": "http://graph.ir.ee/monetary-value-types/revenue",
            "timestamp": "2015-12-31T21:59:59Z",
            "hasInterval":{
                "periodType": "http://graph.ir.ee/accounting-period-types/year",
                "periodValue": "2015"
            },
            "created": "2016-08-15T12:22:03Z",
            "modified": "2016-08-15T12:22:03Z"
        }
    }
}
Name Type Required Description
value decimal yes Financial statement element monetary value
currency string yes Financial statement element monetary value currency
elementType URI yes Indicates the type of the financial statement element
timestamp dateTime yes Financial report data timestamp
hasInterval object yes Financial statement element period object
periodType URI yes Indicates the type of the accounting period
periodValue string yes Label of the financial statement element period
created dateTime yes Creation date of the financial statement element record
modified dateTime yes As of date of the financial statement element record

Get company latest financials by period type

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{orgId}/financial-statement-elements?periodType={periodType}

Name Type Required Description
orgId string yes Id of the organization object
periodType string yes Period type identifier. Value can be year or quarter.

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/financial-statement-elements?periodType=year

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "value": "727758.0",
                "currency": "EUR",
                "elementType": "http://graph.ir.ee/monetary-value-types/revenue",
                "timestamp": "2015-12-31T21:59:59Z",
                "hasInterval":{
                    "periodType": "http://graph.ir.ee/accounting-period-types/year",
                    "periodValue": "2015"
                },
                "created": "2016-08-15T12:22:03Z",
                "modified": "2016-08-15T12:22:03Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
value decimal yes Financial statement element monetary value
currency string yes Financial statement element monetary value currency
elementType URI yes Indicates the type of the financial statement element
timestamp dateTime yes Financial report data timestamp
hasInterval object yes Financial statement element period object
periodType URI yes Indicates the type of the accounting period
periodValue string yes Label of the financial statement element period
created dateTime yes Creation date of the financial statement element record
modified dateTime yes As of date of the financial statement element record

Get company financial element by type, period type and value

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{orgId}/financial-statement-elements?type={type}&periodType={periodType}&periodValue={periodValue}

Name Type Required Description
orgId string yes Id of the organization object
type string yes Financial statement element type identifier. Value can be one of the http://graph.ir.ee/financial-statement/MonetaryValueType known types identifier.
periodType string yes Period type identifier. Value can be year or quarter.
periodValue string yes Label of the period.
For period type year the label is the value of the year.
For period type quarter the label is the year value and quarter reference, for example ‘2015-Q1’

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/financial-statement-elements?type=revenue&periodType=year&periodValue=2015

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "value": "727758.0",
            "currency": "EUR",
            "elementType": "http://graph.ir.ee/monetary-value-types/revenue",
            "timestamp": "2015-12-31T21:59:59Z",
            "hasInterval":{
                "periodType": "http://graph.ir.ee/accounting-period-types/year",
                "periodValue": "2015"
            },
            "created": "2016-08-15T12:22:03Z",
            "modified": "2016-08-15T12:22:03Z"
        }
    }
}
Name Type Required Description
value decimal yes Financial statement element monetary value
currency string yes Financial statement element monetary value currency
elementType URI yes Indicates the type of the financial statement element
timestamp dateTime yes Financial report data timestamp
hasInterval object yes Financial statement element period object
periodType URI yes Indicates the type of the accounting period
periodValue string yes Label of the financial statement element period
created dateTime yes Creation date of the financial statement element record
modified dateTime yes As of date of the financial statement element record

Get list of financial elements by type for specigic period for a company

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{orgId}/financial-statement-elements?type={type}&periodType={periodType}&min-date={min-date}&max-date={max-date}

Name Type Required Description
orgId string yes Id of the organization object
type string yes Financial statement element type identifier. Value can be one of the http://graph.ir.ee/financial-statement/MonetaryValueType known types identifier.
periodType string yes Period type identifier. Value can be year or quarter.
min-date string yes Start date of the specified period
max-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/financial-statement-elements?type=revenue&periodType=year&min-date=2014-01-01&max-date=2016-01-01

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "value": "727758.0",
                "currency": "EUR",
                "elementType": "http://graph.ir.ee/monetary-value-types/revenue",
                "timestamp": "2015-12-31T21:59:59Z",
                "hasInterval":{
                    "periodType": "http://graph.ir.ee/accounting-period-types/year",
                    "periodValue": "2015"
                },
                "created": "2016-08-15T12:22:03Z",
                "modified": "2016-08-15T12:22:03Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
value decimal yes Financial statement element monetary value
currency string yes Financial statement element monetary value currency
elementType URI yes Indicates the type of the financial statement element
timestamp dateTime yes Financial report data timestamp
hasInterval object yes Financial statement element period object
periodType URI yes Indicates the type of the accounting period
periodValue string yes Label of the financial statement element period
created dateTime yes Creation date of the financial statement element record
modified dateTime yes As of date of the financial statement element record

/immovables

Get registered immovable property information

Request

Make a HTTP GET to URL

https://graph.ir.ee/registered-immovables/{regisration-num}

Name Type Required Description
regisration-num string yes Registration number of the immovable property

Response

Example query:

https://graph.ir.ee/registered-immovables/1892601

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "propertyName": "Stenbock House",
            "partNumber": "1892601",
            "oldPartNumber": "18926",
            "landRegistryDivision": "Tallinn",
            "includesCadastralUnit": "https://graph.ir.ee/cadastral-units/79511-006-0062"
        }
    }
}
Name Type Required Description
propertyName string yes Property name
partNumber string yes Part number
oldPartNumber string yes Old part number
landRegistryDivision string yes Land registry division
includesCadastralUnit URL yes Cadastral unit URL

/locations

Search for locations (Available only through API v2)

Request

Make a HTTP GET to URL

https://graph.ir.ee/locations?street-address={street-name}&locality={city-name}&region={county-name}

Name Type Required Description
street-name string yes Street name. To search for all streets use “.*”
city-name string yes City name. To search for all cities use “.*”
county-name string yes County name. To search for all counties use “.*”

Response

Example query:

https://graph.ir.ee/locations?street-address=endla+16&locality=tallinn&region=harju

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "_about": "https://graph.ir.ee/locations/endla-16-tallinn-harjumaa-eesti",
                "locality": "Tallinn",
                "postalCode": "50108",
                "region": "Harjumaa",
                "streetAddress": "Endla 16"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
_about URI yes URI of the location
locality string no The locality (e.g. city or town)
postalCode string no Postal code
region string no Region (e.g. state or province)
streetAddress string no Street address

Search organizations by location (Available only through API v2)

Request

Make a HTTP GET to URL

https://graph.ir.ee/locations/{location-id}/companies

Name Type Required Description
location-id string yes Id of the location

Response

Example query:

https://graph.ir.ee/locations/endla-16-tallinn-harjumaa-eesti/companies

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            "https://graph.ir.ee/organizations/ee-10279799",
            "..."
        ]
    }
}
Name Type Required Description
items array yes URIs organization subjects

Get location data (Available only through API v2)

Request

Make a HTTP GET to URL

https://graph.ir.ee/locations/{location-id}

Name Type Required Description
location-id string yes Id of the location

Response

Example query:

https://graph.ir.ee/locations/endla-16-tallinn-harjumaa-eesti

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "countryName": "Eesti",
            "locality": "Tallinn",
            "postalCode": "10122",
            "region": "Harjumaa",
            "streetAddress": "Endla 16",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
countryName string no Country name
locality string no The locality (e.g. city or town)
postalCode string no Postal code. Can include a single instance or an array of records
region string no Region (e.g. state or province)
streetAddress string no Street address
modified dateTime yes As of date of the organization record
created dateTime yes Creation date of the organization record

/memberships

Get membership data

Request

Make a HTTP GET to URL

https://graph.ir.ee/memberships/{membership-id}

Name Type Required Description
membership-id string yes Id of the membership

Response

Example query:

https://graph.ir.ee/memberships/ee-49102190245-ee-12688510-eusos2

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "member":{
                "givenName": "Mari",
                "familyName": "Metsla",
                "gender": "F",
                "birthDate": "1992-02-19",
                "identifier": "49102190245",
                "countryCode": "EE"
            },
            "organization":{
                "legalName": "EXTRACT OÜ",
                "registrationCode": "11224441",
                "registrationDate": "2012-07-11T00:00:00Z",
                "registrationCountryCode": "EE"
            },
            "memberDuring":{
                "hasBeginning":{
                    "inXSDDateTime": "2012-08-13T00:00:00Z"
                },
                "hasEnd": {
                    "inXSDDateTime": "2014-01-12T00:00:00Z"
                }
            },
            "role": "http://graph.ir.ee/membership-roles/eusos2",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
member object yes Members personal information
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
organization object yes Member’s organization information
legalName string yes Member’s organization name
registrationCode string yes Member’s organization id code
registrationDate dateTime yes Member’s organization registration date
registrationCountryCode string yes Member’s organization country code
memberDuring object yes Membership Period
hasBeginning object yes Membership start date
inXSDDateTime dateTime yes Date value
hasEnd object yes Membership start date
role URI yes URI of the member’s role
modified dateTime yes As of date of the membership record
created dateTime yes Creation date of the memberhisp record

/monetary-amounts

Get monetary amount

Request

Make a HTTP GET to URL

https://graph.ir.ee/monetary-amounts/{amounts-id}

Name Type Required Description
amounts-id string yes Id of the monetary amount

Response

Example query:

https://graph.ir.ee/monetary-amounts/ee-11735006-2013-06-17-19-50-40-debt-total

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "currency": "EUR",
            "amount": "142.65",
            "startDate": "2011-01-01T09:15:05Z",
            "endDate": "2011-10-31T12:17:05Z"
        }
    }
}
Name Type Required Description
currency string yes Monetary amount currency
amount float yes The amount of the monetary amount
startDate dateTime yes Monetary amount start date
endDate dateTime no Monetary amount end date

/organizations

Search for an Estonian organization

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations?registry-code={registry-code}&registration-country-code={country-code}

Name Type Required Description
registry-code string yes Registration code of the organization
country-code string yes Country code of the country where the organization is registered

Response

Example query:

https://graph.ir.ee/organizations?registry-code=11735006&registration-country-code=EE

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "_about": "https://graph.ir.ee/organizations/ee-11735006",
            "registrationCode": "11735006",
            "registrationCountryCode": "EE"
        }
    }
}
Name Type Required Description
_about URI yes URI of the organization subject
registrationCode string yes Identifier of the organization
registrationCountryCode string yes Code of the country where the organization is registered

Search by registration date

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations?min-registrationDate={start-date}&max-registrationDate={end-date}

Name Type Required Description
start-date string yes Minimum registration date
end-date string yes Maximum registration date

Response

Example query:

https://graph.ir.ee/organizations?min-registrationDate=1997-10-09&max-registrationDate=2004-10-09

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            "https://graph.ir.ee/organizations/ee-11049334",
            "..."
        ]
    }
}
Name Type Required Description
items array yes URIs of organization subjects

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/search?prefix={prefix}&rank={rank}

Name Type Required Description
prefix string yes Prefix of the organization’s legal name fragment (case insensitive)
NB! URI reserved characters need to be URL encoded.
rank integer no Specifies the number of results returned. This parameter is optional and by default 25 results will be returned.

Response

Example query:

https://graph.ir.ee/organizations/search?prefix=regist&rank=10

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "name": "REGISTER OÜ",
                "organization": "https://graph.ir.ee/organizations/ee-11735006",
                "regCode": "11735006",
                "score": "0.236",
                "status": "http://graph.ir.ee/organization-status-types/registered"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
name string yes Organizations legal name
organization URI yes Reference to organization URI
regCode string yes Registration code of the organization
score string yes Credit risk score of the organization
status URI yes Specifies the status of the organization

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations?legal-name={name-fragment}

Name Type Required Description
name-fragment string yes Fragment of the organization’s legal name (case insensitive)
NB! URI reserved characters need to be URL encoded.

Response

Example query:

https://graph.ir.ee/organizations?legal-name=register

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "_about": "https://graph.ir.ee/organizations/ee-11735006",
                "legalName": "REGISTER OÜ"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
_about URI yes URIs of the organization subjects
legalName string yes Legal name of the organization

Search docs by update date and validity status

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/documents?type={document-type}?min-documentDate={start-date}&max-documentDate={end-date}&valid={validity}

Name Type Required Description
org-id string yes Id of the organization
document-type string yes Type of the documents
start-date date yes Start date of the specified period
end-date date yes End date of the specified period
validity integer yes Document validity status. Can be either 1 or 0.

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/documents?type=articles-of-association&min-documentDate=2011-12-21&max-documentDate=2014-12-31&valid=1

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "_about": "https://graph.ir.ee/documents/ee-11735006-2012-09-30-p",
                "creator": "https://graph.ir.ee/organizations/ee-11735006",
                "documentType": "http://graph.ir.ee/document-types/articles-of-association",
                "format": "application/pdf",
                "identifier": "3002575839",
                "isValid": "1",
                "submitted": "2012-09-30",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2012-10-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
_about URI yes URI of a document subject
creator URI yes URI of the organization subject, which is the creator of the document
documentType string yes Reference to a document type
format string no Format of the document
identifier string yes Document identifier in Estonian business register
isValid integer yes Document’s validity status.
  • 1 - indicates document is valid
  • 0 - indicates document is invalid
submitted date yes Date of the document submission
reportType string no Reference to the report type
reportYear string no Year of the report
modified dateTime yes As of date of the document record
created dateTime yes Creation date of the document record

Search organizations by address

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations?street-address={street-name}&locality={city-name}&region={county-name}

Name Type Required Description
street-name string yes Street name. To search for all streets use “.*”
city-name string yes City name. To search for all cities use “.*”
county-name string yes County name. To search for all counties use “.*”

Response

Example query:

https://graph.ir.ee/organizations?street-address=ehitajate+tee+86&locality=tallinn&region=harju

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            "https://graph.ir.ee/organizations/ee-10279799",
            "..."
        ]
    }
}
Name Type Required Description
items array yes URIs of the organization subjects

Search organizations by coordinates and radius (Available only through API v3)

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations?radius={radius}&latitude={lat}&longitude={lon}

Name Type Required Description
radius string yes Search radius, in meters
lat string yes Latitude of the starting point, WGS84 coordinate system
lon string yes Longitude of the starting point, WGS84 coordinate system

Response

Example query:

https://graph.ir.ee/organizations?radius=150&latitude=59.4094418&longitude=24.6690192

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            "https://graph.ir.ee/organizations/ee-10279799",
            "..."
        ]
    }
}
Name Type Required Description
items array yes URIs of the organization subjects

Get all data of an organization

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "registrationCode": "11735006",
            "registrationCountryCode": "EE",
            "registrationDate": "2009-10-05",
            "registrationDistrict": "Tartu",
            "legalName": "REGISTER OÜ",
            "orgType": "http://graph.ir.ee/organization-types/public-limited-company",
            "description": "Kreedix Register; Võlaturg; Krediidihaldus",
            "orgStatus": "http://graph.ir.ee/organization-status-types/registered",
            "hasPrimarySite": "https://graph.ir.ee/sites/ee-11735006-primary",
            "hasRegisteredSite": "https://graph.ir.ee/sites/ee-11735006-registered",
            "hasSite": "https://graph.ir.ee/sites/ee-11735006-contacts",
            "fixedCapitalAmount": "22370",
            "fixedCapitalCurrency": "EUR",
            "hasTaxDebt": "https://graph.ir.ee/tax-debts/ee-11735006",
            "hasVATRegistration": "https://graph.ir.ee/vat-registrations/ee-11735006-2009-12-23",
            "memberOf": "https://graph.ir.ee/vat-groups/ee-10068499-2010-01-01",
            "representativeOf": "https://graph.ir.ee/vat-groups/ee-11735006-2010-01-01",
            "vatID": "EE101339256",
            "hasDeclaration": "https://graph.ir.ee/tax-declarations/ee-11735006-2013-09-20-vat",
            "hasAggregatedDebt": "https://graph.ir.ee/debts/ee-11735006",
            "hasDocument": "https://graph.ir.ee/documents/ee-11735006-2008-a-a",
            "hasMember": "https://graph.ir.ee/persons/ee-12345678901",
            "hasMembership": "https://graph.ir.ee/memberships/ee-12345678-ee-11735006-juhe",
            "mainActivity": "45111",
            "orgActivity": "C_45.11-tax",
            "category": "http://www.ebusiness-unibw.org/ontologies/pcs2owl/cpa/C_45.11-tax.html",
            "hasFiscalYear": "https://graph.ir.ee/intervals/0000-01-01-0000-12-31",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2014-12-18T16:20:51Z",
            "deletionDate": "2015-07-18T16:20:51Z"
        }
    }
}
Name Type Required Description
registrationCode string yes Identifier of the organization
registrationCountryCode string yes Country code of the country where the organization is registered
registrationDate string no Date when the organization was registered
registrationDistrict date no District where the organization was registered
legalName string no The legal name of the organization
orgType string no Indicates the type of the organization
description string no A short textual description of the organization
orgStatus string yes Indicates the legal status of the organization
hasPrimarySite URI no URI of the organization’s or legal entity’s primary site, where it can be found or contacted
hasRegisteredSite URI no URI of the organization’s or legal entity’s site where it is incorporated
hasSite URI no URI of a site at which the organization has some presence
fixedCapitalAmount float no Fixed capital amount
fixedCapitalCurrency string no Fixed capital currency
hasTaxDebt URI no URI of a organization’s tax debt subject. Can include a single instance or an array of records
hasVATRegistration URI no URI of a organization’s VAT registration subject. Can include a single instance or an array of records
memberOf URI no URI of a VAT group subject where the organization is a member. Can include a single instance or an array of records
representativeOf URI no URI of a VAT group subject where the organization is the representative. Can include a single instance or an array of records
vatID string no The Value-added Tax ID of the organization
hasDeclaration URI no URI of a organization’s unsubmitted declaration subject. Can include a single instance or an array of records
hasAggregatedDebt URI no URI of a organization’s aggregated debt subject
hasDocument URI no URI of a organization’s document subject. Can include a single instance or an array of records
hasMember URI no URI of a member of the organization
hasMembership URI no URI of the membership, where the organization is a member.
mainActivity string no Organization main activity
orgActivity string no Organization activities
category string no URI of a organization’s activity subject. Can include a single instance or an array of records
hasFiscalYear URI no URI of the organization’s economic (fiscal) year
modified dateTime yes As of date of the organization record
created dateTime yes Creation date of the organization record
deletionDate dateTime no Deletion date of the organization record

Get the latest tax debt subject

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/tax-debts

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/tax-debts

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "_about": "https://graph.ir.ee/tax-debts/ee-11735006",
            "accumulatedInterest":{
                "amount": "0",
                "currency": "EUR",
                "startDate": "2013-06-17T19:50:40Z"
            },
            "debtTotal": {
                "amount": "0",
                "currency": "EUR",
                "startDate": "2013-06-17T19:50:40Z"
            },
            "modified": "2014-12-18T19:50:40Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
_about URI yes URI of the taxdebt subject
accumulatedInterest object no Accumulated interest as of specific date. Can include a single instance or an array of records
amount float yes Amount of the specific object
currency string yes Currency of the specific object
startDate string yes Monetary amount start date
debtTotal object yes The sum of all debt claims of a creditor for the specific debtor. Can include a single instance or an array of records
endDate string no Monetary amount end date
modified dateTime yes As of date of the debt record
created dateTime yes Creation date of the debt record

Get the latest tax debt claims

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/tax-debts/debt-claims

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/tax-debts/debt-claims

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "contestedAmount":{
                    "amount": "0",
                    "currency": "EUR",
                    "startDate": "2013-06-17T19:50:40Z"
                },
                "claimAmount": {
                    "amount": "75310.6",
                    "currency": "EUR",
                    "startDate": "2013-06-17T19:50:40Z"
                },
                "debtClaimType": "https://graph.ir.ee/tax-debt-types/retained-income-tax",
                "onScheduleAmount": {
                    "amount": "0",
                    "currency": "EUR",
                    "startDate": "2013-06-17T19:50:40Z"
                },
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
contestedAmount object yes Contested amount of the debt claim. Can include a single instance or an array of records
amount float yes Amount of the specific object
currency string yes Currency of the specific object
startDate string yes Monetary amount start date
claimAmount object yes Total amount of the debt claim. Can include a single instance or an array of records
debtClaimType string yes Classification of the debt claim (For tax debt classification see: http://www.emta.ee/index.php?id=26207&highlight=ljastamise)
onScheduleAmount object yes Amount, which has been scheduled for payment. Can include a single instance or an array of records
endDate string no Monetary amount end date
modified dateTime yes As of date of the debt record
created dateTime yes Creation date of the debt record

Get tax debt as of a specific date

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/tax-debts?attribute={debt-element}&date={date}

Name Type Required Description
org-id string yes Id of the organization
debt-element string yes Indicates the component of tax debt to be returned. Can be “debtTotal”, “accumulatedInterest”, “onScheduleTotal”, “contestedTotal” or “onScheduleAccumulatedInterest”.
date string yes Specified date

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/tax-debts?attribute={debt-element}&date=2013-06-17

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "amount": "701.22",
            "currency": "EUR",
            "startDate": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
amount float yes Amount of the specific object
currency string yes Currency of the specific object
endDate string no Monetary amount end date
startDate string yes Monetary amount start date

Get tax debt time series

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/tax-debts?attribute={debt-element}&min-date={start-date}&max-date={end-date}

Name Type Required Description
org-id string yes Id of the organization
debt-element string yes Indicates the component of tax debt to be returned. Can be “debtTotal”, “accumulatedInterest”, “onScheduleTotal”, “contestedTotal” or “onScheduleAccumulatedInterest”.
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/tax-debts?attribute={debt-element}&min-date=2011-12-14&max-date=2015-01-21

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "amount": "701.22",
                "currency": "EUR",
                "startDate": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
amount float yes Amount of the specific object
currency string yes Currency of the specific object
endDate string no Monetary amount end date
startDate string yes Monetary amount start date

Get unsubmitted tax declarations

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/unsubmitted-tax-declarations

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/unsubmitted-tax-declarations

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "_about": "https://graph.ir.ee/tax-declarations/ee-11735006/vat-2013-09-20",
                "declarationType": "http://graph.ir.ee/tax-declaration-types/value-added-tax",
                "validFrom": "2013-09-20T00:00:00Z",
                "valid": "2014-12-18T16:20:51Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
_about URI yes URI of the unsubmitted tax declaration subject
declarationType URI yes Type of the tax declaration
validFrom dateTime yes Submission deadline for the unsubmitted tax declaration
valid dateTime yes As of date of the unsubmitted tax declaration record

Get VAT registration subjects

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/vat-registrations

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-10068499/vat-registrations

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "vatRegistrationEndDate": "2009-12-31",
                "vatRegistrationEndDecisionDate": "2010-01-05",
                "vatRegistrationNumber": "EE100058428",
                "vatRegistrationStartDate": "1994-01-01",
                "vatRegistrationStartDecisionDate": "1994-01-01",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
vatRegistrationEndDate date no VAT registration end date. Only present when registration has ended
vatRegistrationEndDecisionDate date no VAT registration end decision date. Only present when registration has ended
vatRegistrationNumber string yes The Value-added Tax registration number
vatRegistrationStartDate date yes VAT registration start date
vatRegistrationStartDecisionDate date yes VAT registration start decision date
modified dateTime yes As of date of the vat registration record
created dateTime yes Creation date of the vat registration record

Get URL data

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/urls/{url-id}

Name Type Required Description
url-id string yes Id of the URL

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/urls/https-www.inforegister.ee

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "hasValue": "https://www.inforegister.ee",
            "type": "http://purl.org/rss/1.0/channel"
        }
    }
}
Name Type Required Description
hasValue URI yes subject URL. The following characters are URL encoded: % "#<>?[\]^`{}
type URI yes URI of the URL type. Present if URL is a RSS feed.

Get URLs

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/urls

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/urls

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "hasValue": "https://www.inforegister.ee",
                "type": "http://purl.org/rss/1.0/channel"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
hasValue URI yes subject URL. The following characters are URL encoded: % "#<>?[\]^`{}
type URI yes URI of the URL type. Present if URL is a RSS feed.

Get Skype user data

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/skype-users/{skype-user}

Name Type Required Description
skype-user string yes Skype username

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/skype-users/peepkungas

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "hasValue": "skype:peepkungas"
        }
    }
}
Name Type Required Description
hasValue URI yes Link to skype call to user

Get telephone data

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/telephones/{phone-number}

Name Type Required Description
phone-number string yes Id of the phone

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/telephones/003725045962

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "hasValue": "tel:(+372)5045962",
            "type": "http://www.w3.org/2006/vcard/ns#Voice"
        }
    }
}
Name Type Required Description
hasValue string yes Telephone number. Can include a single instance or an array of records
type URI yes URI of the phone number type. Can include a single instance or an array of records

Get telephones

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/telephones

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/telephones

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "hasValue": "tel:(+372)5045962",
                "type": "http://www.w3.org/2006/vcard/ns#Voice"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
hasValue string no Phone number of the organization. Can include a single instance or an array of records
type URI no URI of the phone number type. Can include a single instance or an array of records

Get email data

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/emails/{email-id}

Name Type Required Description
email-id string yes Id of the e-mail address

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/emails/info@inforegister.ee

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "hasValue": "mailto:info@register.ee",
            "type": "http://www.w3.org/2006/vcard/ns#Work"
        }
    }
}
Name Type Required Description
hasValue string yes Link to email address. The following characters are URL encoded: % "#<>?[\]^`{}
type URI yes URI of the email type. Can include a single instance or an array of records.

Get emails

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/emails

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/emails

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "hasValue": "mailto:info@inforegister.ee",
                "type": "http://www.w3.org/2006/vcard/ns#Work"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
hasValue string no Link to the email address of the organization. Can include a single instance or an array of records. The following characters are URL encoded: % "#<>?[\]^`{}
type URI no URI of the email type. Can include a single instance or an array of records

Get unsubmitted tax declarations of a period

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/unsubmitted-tax-declarations?min-validFrom={start-date}&max-validFrom={end-date}

Name Type Required Description
org-id string yes Id of the organization
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/unsubmitted-tax-declarations?min-validFrom=2013-09-10&max-validFrom=2013-10-10

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "_about": "https://graph.ir.ee/tax-declarations/ee-11735006/vat-2013-09-20",
                "declarationType": "http://graph.ir.ee/tax-declaration-types/value-added-tax",
                "validFrom": "2013-09-20T00:00:00Z",
                "validThrough": "2013-10-11T21:13:45Z",
                "valid": "2013-10-11T21:13:45Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
_about URI yes URI of the unsubmitted tax declaration subject
declarationType URI yes Type of the tax declaration
validFrom dateTime yes Submission deadline for the unsubmitted tax declaration
validThrough dateTime no Date of the submission of the unsubmitted tax declaration
valid dateTime yes As of date of the unsubmitted tax declaration record

Get associated documents

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/documents

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/documents

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "_about": "https://graph.ir.ee/documents/ee-11735006-2013-a-a",
                "documentOf": "https://graph.ir.ee/organizations/ee-11735006",
                "creator": "https://graph.ir.ee/organizations/ee-11735006",
                "documentType": "http://graph.ir.ee/document-types/annual-declaration-pdf",
                "format": "application/pdf",
                "identifier": "9001816670",
                "reportType": "http://graph.ir.ee/report-types/annual-declaration",
                "reportYear": "2013",
                "isValid": "1",
                "submitted": "2014-07-29",
                "modified": "2014-12-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
_about URI yes URI of document subject
documentOf URI yes URI of the organization subject, which the document belongs to
creator URI yes URI of the organization subject, which is the creator of the document
documentType string yes Reference to a document type.
format string no Format of the document
identifier string yes Document identifier in Estonian business register
reportType string no Reference to the report type
reportYear string no Year of the report
isValid integer yes Document’s validity status.
  • 1 - indicates document is valid
  • 0 - indicates document is invalid
submitted date yes Date of the document submission
modified dateTime yes As of date of the document record
created dateTime yes Creation date of the document record

Get a debt summary of a organization

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/debts

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/debts

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "_about": "https://graph.ir.ee/debts/ee-11735006",
            "accumulatedInterest":{
                "amount": "10.12",
                "currency": "EUR",
                "startDate": "2013-07-17T16:20:51Z"
            },
            "debtTotal": {
                "amount": "154.45",
                "currency": "EUR",
                "startDate": "2013-07-17T16:20:51Z"
            },
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-07-17T16:20:51Z"
        }
    }
}
Name Type Required Description
_about URI yes URI of the debt subject
accumulatedInterest object no Accumulated interest as of specific date. Can include a single instance or an array of records
amount float yes Amount of the specific object
currency string yes Currency of the specific object
startDate string yes Monetary amount start date
debtTotal object yes The sum of all debt claims of a creditor for the specific debtor. Can include a single instance or an array of records
endDate string no Monetary amount end date
modified dateTime yes As of date of the debt record
created dateTime yes Creation date of the debt record

Get debt time series of an organization

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/debts?attribute={debt-element}&min-date={start-date}&max-date={end-date}

Name Type Required Description
org-id string yes Id of the organization
debt-element string yes Indicates the component of debt to be returned. Can be either “debtTotal” or “accumulatedInterest”
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/debts?attribute=debtTotal&min-date=2011-12-14&max-date=2015-01-21

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "amount": "154.45",
                "currency": "EUR",
                "startDate": "2012-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
amount float yes Amount of the specific object
currency string yes Currency of the specific object
endDate string no Monetary amount end date
startDate string yes Monetary amount start date

Get the latest debt claims of a organization

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/debts/debt-claims

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/debts/debt-claims

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "_about": "https://graph.ir.ee/debt-claims/ee-12345678-ee-11735006-m-500",
                "debtClaimType": "http://graph.ir.ee/claim-types/business-other-payables",
                "issuanceDate": "2010-06-14",
                "dueDate": "2010-12-25",
                "annualInterestRate": "0.00",
                "penalFine":{
                    "amount": "100.0",
                    "currency": "EUR",
                    "startDate": "2013-06-17T19:50:40Z"
                },
                "dailyPostMaturityInterestRate": "0.05",
                "claimAmount": {
                    "amount": "142.65",
                    "currency": "EUR",
                    "startDate": "2013-06-17T19:50:40Z"
                },
                "hasSupportingDocument": {
                    "documentIdentifier": "M-500",
                    "documentType": "http://graph.ir.ee/claim-supporting-document-types/invoice",
                    "documentSubject": "http://www.ebusiness-unibw.org/ontologies/pcs2owl/cpa/C_C-tax"
                },
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
_about URI yes URI of the debt-claim subject
debtClaimType string no Reference to debt claim type
issuanceDate date no Claim supporting document issuance date, i.e. invoice date
dueDate date yes Due date of the claim
annualInterestRate float no Annual interest rate for the claim
penalFine object no Penal fine. Can include a single instance or an array of records
amount float yes Amount of the specific object
currency string yes Currency of the specific object
startDate string yes Monetary amount start date
dailyPostMaturityInterestRate float no Daily post-maturity interest rate
claimAmount object yes Total amount of the debt claim. Can include a single instance or an array of records
hasSupportingDocument object yes Object of the supporting document
endDate string no Monetary amount end date
documentIdentifier string yes Identifier of the document
documentType string no Classification of supporting documents
documentSubject string no Reference to a class in NACE Rev 2 - CPA 2008 classifier
modified dateTime yes As of date of the debt claim record
created dateTime yes Creation date of the debt claim record

Get bankruptcy risk score as of a specific date

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/bankruptcy-risk-scores?date={data-update-date}

Name Type Required Description
org-id string yes Id of the organization
data-update-date string yes Specified date

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/bankruptcy-risk-scores?date=2014-12-18

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "hasDate": "2014-12-18",
            "hasValue": "0.29"
        }
    }
}
Name Type Required Description
hasDate date yes As of date of the bankruptcy risk score
hasValue float yes Current value of the bankruptcy risk score

Get bankruptcy risk scores time series of a period

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/bankruptcy-risk-scores?min-date={start-date}&max-date={end-date}

Name Type Required Description
org-id string yes Id of the organization
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/bankruptcy-risk-scores?min-date=2011-12-14&max-date=2015-01-21

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "hasDate": "2015-01-20",
                "hasValue": "0.36"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
hasDate date yes As of date of the bankruptcy risk score
hasValue float yes Current value of the bankruptcy risk score

Get current membership data

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/members

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/members

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization membership record
created dateTime yes Creation date of the organization membership record

Get current membership data with specific roles

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/members?role={role-id}

Name Type Required Description
org-id string yes Id of the organization
role-id string yes Id of the role

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/members?role=eusos2

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
hasEnd object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization membership record
created dateTime yes Creation date of the organization membership record

Get membership data at specific period of time

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/members?min-date={min-date}&max-date={max-date}

Name Type Required Description
org-id string yes Id of the organization
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-10283074/members?min-date=2013-04-17&max-date=2014-04-17

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
hasEnd object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization membership record
created dateTime yes Creation date of the organization membership record

Get membership data at specific period of time with specific role

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/members?role={role-id}&min-date={min-date}&max-date={max-date}

Name Type Required Description
org-id string yes Id of the organization
role-id string yes Id of the role
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-10283074/members?role=eusos2&min-date=2013-04-17&max-date=2014-04-17

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
hasEnd object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization membership record
created dateTime yes Creation date of the organization membership record

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/related-members

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/related-members

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
hasEnd object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization related membership record
created dateTime yes Creation date of the organization related membership record

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/related-members?min-date={min-date}&max-date={max-date}

Name Type Required Description
org-id string yes Id of the organization
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/related-members?min-date=2014-04-17&max-date=2015-09-17

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization related membership record
created dateTime yes Creation date of the organization related membership record

Get current board membership data

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/board-members

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/board-members

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2012-07-18T16:20:51Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T16:20:51Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-13T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the board member record
created dateTime yes Creation date of the board member record

Get board membership data at specific period of time

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/board-members?min-date={min-date}&max-date={max-date}

Name Type Required Description
org-id string yes Id of the organization
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/board-members?min-date=2014-04-17&max-date=2015-09-17

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2012-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2014-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-13T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the board member record
created dateTime yes Creation date of the board member record

Get current membership organization data

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/memberships

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/memberships

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "legalName": "24SEVEN CONSULT OÜ",
                    "registrationCode": "11787405",
                    "registrationDate": "2019-11-27T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-14T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Member’s organization information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
registrationDate dateTime yes Organization registration date
registrationCode dateTime yes Organization registration identifying code
registrationCountryCode string yes Organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization membership record
created dateTime yes Creation date of the organization membership record

Get current membership organization data with specific roles

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/memberships?role={role-id}

Name Type Required Description
org-id string yes Id of the organization
role-id string yes Id of the role

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/memberships?role=ceo

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "legalName": "24SEVEN CONSULT OÜ",
                    "registrationCode": "11787405",
                    "registrationDate": "2019-11-27T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Member’s organization information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
registrationDate dateTime yes Organization registration date
registrationCode dateTime yes Organization registration identifying code
registrationCountryCode string yes Organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization membership record
created dateTime yes Creation date of the organization membership record

Get membership organization data at specific period of time

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/memberships?min-date={start-date}&max-date={end-date}

Name Type Required Description
org-id string yes Id of the organization
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/memberships?min-date=2011-12-14&max-date=2015-01-21

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "legalName": "24SEVEN CONSULT OÜ",
                    "registrationCode": "11787405",
                    "registrationDate": "2019-11-27T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-14T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Member’s organization information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
registrationDate dateTime yes Organization registration date
registrationCode dateTime yes Organization registration identifying code
registrationCountryCode string yes Organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization membership record
created dateTime yes Creation date of the organization membership record

Get membership organization data with specific roles at specific period of time

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/memberships?role={role-id}&min-date={start-date}&max-date={end-date}

Name Type Required Description
org-id string yes Id of the organization
role-id string yes Id of the role
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/memberships?role={ceo}&min-date=2011-12-14&max-date=2015-01-21

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "legalName": "24SEVEN CONSULT OÜ",
                    "registrationCode": "11787405",
                    "registrationDate": "2019-11-27T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Member’s organization information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
registrationDate dateTime yes Organization registration date
registrationCode dateTime yes Organization registration identifying code
registrationCountryCode string yes Organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization membership record
created dateTime yes Creation date of the organization membership record

Get current board membership organization data

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/board-memberships

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/board-memberships

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "legalName": "24SEVEN CONSULT OÜ",
                    "registrationCode": "11787405",
                    "registrationDate": "2012-08-13T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-13T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Member’s organization information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
registrationDate dateTime yes Organization registration date
registrationCode dateTime yes Organization registration identifying code
registrationCountryCode string yes Organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the board member record
created dateTime yes Creation date of the board member record

Get board membership organization data at specific period of time

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/board-memberships?min-date={start-date}&max-date={end-date}

Name Type Required Description
org-id string yes Id of the organization
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/board-memberships?min-date=2011-12-14&max-date=2015-01-21

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "legalName": "24SEVEN CONSULT OÜ",
                    "registrationCode": "11787405",
                    "registrationDate": "2012-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-13T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Member’s organization information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
registrationDate dateTime yes Organization registration date
registrationCode dateTime yes Organization registration identifying code
registrationCountryCode string yes Organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the board member record
created dateTime yes Creation date of the board member record

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/related-memberships

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/related-memberships

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "legalName": "24SEVEN CONSULT OÜ",
                    "registrationCode": "11787405",
                    "registrationDate": "2019-11-27T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/d",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Member’s organization information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
registrationDate dateTime yes Organization registration date
registrationCode dateTime yes Organization registration identifying code
registrationCountryCode string yes Organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization related membership record
created dateTime yes Creation date of the organization related membership record

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/related-memberships?min-date={start-date}&max-date={end-date}

Name Type Required Description
org-id string yes Id of the organization
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/related-memberships?min-date=2011-12-14&max-date=2015-01-21

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "legalName": "24SEVEN CONSULT OÜ",
                    "registrationCode": "11787405",
                    "registrationDate": "2019-11-27T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Member’s organization information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
registrationDate dateTime yes Organization registration date
registrationCode dateTime yes Organization registration identifying code
registrationCountryCode string yes Organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the organization related membership record
created dateTime yes Creation date of the organization related membership record

Get current representation rights data

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/representation-rights

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/representation-rights

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "representationRightRegulation": "Sihtasutust võib kõikide tehingute tegemisel esindada iga juhatuse liige.",
                "representationRightRegulationType": "http://graph.ir.ee/representation-right-types/normal",
                "representationRightPeriod":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-14T00:00:00"
                    }
                },
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
representationRightRegulation string yes Representation right regulation
representationRightRegulationType URI yes Type of the representation right regulation
representationRightPeriod object yes Representation right period
hasBeginning object no Representation right start date
hasEnd object no Representation right end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the representation-rights record
created dateTime yes Creation date of the representation-rights record

Get representation rights of a period

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/representation-rights?min-date={start-date}&max-date={end-date}

Name Type Required Description
org-id string yes Id of the organization
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/representation-rights?min-date=2011-12-13&max-date=2015-01-21

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "representationRightRegulation": "Sihtasutust võib kõikide tehingute tegemisel esindada iga juhatuse liige.",
                "representationRightRegulationType": "http://graph.ir.ee/representation-right-types/normal",
                "representationRightPeriod":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-14T00:00:00"
                    }
                },
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
representationRightRegulation string yes Representation right regulation
representationRightRegulationType URI yes Type of the representation right regulation
representationRightPeriod object yes Representation right period
hasBeginning object no Representation right start date
hasEnd object no Representation right end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the representation-rights record
created dateTime yes Creation date of the representation-rights record

Get currently registered immovable properties

Request

Make a HTTP GET to URL

https://graph.ir.ee/organization/{org-id}/registered-immovables

Name Type Required Description
org-id string yes Organization id

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/registered-immovables

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "hasImmovable": "https://graph.ir.ee/registered-immovables/1235901",
                "hasOwner": "https://graph.ir.ee/organizations/ee-11224441",
                "hasShare": "https://graph.ir.ee/physical-shares/ee-11224441-1235901",
                "ownerDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2013-04-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                }
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
hasImmovable URL yes Has immovable
hasOwner URL yes Has owner
hasShare URL yes Has share
ownerDuring object yes Ownership Period
hasBeginning object no Membership start date
hasEnd object no Membership start date

Get registered immovable properties at specific period of time

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/registered-immovables?min-date={min-date}&max-date={max-date}

Name Type Required Description
org-id string yes Organization id
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/organizations/ee-11224441/registered-immovables?min-date=2011-08-21&max-date=2015-08-01

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "hasImmovable": "https://graph.ir.ee/registered-immovables/1235901",
                "hasOwner": "https://graph.ir.ee/organizations/ee-11224441",
                "hasShare": "https://graph.ir.ee/physical-shares/ee-11224441-1235901",
                "ownerDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2013-04-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                }
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
hasImmovable URL yes Has immovable
hasOwner URL yes Has owner
hasShare URL yes Has share
ownerDuring object yes Ownership Period
hasBeginning object no Membership start date
hasEnd object no Membership start date

Get organization addresses (Available only through API v3)

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/addresses

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/addresses

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "adr_id": "2123811",
                "codeAddress": "37784048200000JYH00003EMZ00000000",
                "fullAddress": " Harju maakond, Tallinn, Mustamäe linnaosa, Ehitajate tee 86",
                "countryName": "Eesti",
                "locality": "Tallinn",
                "postalCode": "12915",
                "region": "Harjumaa",
                "streetAddress": "Ehitajate tee 86",
                "hasComponent": "https://graph.ir.ee/address-components/1-37",
                "latitude": "59.408175",
                "longitude": "24.668858",
                "location":{
                    "x": "6585774.21",
                    "y": "537986.86"
                },
                "hasPreviousVersion": "https://graph.ir.ee/addresses/101860",
                "hasNextVersion": "https://graph.ir.ee/addresses/246801",
                "duration":{
                    "hasBeginning": {
                        "inXSDDateTime": "2013-04-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                },
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
adr_id string yes Identificator of an address in the national address information system (ADS)
codeAddress string yes Encoded address
fullAddress string yes Full address in textual format
countryName string no Country name
locality string no The locality (e.g. city or town)
postalCode string no Postal code. Can include a single instance or an array of records
region string no Region (e.g. state or province)
streetAddress string no Street address
hasComponent URI no Reference to related address components. Can include a single instance or an array of records
latitude string no X coordinate in wgs84 coordinate system
longitude string no Y coordinate in wgs84 coordinate system
location object no Address location in L-EST coordinate system
x string no X coordinate in L-EST coordinate system
y string no Y coordinate in L-EST coordinate system
hasPreviousVersion URI no Previous version of address. Can include a single instance or an array of records.
hasNextVersion URI no Next version of address. Can include a single instance or an array of records.
duration object no Interval for which the address is/was valid
hasBeginning object no Address valid from date
hasEnd object no Address valid until date
modified dateTime yes As of date of the address record
created dateTime yes Creation date of the address record

Get locations (Available only through API v2)

Request

Make a HTTP GET to URL

https://graph.ir.ee/organizations/{org-id}/locations

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/organizations/ee-11735006/locations

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "_about": "https://graph.ir.ee/locations/filosoofi-3-tartu-tartumaa-eesti",
                "countryName": "Eesti",
                "locality": "Tartu",
                "postalCode": "50108",
                "region": "Tartumaa",
                "streetAddress": "Filosoofi 3"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
_about URI yes URI of the location subject
countryName string no Country name
locality string no The locality (e.g. city or town)
postalCode string no Postal code
region string no Region (e.g. state or province)
streetAddress string no Street address

Insert an organization

Request

Make a HTTP POST to URL with data added to the request body in a JSON object

https://graph.ir.ee/organizations?graph={graph-uri}

Example query:

https://graph.ir.ee/organizations?graph=https://graph.ir.ee/graphs/persons/ee-37612016781/debts/ee-11735006-ee-37612016781/2015-04-01-08-34-50

{
    "registration-code": "11735006",
    "country-code": "EE",
    "legal-name": "Register OÜ"
}
Name Type Required Description
registration-code string yes Registration code of the organization
country-code string yes Country code of the country where the organization is registered
legal-name string yes Legal name of the organization

Response

Example response Location header:

Location: https://graph.ir.ee/organizations/ee-11735006?graph=https://graph.ir.ee/graphs/persons/ee-37612016781/debts/ee-11735006-ee-37612016781/2015-04-01-08-34-50

On succesful POST request the response contains status 201 Created and the Location header contains URL encoded URI of the created subject and the graph URI.

/ownerships

Get ownership object data details

Request

Make a HTTP GET to URL

https://graph.ir.ee/ownerships/{ownershipId}

Name Type Required Description
ownershipId string yes Id of the ownership object

Response

Example query:

https://graph.ir.ee/ownerships/ee-10000018-48103

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "hasOwner": "https://graph.ir.ee/persons/ee-37808054713",
            "hasImmovable": "https://graph.ir.ee/registered-immovables/1892601",
            "hasShare": "https://graph.ir.ee/immovable-shares/ee-38712280306-18662201",
            "ownerDuring":{
                "hasBeginning": {
                    "inXSDDateTime": "2013-04-13T00:00:00Z"
                },
                "hasEnd": {
                    "inXSDDateTime": "2014-01-12T00:00:00Z"
                }
            },
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
hasOwner URL yes Owner object URL
hasImmovable URI yes Immovable object URL
hasShare URI yes Immovable share object URL
ownerDuring object yes Ownership Period
hasBeginning object yes Membership start date
hasEnd object no Membership start date
hasBeginning object yes Ownership start date
hasEnd object no Ownership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the contact record
created dateTime yes Creation date of the contact record

/persons

Get a person record

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}

Name Type Required Description
person-id string yes Id of the person

Response

Example query:

https://graph.ir.ee/persons/ee-37612016781

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "familyName": "Tamm",
            "givenName": "Jaan",
            "hasAggregatedDebt": "https://graph.ir.ee/debts/ee-12345678-ee-37612016781",
            "identifier": "37612016781",
            "countryCode": "EE",
            "birthDate": "1965-05-21",
            "gender": "M",
            "memberOf": "https://graph.ir.ee/organizations/ee-12345678",
            "hasMembership": "https://graph.ir.ee/memberships/ee-12345678-ee-37612016781-juhl",
            "basedAt": "https://graph.ir.ee/sites/ee-37612016781-contacts",
            "modified": "2014-08-18T19:50:40Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
familyName string yes Family name of the person
givenName string yes Given name of the person
hasAggregatedDebt URI no URI of a person’s debt subject. Can include a single instance or an array of records
identifier string yes Identifier of the person subject
countryCode string yes Code of the country where the person is registered
birthDate date no The birth date of the person
gender string no Gender of the person
memberOf URI no URI of the organization the person is a member.
hasMembership URI no URI of the membership, where the person is a member.
basedAt string no URI of a site at which the person has some presence
modified dateTime yes As of date of the person record
created dateTime yes Creation date of the person record

Get a debt summary of a person

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/debts

Name Type Required Description
person-id string yes Id of the person

Response

Example query:

https://graph.ir.ee/persons/ee-37612016781/debts

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "_about": "https://graph.ir.ee/debts/ee-37612016781",
            "accumulatedInterest":{
                "amount": "10.12",
                "currency": "EUR",
                "startDate": "2013-06-17T19:50:40Z"
            },
            "debtTotal": {
                "amount": "154.45",
                "currency": "EUR",
                "startDate": "2013-06-17T19:50:40Z"
            },
            "modified": "2014-08-18T19:50:40Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
_about URI yes URI of the debt subject
accumulatedInterest object no Accumulated interest as of specific date. Can include a single instance or an array of records
amount float yes Amount of the specific object
currency string yes Currency of the specific object
startDate string yes Monetary amount start date
debtTotal object yes The sum of all debt claims of a creditor for the specific debtor. Can include a single instance or an array of records
endDate string no Monetary amount end date
modified dateTime yes As of date of the debt record
created dateTime yes Creation date of the debt record

Get the latest debt claims of a person

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/debts/debt-claims

Name Type Required Description
person-id string yes Id of the person

Response

Example query:

https://graph.ir.ee/persons/ee-37612016781/debts/debt-claims

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "_about": "https://graph.ir.ee/debt-claims/ee-12345678-ee-37612016781-m-500",
            "debtClaimType": "http://graph.ir.ee/claim-types/consumer-hmr-mortgage",
            "issuanceDate": "2010-06-14",
            "dueDate": "2010-02-25",
            "annualInterestRate": "0.00",
            "penalFine":{
                "amount": "100.0",
                "currency": "EUR",
                "startDate": "2013-06-17T19:50:40Z"
            },
            "dailyPostMaturityInterestRate": "0.05",
            "claimAmount": {
                "amount": "142.65",
                "currency": "EUR",
                "startDate": "2013-06-17T19:50:40Z"
            },
            "hasSupportingDocument":{
                "documentIdentifier": "M-500",
                "documentType": "http://graph.ir.ee/claim-supporting-document-types/invoice",
                "documentSubject": "http://www.ebusiness-unibw.org/ontologies/pcs2owl/cpa/C_C-tax"
            },
            "modified": "2014-08-18T19:50:40Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
_about URI yes URI of the debt claim subject
debtClaimType string no Reference to debt claim type
issuanceDate date no Claim supporting document issuance date, i.e. invoice date
dueDate date yes Due date of the claim
annualInterestRate float no Annual interest rate for the claim
penalFine float no Penal fine. Can include a single instance or an array of records
amount float yes Amount of the specific object
currency string yes Currency of the specific object
startDate string yes Monetary amount start date
dailyPostMaturityInterestRate float no Daily post-maturity interest rate
claimAmount float yes Total amount of the debt claim. Can include a single instance or an array of records
hasSupportingDocument object yes Object of the supporting document
documentIdentifier string yes Identifier of the document
documentType string no Classification of supporting documents
documentSubject string no Reference to a class in NACE Rev 2 - CPA 2008 classifier
endDate string no Monetary amount end date
modified dateTime yes As of date of the debt claim record
created dateTime yes Creation date of the debt claim record

Get debt time series of a person

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/debts?attribute={debt-element}&min-date={start-date}&max-date={end-date}

Name Type Required Description
person-id string yes Id of the person
debt-element string yes Indicates the component of debt to be returned. Can be either “debtTotal” or “accumulatedInterest”
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/persons/ee-37612016781/debts?attribute=debtTotal&min-date=2011-12-14&max-date=2015-01-21

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "amount": "154.45",
                "currency": "EUR",
                "startDate": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
amount float yes Amount of the specific object
currency string yes Currency of the specific object
endDate string no Monetary amount end date
startDate string yes Monetary amount start date

Get current membership data

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/memberships

Name Type Required Description
person-id string yes Id of the person

Response

Example query:

https://graph.ir.ee/persons/ee-37808054713/memberships

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Peep",
                    "familyName": "Kungas",
                    "gender": "M",
                    "birthDate": "1978-08-05",
                    "identifier": "37808054713",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "SOA TRADER OÜ",
                    "registrationDate": "2006-02-27T00:00:00Z",
                    "registrationCode": "11224441",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-30"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the person’s membership record
created dateTime yes Creation date of the person’s membership record

Get membership data with specific role

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/memberships?role={role-id}

Name Type Required Description
person-id string yes Id of the person
role-id string yes Id of the role

Response

Example query:

https://graph.ir.ee/persons/ee-37808054713/memberships?role=ceo

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Peep",
                    "familyName": "Kungas",
                    "gender": "M",
                    "birthDate": "1978-08-05",
                    "identifier": "37808054713",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "SOA TRADER OÜ",
                    "registrationDate": "2006-02-27T00:00:00Z",
                    "registrationCode": "11224441",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-30"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the person’s membership record
created dateTime yes Creation date of the person’s membership record

Get membership data at specific period of time

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/memberships?min-date={min-date}&max-date={max-date}

Name Type Required Description
person-id string yes Id of the person
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/persons/ee-37808054713/memberships?min-date=2013-08-21&max-date=2014-08-21

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Peep",
                    "familyName": "Kungas",
                    "gender": "M",
                    "birthDate": "1978-08-05",
                    "identifier": "37808054713",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "SOA TRADER OÜ",
                    "registrationDate": "2006-02-27T00:00:00Z",
                    "registrationCode": "11224441",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-09-30"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2014-08-18T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
hasEnd object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the person’s membership record
created dateTime yes Creation date of the person’s membership record

Get membership data with specific role at specific period of time

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/memberships?role={role-id}min-date={min-date}&max-date={max-date}

Name Type Required Description
person-id string yes Id of the person
role-id string yes Id of the role
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/persons/ee-37808054713/memberships?role=ceo&min-date=2014-08-21&max-date=2015-08-21

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Peep",
                    "familyName": "Kungas",
                    "gender": "M",
                    "birthDate": "1978-08-05",
                    "identifier": "37808054713",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "SOA TRADER OÜ",
                    "registrationDate": "2006-02-27T00:00:00Z",
                    "registrationCode": "11224441",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-09-30"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2015-01-12"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
hasEnd object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the person’s membership record
created dateTime yes Creation date of the person’s membership record

Get current board membership data

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/board-memberships

Name Type Required Description
org-id string yes Id of the person

Response

Example query:

https://graph.ir.ee/persons/ee-49102190245/board-memberships

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the person’s membership record
created dateTime yes Creation date of the person’s membership record

Get board membership data at specific period of time

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/board-memberships?min-date={min-date}&max-date={max-date}

Name Type Required Description
person-id string yes Id of the person
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/persons/ee-49102190245/board-memberships?min-date=2014-04-17&max-date=2015-09-17

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "EXTRACT OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2014-07-11T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2012-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2013-06-17T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the person’s membership record
created dateTime yes Creation date of the person’s membership record

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/related-memberships

Name Type Required Description
person-id string yes Id of the person

Response

Example query:

https://graph.ir.ee/persons/ee-37705050239/related-memberships

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member": {
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization": {
                    "legalName": "SOA TRADER OÜ",
                    "registrationDate": "2006-02-27T00:00:00Z",
                    "registrationCode": "11224441",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2014-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2014-08-18T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
organization object yes Member’s organization information
memberDuring object yes Membership Period
hasBeginning object no Membership start date
role URI yes URI of the member’s role
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
legalName string yes Member’s organization name
registrationDate dateTime yes Member’s organization registration date
registrationCode dateTime yes Member’s organization registration identifying code
registrationCountryCode string yes Member’s organiation country code
hasBeginning object no Membership start date
hasEnd object no Membership end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the person’s related membership record
created dateTime yes Creation date of the person’s related membership record

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/related-memberships?min-date={min-date}&max-date={max-date}

Name Type Required Description
org-id string yes Id of the person
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.ee/persons/ee-37705050239/related-memberships?min-date=2014-04-17&max-date=2015-09-17

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "member":{
                    "givenName": "Mari",
                    "familyName": "Metsla",
                    "gender": "F",
                    "birthDate": "1991-02-19",
                    "identifier": "49102190245",
                    "countryCode": "EE"
                },
                "organization":{
                    "legalName": "SOA TRADER OÜ",
                    "registrationCode": "11224441",
                    "registrationDate": "2006-02-27T00:00:00Z",
                    "registrationCountryCode": "EE"
                },
                "memberDuring":{
                    "hasBeginning":{
                        "inXSDDateTime": "2014-08-13T00:00:00Z"
                    }
                },
                "role": "http://graph.ir.ee/membership-roles/ceo",
                "modified": "2014-08-18T19:50:40Z",
                "created": "2014-08-18T19:50:40Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
member object yes Members personal information
givenName string yes Member’s given name
familyName string yes Member’s family name
gender string yes Member’s gender
birthDate string yes Member’s birth date
identifier string yes Member’s id code
countryCode string yes Member’s country code
organization object yes Member’s organization information
legalName string yes Member’s organization name
registrationCode string yes Member’s organization id code
registrationDate dateTime yes Member’s organization registration date
registrationCountryCode string yes Member’s organization country code
memberDuring object yes Membership Period
hasBeginning object no Membership start date
inXSDDateTime dateTime yes Date value
role URI yes URI of the member’s role
hasEnd object no Membership end date
modified dateTime yes As of date of the person’s related membership record
created dateTime yes Creation date of the person’s related membership record

Get currently registered immovable properties

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/registered-immovables

Name Type Required Description
person-id string yes Person id

Response

Example query:

https://graph.ir.eepersons/ee-37808054713/registered-immovables

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "hasImmovable": "https://graph.ir.ee/registered-immovables/7885901",
                "hasOwner": "https://graph.ir.ee/persons/ee-37808054713",
                "hasShare": "https://graph.ir.ee/physical-shares/ee-38101016038-7885901",
                "ownerDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2013-04-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                }
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
hasImmovable URL yes Has immovable
hasOwner URL yes Has owner
hasShare URL yes Has share
ownerDuring object yes Ownership Period
hasBeginning object no Membership start date
hasEnd object no Membership start date

Get registered immovable properties at specific period of time

Request

Make a HTTP GET to URL

https://graph.ir.ee/persons/{person-id}/registered-immovables?min-date={min-date}&max-date={max-date}

Name Type Required Description
person-id string yes Person id
start-date string yes Start date of the specified period
end-date string yes End date of the specified period

Response

Example query:

https://graph.ir.eepersons/ee-37808054713/registered-immovables?min-date=2011-08-21&max-date=2015-08-01

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "hasImmovable": "https://graph.ir.ee/registered-immovables/7885901",
                "hasOwner": "https://graph.ir.ee/persons/ee-37808054713",
                "hasShare": "https://graph.ir.ee/physical-shares/ee-38101016038-7885901",
                "ownerDuring":{
                    "hasBeginning": {
                        "inXSDDateTime": "2013-04-13T00:00:00Z"
                    },
                    "hasEnd": {
                        "inXSDDateTime": "2014-01-12T00:00:00Z"
                    }
                }
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
hasImmovable URI yes Has immovable
hasOwner URI yes Has owner
hasShare URI yes Has share
ownerDuring object yes Ownership Period
hasBeginning object yes Membership start date
hasEnd object no Membership start date

Insert a person

Request

Make a HTTP POST to URL with data added to the request body in a JSON object

https://graph.ir.ee/persons?graph={graph-uri}

Example query:

https://graph.ir.ee/persons?graph=https://graph.ir.ee/graphs/persons/ee-37612016781/debts/ee-11735006-ee-37612016781/2015-04-01-08-34-50

{
    "identification-code": "37612016781",
    "country-code": "EE",
    "given-name": "Jaan",
    "family-name": "Tamm"
}
Name Type Required Description
identification-code string yes Person’s identification code
country-code string yes Code of the country where the person is registered
given-name string yes Given name of the person
family-name string yes Family name of the person

Response

Example response Location header:

Location: https://graph.ir.ee/persons/ee-37612016781?graph=https://graph.ir.ee/graphs/persons/ee-37612016781/debts/ee-11735006-ee-37612016781/2015-04-01-08-34-50

On succesful POST request the response contains status 201 Created and the Location header contains URL encoded URI of the created subject and the graph URI.

/physical-shares

Get immovable shares data details

Request

Make a HTTP GET to URL

https://graph.ir.ee/physical-shares/{shareId}

Name Type Required Description
shareId string yes Id of the physical share

Response

Example query:

https://graph.ir.ee/physical-shares/ee-37808054713-4719204

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "hasAddress": "https://graph.ir.ee/address-objects/er03238216",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
hasAddress URL yes Address object Id
modified dateTime yes As of date of the physical share record
created dateTime yes Creation date of the physical share record

/predictions

Get the latest bankruptcy risk scores

Request

Make a HTTP GET to URL

https://graph.ir.ee/predictions/organizations/{org-id}/bankruptcy-risk-scores

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/predictions/organizations/ee-11735006/bankruptcy-risk-scores

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "hasDate": "2015-06-13",
                "hasValue": "0.458"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
hasDate date yes As of date of the bankruptcy risk score
hasValue float yes Current value of the bankruptcy risk score

/representation-rights

Get representation rights data

Request

Make a HTTP GET to URL

https://graph.ir.ee/representation-rights/{rep-right-id}

Name Type Required Description
rep-right-id string yes Id of the representation right

Response

Example query:

https://graph.ir.ee/representation-rights/ee-11735006-2012-08-13

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "representationRightRegulation": "Sihtasutust võib kõikide tehingute tegemisel esindada iga juhatuse liige.",
            "representationRightRegulationType": "http://graph.ir.ee/representation-right-types/normal",
            "representationRightPeriod":{
                "hasBeginning": {
                    "inXSDDateTime": "2012-08-13T16:20:51Z"
                },
                "hasEnd": {
                    "inXSDDateTime": "2014-01-12T16:20:51Z"
                }
            },
            "modified": "2014-12-18T16:20:51Z",
            "created": "2013-06-17T19:50:40Z"
        }
    }
}
Name Type Required Description
representationRightRegulation string yes Representation right regulation
representationRightRegulationType URI yes Type of the representation right regulation
representationRightPeriod object yes Representation right period
hasBeginning object no Representation right start date
hasEnd object no Representation right end date
inXSDDateTime dateTime yes Date value
modified dateTime yes As of date of the representation-rights record
created dateTime yes Creation date of the representation-rights record

/sites

Get site contacts data

Request

Make a HTTP GET to URL

https://graph.ir.ee/sites/{org-id}-contacts

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/sites/ee-11735006-contacts

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "siteAddress": "https://graph.ir.ee/contacts/ee-11735006",
            "siteOf": "https://graph.ir.ee/organizations/ee-11735006",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2014-06-17T16:20:51Z"
        }
    }
}
Name Type Required Description
siteAddress URI yes URI of the contact details of the organization. Can include a single instance or an array of records
siteOf URI no URI of the organization subject
modified dateTime yes As of date of the organization record
created dateTime yes Creation date of the organization record

Get primary site data (Available only through API v2)

Request

Make a HTTP GET to URL

https://graph.ir.ee/sites/{org-id}-primary

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/sites/ee-10220748-primary

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "siteAddress": "https://graph.ir.ee/locations/kalmistu-tee-28b-tallinn-harjumaa-eesti",
            "siteOf": "https://graph.ir.ee/organizations/ee-10220748",
            "modified": "2015-06-03T10:15:01Z",
            "created": "2015-06-03T10:15:01Z"
        }
    }
}
Name Type Required Description
siteAddress URI yes URI of the primary site location details of the organization. Can include a single instance or an array of records
siteOf URI no URI of the organization subject
modified dateTime yes As of date of the organization record
created dateTime yes Creation date of the organization record

Get registered site data (Available only through API v2)

Request

Make a HTTP GET to URL

https://graph.ir.ee/sites/{org-id}-registered

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/sites/ee-11896590-registered

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "siteAddress": "https://graph.ir.ee/locations/jakobi-tn-19-parnu-parnumaa-eesti",
            "siteOf": "https://graph.ir.ee/organizations/ee-11896590",
            "modified": "2015-06-03T10:15:00Z",
            "created": "2016-07-11T12:29:38Z"
        }
    }
}
Name Type Required Description
siteAddress URI yes URI of the registered site location details of the organization. Can include a single instance or an array of records
siteOf URI no URI of the organization subject
modified dateTime yes As of date of the organization record
created dateTime yes Creation date of the organization record

Get registered site data (Available only through API v3)

Request

Make a HTTP GET to URL

https://graph.ir.ee/sites/{org-id}-registered

Name Type Required Description
org-id string yes Id of the organization

Response

Example query:

https://graph.ir.ee/sites/ee-11896590-registered

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "siteAddress": "https://graph.ir.ee/addresses/2114886",
            "siteOf": "https://graph.ir.ee/organizations/ee-11896590",
            "siteOfObject": "https://graph.ir.ee/address-objects/me00647519",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2014-06-17T16:20:51Z"
        }
    }
}
Name Type Required Description
siteAddress URI yes URI of the registred site address details of the organization. Can include a single instance or an array of records
siteOf URI no URI of the organization subject
siteOfObject URI no URI of the address object subject
modified dateTime yes As of date of the organization record
created dateTime yes Creation date of the organization record

/tax-debts

Get all details of a tax debt

Request

Make a HTTP GET to URL

https://graph.ir.ee/tax-debts/{tax-debt-id}

Name Type Required Description
tax-debt-id string yes Id of the tax debt

Response

Example query:

https://graph.ir.ee/tax-debts/ee-11735006

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "accumulatedInterest": "https://graph.ir.ee/monetary-amounts/ee-11735006-2013-06-17-19-50-40-accumulated-interest",
            "contestedTotal": "https://graph.ir.ee/monetary-amounts/ee-11735006-2013-06-17-19-50-40-contested-total",
            "debtTotal": "https://graph.ir.ee/monetary-amounts/ee-11735006-2013-06-17-19-50-40-debt-total",
            "includesClaim": "https://graph.ir.ee/debt-claims/ee-11735006-interest",
            "onScheduleAccumulatedInterest": "https://graph.ir.ee/monetary-amounts/ee-11735006-2013-06-17-19-50-40-on-schedule-accumulated-interest",
            "onScheduleTotal": "https://graph.ir.ee/monetary-amounts/ee-11735006-2013-06-17-19-50-40-on-schedule-total",
            "scheduleOfPaymentDueDate": "2013-10-30",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2014-06-17T16:20:51Z",
            "hasDebtor": "https://graph.ir.ee/organizations/ee-11735006"
        }
    }
}
Name Type Required Description
accumulatedInterest URI no Accumulated interest as of specific date
contestedTotal URI yes Contested amount of the debt over all claims in the debt record as of specific date
debtTotal URI yes The sum of all tax debt claims
includesClaim URI no URI of an tax debt’s claim subject. Can include a single URI or an array of URIs
onScheduleAccumulatedInterest URI yes The amount of accumulated interests included into a payment schedule
onScheduleTotal URI yes Amount of total debt, which has been scheduled for payment
scheduleOfPaymentDueDate date no Due date of the payment schedule. Not returned if date is not set
debtSince date no The date when the debt incurred. Not returned if date is not set
modified dateTime yes As of date of the debt record
created dateTime yes Creation date of the debt record
hasDebtor URI yes URI of the debtor subject

Get claims of a tax debt

Request

Make a HTTP GET to URL

https://graph.ir.ee/tax-debts/{tax-debt-id}/debt-claims

Name Type Required Description
tax-debt-id string yes Id of the tax debt

Response

Example query:

https://graph.ir.ee/tax-debts/ee-11735006/debt-claims

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "contestedAmount":{
                    "amount": "0",
                    "currency": "EUR",
                    "startDate": "2013-06-17T19:50:40Z"
                },
                "claimAmount": {
                    "amount": "1588.95",
                    "currency": "EUR",
                    "startDate": "2013-06-17T19:50:40Z"
                },
                "debtClaimType": "https://graph.ir.ee/tax-debt-types/interest",
                "onScheduleAmount": {
                    "amount": "1588.95",
                    "currency": "EUR",
                    "startDate": "2014-06-17T19:50:40Z"
                },
                "modified": "2014-12-18T16:20:51Z",
                "created": "2014-06-17T16:20:51Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
contestedAmount object yes Contested amount of the debt claim. Can include a single instance or an array of records
amount float yes Amount of the specific object
currency string yes Currency of the specific object
startDate string yes Monetary amount start date
claimAmount object yes Total amount of the debt claim. Can include a single instance or an array of records
debtClaimType string yes Classification of the debt claim (For tax debt classification see: http://www.emta.ee/index.php?id=26207&highlight=ljastamise)
onScheduleAmount object yes Amount, which has been scheduled for payment. Can include a single instance or an array of records
endDate string no Monetary amount end date
modified dateTime yes As of date of the tax debt record
created dateTime yes Creation date of the tax debt record

/unsubmitted-tax-declarations

Get unsubmitted tax declaration data

Request

Make a HTTP GET to URL

https://graph.ir.ee/unsubmitted-tax-declarations/{org-id}/{tax-declaration-id}

Name Type Required Description
org-id string yes Id of the organization
tax-declaration-id string yes Id of the unsubmitted tax declaration

Response

Example query:

https://graph.ir.ee/unsubmitted-tax-declarations/ee-11735006/vat-2013-09-20

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "declarationType": "http://graph.ir.ee/tax-declaration-types/value-added-tax",
            "validFrom": "2013-09-20T00:00:00Z",
            "validThrough": "2013-10-11T21:13:45Z",
            "valid": "2013-10-11T21:13:45Z"
        }
    }
}
Name Type Required Description
declarationType URI yes Type of the tax declaration
validFrom dateTime yes Submission deadline for the unsubmitted tax declaration
validThrough dateTime no Date of the submission of the unsubmitted tax declaration
valid dateTime yes As of date of the unsubmitted tax declaration record

/vat-groups

Get VAT group content

Request

Make a HTTP GET to URL

https://graph.ir.ee/vat-groups/{vat-group-id}

Name Type Required Description
vat-group-id string yes Id of the VAT group

Response

Example query:

https://graph.ir.ee/vat-groups/ee-10068499-2010-01-01

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "hasMember": "https://graph.ir.ee/organizations/ee-10068453",
            "hasRepresentative": "https://graph.ir.ee/organizations/ee-10068499",
            "hasVATRegistration": "https://graph.ir.ee/vat-registrations/ee-10068499-2010-01-01",
            "vatID": "EE100058428",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2014-06-17T16:20:51Z"
        }
    }
}
Name Type Required Description
hasMember URI yes URI of a member organization subject. Can include a single instance or an array of records
hasRepresentative URI yes URI of the representative organization subject
hasVATRegistration URI yes URI of a associated VAT registration subject. Can include a single instance or an array of records
vatID string no The Value-added Tax ID
modified dateTime yes As of date of the vat group record
created dateTime yes Creation date of the vat group record

/vat-registrations

Search by VAT identifier

Request

Make a HTTP GET to URL

https://graph.ir.ee/vat-registrations?vat-id={vat-registration-number}

Name Type Required Description
vat-registration-id string yes Number of the VAT registration

Response

Example query:

https://graph.ir.ee/vat-registrations?vat-id=EE101339256

On successful request the body of the response contains metadata: 
{
    "result": {
        "items": [ 
            {   
                "vatRegistrationEndDate": "2009-12-31",
                "vatRegistrationEndDecisionDate": "2010-01-05",
                "vatRegistrationNumber": "EE101339256",
                "vatRegistrationStartDate": "1994-01-01",
                "vatRegistrationStartDecisionDate": "1994-01-01",
                "modified": "2014-12-18T16:20:51Z",
                "created": "2013-06-17T16:20:51Z"
            },
            {
                "..." : "..."
            }
        ]
    }
}
Name Type Required Description
vatRegistrationEndDate date no VAT registration end date. Only present when registration has ended
vatRegistrationEndDecisionDate date no VAT registration end decision date. Only present when registration has ended
vatRegistrationNumber string yes The Value-added Tax registration number
vatRegistrationStartDate date yes VAT registration start date
vatRegistrationStartDecisionDate date yes VAT registration start decision date
modified dateTime yes As of date of the vat registration record
created dateTime yes Creation date of the vat registration record

Get VAT registration content

Request

Make a HTTP GET to URL

https://graph.ir.ee/vat-registrations/{vat-registration-id}

Name Type Required Description
vat-registration-id string yes Id of the VAT registration

Response

Example query:

https://graph.ir.ee/vat-registrations/ee-10068499-2010-01-01

On successful request the body of the response contains metadata: 
{
    "result": {
        "primaryTopic": { 
            "vatRegistrationEndDate": "2010-10-31",
            "vatRegistrationEndDecisionDate": "2010-10-29",
            "vatRegistrationNumber": "EE100058428",
            "vatRegistrationStartDate": "2010-01-01",
            "vatRegistrationStartDecisionDate": "2010-01-05",
            "modified": "2014-12-18T16:20:51Z",
            "created": "2014-06-17T16:20:51Z"
        }
    }
}
Name Type Required Description
vatRegistrationEndDate date no VAT registration end date. Only present when registration has ended
vatRegistrationEndDecisionDate date no VAT registration end decision date. Only present when registration has ended
vatRegistrationNumber string yes The Value-added Tax registration number
vatRegistrationStartDate date yes VAT registration start date
vatRegistrationStartDecisionDate date yes VAT registration start decision date
modified dateTime yes As of date of the vat registration record
created dateTime yes Creation date of the vat registration record