BizInsights API Documentation v3.6

BizInsights API Service provides a programmatic access via REST API to allow users to tap into BizInsights' database.

Users are able to acquire data of a corporate entity or an individual that is registered with Accounting and Corporate Regulatory Authority (ACRA) of Singapore by using our Search API. Users are also able to tap on our Report API to generate report, be it for filing purposes or KYC.

The REST API identifies the users via a token and the format of the results are in JSON.

Entity Search

Our Entity Search API provides access to our search engine to obtain basic information of people and corporate entities. You can do a search using part of the name of the entity that you would like to search for. Alternatively, you can provide the full ID or Unique Entity Number (UEN) of the entity as a search query. The search will only return first 100 records available for each result set. If you did not get the result you desire, you would need to refine your search query.

Request

To search for entities, you will need to provide the url as per below:

https://api.bizinsights.net/api/search?[token=]&[entity=]&[query=]

e.g. https://api.bizinsights.net/api/search?token=123456&entity=corporate&query=test

The definition of each parameter is explained in the table below.

Response

The search response is returned in json format.

{
  "category": "corporate",
  "message": "Got 1 results in 40ms. Showing only top 100 results",
  "timestamp": 1519095833037,
  "results": [
    {
      "id": "123",
      "name": "ABC",
      "formername": "DEF",
      "status": "LIVE",
      "address": "30 PASIR PANJANG ROAD #10-31/32 SINGAPORE 117440",
      "reports": [
        "BPF",
        "EBPF",
        "CBPF"
      ]
    }
  ]
}

The definition of each key is explained in the table below

{
  "results": {
    "corporate": [
      {
        "id": 123,
        "name": "ABC",
        "formername": "DEF",
        "status": "LIVE",
        "address": "30 PASIR PANJANG ROAD #10-31/32 SINGAPORE 117440",
        "reports": [
          "BPF",
          "EBPF",
          "CBPF"
        ]
      }
    ],
    "person": [
      {
        "id": "S1234567A",
        "name": "KELVIN TAN",
        "appointments": 1,
        "reports": [
          "PPF"
        ]
      }
    ]
  }
}

{
  "id": 123,
  "name": "ABC",
  "formername": "DEF",
  "status": "LIVE",
  "address": "30 PASIR PANJANG ROAD #10-31/32 SINGAPORE 117440",
  "reports": [
    "BPF",
    "EBPF",
    "CBPF"
  ]
}

{
  "id": "S1234567A",
  "name": "KELVIN TAN",
  "appointments": 1,
  "reports": [
    "PPF"
  ]
}

Report Generation

The Report Generation API provides a way to purchase the reports of corporate entity or person without any UI. The reports provided are the same with those reports that are purchased through our web portal. For more information on the reports we provide, please click here.

Request

To generate reports, you will need to provide the url as per below:

https://api.bizinsights.net/api/generate?[token=]&[type=]&[id=]&[year=]&[mime-type=]&[remarks=]

e.g. https://api.bizinsights.net/api/generate?token=123456&type=fsh&id=123456R&year=2016&mime-type=application/pdf&remarks=abc

The definition of each parameter is explained in the table below.

Response

The report generation response is returned in JSON format.

{
  "referenceID": "XXXX-XXXX-XXXX-XXXX",
  "username": "testuser",
  "timestamp": 1499520492353,
  "remarks": "abc",
  "link": "http://this.is.a.download.link"
}

The definition of each key is explained in the table below

Profile

The Profile API allows user to access the information of the account registered with BizInsights. The development of this API is always ongoing, which means that new endpoints/functionalities will be available in the future.

When you register with BizInsights, we have requested some information from you which helps us identify you better. These information can be retrieved and updated, should there be a need for it. No sensitive information can be retrieved from this API.

Below are the currently available functionalities

Retrieval

To retrieve the profile information, send a GET request to the url with the parameters as per below:

https://api.bizinsights.net/profile/details?[token=]

e.g. https://api.bizinsights.net/profile/details?token=12345A

The search result is returned in json format

{
  "userID": "apitest",
  "firstName": "A Test Account",
  "lastName": "This Is",
  "email": "test@example.com",
  "dateCreated": "2016-06-30",
  "companyName": "Test Example Pte Ltd",
  "credit": 0,
  "products": [
    {
      "code": "BPF",
      "name": "Business Profile",
      "price": {
        "pdf": 360,
        "xml": 360,
        "json": 360,
        "pdfx": 360
      }
    },
    {
      "code": "FSH",
      "name": "Financial Statement",
      "price": {
        "pdf": 2140
      }
    }
  ]
}

The definition of each key is explained in the table below

Update

To update your profile information, send a POST request to the below url:

https://api.bizinsights.net/profile/details?[token=]

e.g. https://api.bizinsights.net/profile/details?token=12345A

The body of the request should only contain the fields you wish to update. You would need to set the Content-Type header to application/json.

Example of the request body:

{
  "email": "test@example.com",
  "companyName": "Test Pte Ltd"
}

The above is a request to only update the email and the companyName of your profile. You are only able to modify the fields that are marked modifiable in the previous table.

You will receive a message to inform you if the request is successful

Exceptions

There are times when mistakes were made, like when parameters are passed incorrectly, or invalid links. Exceptions will be returned with the cause of the error.

The different exceptions are listed in the table below