Benefacts Public API

API change history

The Benefacts Public API allows you to search for organisations in the Benefacts database by searching for words and terms (as on the website), or by retrieving lists of organisations that are registered with certain regulators, or that adhere to certain voluntary codes.

organisation

Retrieves information on an organisation by specifying its id (as a GUID)

Try it

Request

Request URL

Request parameters

  • string

    The GUID identifier of the organisation

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Returns a JSON document with detailed information about the organisation.

Representations

{
  "id": "7a8e3f8d-2036-42fd-86b1-348c688f2f95",
  "name": "I.W.A. LIMITED",
  "altNames": [
    "IRISH WHEELCHAIR ASSOCIATION"
  ],
  "sectorName": "Education, Research",
  "sectorCode": "3",
  "subSectorName": "Adult and continuing education",
  "subSectorCode": "3.8",
  "secondarySubsectorName": "",
  "secondarySubsectorCode": "",
  "regulators": [
    {
      "regulatorName": "Revenue (Charities Unit)",
      "regulatorDesc": "CHY",
      "regulatorNumber": "5393",
      "regulatorUrl": "http://www.revenue.ie/"
    },
    {
      "regulatorName": "Companies Registration Office",
      "regulatorDesc": "CRO",
      "regulatorNumber": "352483",
      "regulatorUrl": "https://www.cro.ie/"
    },
    {
      "regulatorName": "Housing Agency",
      "regulatorDesc": "AHB",
      "regulatorNumber": "n/a",
      "regulatorUrl": "http://housing.ie/"
    },
    {
      "regulatorName": "Charities Regulatory Authority",
      "regulatorDesc": "CRA",
      "regulatorNumber": "20007997",
      "regulatorUrl": "https://www.charitiesregulatoryauthority.ie/"
    }
  ],
  "registeredAddress": "ARAS CHUCHULAIN, BLACKHEATH DRIVE, CLONTARF, DUBLIN 3, D03AW62",
  "county": "DUBLIN",
  "geolocation": {
    "type": "Point",
    "coordinates": [
      53.368114471435547,
      -6.20025110244751
    ]
  },
  "financialSummary": {
    "currentYear": 2014,
    "currentIncome": 52338327,
    "currentNetAssets": 22870682,
    "currentGrants": 45400342,
    "currentExpenditure": -52817292,
    "prevIncome": 50802381,
    "prevNetAssets": 23573522,
    "prevGrants": 44610717,
    "prevExpenditure": -50714760,
    "accountToDate": "2014-12-31T00:00:00"
  },
  "funders": [
    {
      "fundSource": "Department Of Social Protection",
      "amount": 6010224,
      "fundingType": "gov"
    },
    {
      "fundSource": "Health Services Executive (HSE)",
      "amount": 39390118,
      "fundingType": "gov"
    }
  ],
  "otherAddresses": [
    {
      "address": "ARAS CHUCHULAINN, BLACKHEATH DRIVE, CLONTARF, DUBLIN 3, D03AW62",
      "cleanAddress": "aras chuchulainn blackheath drive clontarf dublin 3 d03aw62",
      "county": "DUBLIN",
      "eircode": "D03AW62",
      "geolocation": {
        "type": "Point",
        "coordinates": [
          53.368114471435547,
          -6.20025110244751
        ]
      }
    },
    {
      "address": "Áras Chúchulainn Blackheath Drive Clontarf Dublin 3 Dublin",
      "cleanAddress": "aras chuchulainn blackheath drive clontarf dublin 3 dublin",
      "county": "DUBLIN",
      "eircode": "",
      "geolocation": {
        "type": "Point",
        "coordinates": [
          0,
          0
        ]
      }
    }
  ],
  "sources": [
    {
      "source": "Revenue (Charities Unit)",
      "url": "http://www.revenue.ie/en/business/charities.html",
      "license": "PSI General License",
      "date": "2015-10-14T18:08:19"
    },
    {
      "source": "Companies Registration Office",
      "url": "https://www.cro.ie/",
      "license": "CRO Open Services License",
      "date": "2016-04-12T11:29:15"
    },
    {
      "source": "Housing Agency",
      "url": "http://housing.ie/",
      "date": "2015-12-09T15:54:55.847"
    },
    {
      "source": "Charities Regulatory Authority",
      "url": "https://www.charitiesregulatoryauthority.ie/",
      "date": "2016-03-16T13:46:44.793"
    }
  ],
  "orgUrl": "http://www.iwa.ie",
  "incorporatedDate": "2002-01-25T00:00:00",
  "governingForm": "Company Limited by Guarantee",
  "numEmployees": 2168,
  "legalObjectsExtract": "To optimise the intellectual, social and economic independence of persons with reduced mobility and to minimise the effects of mobility impairment. 3. The following are the powers of the company: (a) To provide counselling, rehabilitation, training assessment and other compensatory supports to person with reduced mobility and their dependants (b) To promote work and programmes directed towards the independence of people with mobility impairments including the running of resource centres,",
  "directors": [
    {
      "name": "Director_1",
      "dateAppointed": "2011-05-21T00:00:00"
    },
    {
      "name": "Director_2",
      "dateAppointed": "2004-05-15T00:00:00"
    },
    {
      "name": "Director_3",
      "dateAppointed": "2002-02-22T00:00:00"
    },
    {
      "name": "Director_4",
      "dateAppointed": "2003-05-17T00:00:00"
    },
    {
      "name": "Director_5",
      "dateAppointed": "2014-05-17T00:00:00"
    },
    {
      "name": "Director_6",
      "dateAppointed": "2013-05-18T00:00:00"
    },
    {
      "name": "Director_7",
      "dateAppointed": "2002-02-22T00:00:00"
    },
    {
      "name": "Director_8",
      "dateAppointed": "2012-05-19T00:00:00"
    },
    {
      "name": "Director_9",
      "dateAppointed": "2002-02-22T00:00:00"
    },
    {
      "name": "Director_10",
      "dateAppointed": "2004-11-25T00:00:00"
    },
    {
      "name": "Director_11",
      "dateAppointed": "2002-02-22T00:00:00"
    },
    {
      "name": "Director_12",
      "dateAppointed": "2015-05-16T00:00:00"
    },
    {
      "name": "Director_13",
      "dateAppointed": "2010-05-21T00:00:00"
    },
    {
      "name": "Director_14",
      "dateAppointed": "2003-05-17T00:00:00"
    },
    {
      "name": "Director_15",
      "dateAppointed": "2002-02-22T00:00:00"
    },
    {
      "name": "Director_16",
      "dateAppointed": "2011-09-14T00:00:00"
    }
  ],
  "legalObjectsDate": "2013-05-18T00:00:00",
  "regulatory": [
    "Registered Charity (CRA)",
    "Tax Relief (CHY)",
    "Approved Housing Body",
    "Tax Efficient Gifts"
  ],
  "governanceCodes": [
    {
      "governanceCodeDesc": "Statement of Guiding Principles for Fundraising",
      "governanceCodeUrl": "http://www.ictr.ie/content/fundraising-codes-practice"
    },
    {
      "governanceCodeDesc": "The Governance Code",
      "governanceCodeUrl": "http://www.governancecode.ie/"
    },
    {
      "governanceCodeDesc": "Charities SORP",
      "governanceCodeUrl": "http://charitysorp.org/"
    }
  ]
}
{
  "type": "object",
  "properties": {}
}
{
   "id": "7a8e3f8d-2036-42fd-86b1-348c688f2f95",
   "name": "I.W.A. LIMITED",
   "altNames": [
      "IRISH WHEELCHAIR ASSOCIATION"
   ],
   "sectorName": "Education, Research",
   "sectorCode": "3",
   "subSectorName": "Adult and continuing education",
   "subSectorCode": "3.8",
   "secondarySubsectorName": "",
   "secondarySubsectorCode": "",
   "regulators": [
      {
         "regulatorName": "Revenue (Charities Unit)",
         "regulatorDesc": "CHY",
         "regulatorNumber": "5393",
         "regulatorUrl": "http://www.revenue.ie/"
      },
      {
         "regulatorName": "Companies Registration Office",
         "regulatorDesc": "CRO",
         "regulatorNumber": "352483",
         "regulatorUrl": "https://www.cro.ie/"
      },
      {
         "regulatorName": "Housing Agency",
         "regulatorDesc": "AHB",
         "regulatorNumber": "n/a",
         "regulatorUrl": "http://housing.ie/"
      },
      {
         "regulatorName": "Charities Regulatory Authority",
         "regulatorDesc": "CRA",
         "regulatorNumber": "20007997",
         "regulatorUrl": "https://www.charitiesregulatoryauthority.ie/"
      }
   ],
   "registeredAddress": "ARAS CHUCHULAIN, BLACKHEATH DRIVE, CLONTARF, DUBLIN 3, D03AW62",
   "county": "DUBLIN",
   "geolocation": {
      "type": "Point",
      "coordinates": [
         53.368114,
         -6.200251
      ]
   },
   "financialSummary": {
      "currentYear": 2014,
      "currentIncome": 52338327,
      "currentNetAssets": 22870682,
      "currentGrants": 45400342,
      "currentExpenditure": -52817292,
      "prevIncome": 50802381,
      "prevNetAssets": 23573522,
      "prevGrants": 44610717,
      "prevExpenditure": -50714760,
      "accountToDate": "2014-12-31T00:00:00"
   },
   "funders": [
      {
         "fundSource": "Department Of Social Protection",
         "amount": 6010224,
         "fundingType": "gov"
      },
      {
         "fundSource": "Health Services Executive (HSE)",
         "amount": 39390118,
         "fundingType": "gov"
      }
   ],
   "otherAddresses": [
      {
         "address": "ARAS CHUCHULAINN, BLACKHEATH DRIVE, CLONTARF, DUBLIN 3, D03AW62",
         "cleanAddress": "aras chuchulainn blackheath drive clontarf dublin 3 d03aw62",
         "county": "DUBLIN",
         "eircode": "D03AW62",
         "geolocation": {
            "type": "Point",
            "coordinates": [
               53.368114,
               -6.200251
            ]
         }
      },
      {
         "address": "Áras Chúchulainn Blackheath Drive Clontarf Dublin 3 Dublin",
         "cleanAddress": "aras chuchulainn blackheath drive clontarf dublin 3 dublin",
         "county": "DUBLIN",
         "eircode": "",
         "geolocation": {
            "type": "Point",
            "coordinates": [
               0,
               0
            ]
         }
      }
   ],
   "sources": [
      {
         "source": "Revenue (Charities Unit)",
         "url": "http://www.revenue.ie/en/business/charities.html",
         "license": "PSI General License",
         "date": "2015-10-14T18:08:19"
      },
      {
         "source": "Companies Registration Office",
         "url": "https://www.cro.ie/",
         "license": "CRO Open Services License",
         "date": "2016-04-12T11:29:15"
      },
      {
         "source": "Housing Agency",
         "url": "http://housing.ie/",
         "date": "2015-12-09T15:54:55.847"
      },
      {
         "source": "Charities Regulatory Authority",
         "url": "https://www.charitiesregulatoryauthority.ie/",
         "date": "2016-03-16T13:46:44.793"
      }
   ],
   "orgUrl": "http://www.iwa.ie",
   "incorporatedDate": "2002-01-25T00:00:00",
   "governingForm": "Company Limited by Guarantee",
   "numEmployees": 2168,
   "legalObjectsExtract": "To optimise the intellectual, social and economic independence of persons with reduced mobility and to minimise the effects of mobility impairment. 3. The following are the powers of the company: (a) To provide counselling, rehabilitation, training assessment and other compensatory supports to person with reduced mobility and their dependants (b) To promote work and programmes directed towards the independence of people with mobility impairments including the running of resource centres,",
   "directors": [
      {
         "name": "Director_1",
         "dateAppointed": "2011-05-21T00:00:00"
      },
      {
         "name": "Director_2",
         "dateAppointed": "2004-05-15T00:00:00"
      },
      {
         "name": "Director_3",
         "dateAppointed": "2002-02-22T00:00:00"
      },
      {
         "name": "Director_4",
         "dateAppointed": "2003-05-17T00:00:00"
      },
      {
         "name": "Director_5",
         "dateAppointed": "2014-05-17T00:00:00"
      },
      {
         "name": "Director_6",
         "dateAppointed": "2013-05-18T00:00:00"
      },
      {
         "name": "Director_7",
         "dateAppointed": "2002-02-22T00:00:00"
      },
      {
         "name": "Director_8",
         "dateAppointed": "2012-05-19T00:00:00"
      },
      {
         "name": "Director_9",
         "dateAppointed": "2002-02-22T00:00:00"
      },
      {
         "name": "Director_10",
         "dateAppointed": "2004-11-25T00:00:00"
      },
      {
         "name": "Director_11",
         "dateAppointed": "2002-02-22T00:00:00"
      },
      {
         "name": "Director_12",
         "dateAppointed": "2015-05-16T00:00:00"
      },
      {
         "name": "Director_13",
         "dateAppointed": "2010-05-21T00:00:00"
      },
      {
         "name": "Director_14",
         "dateAppointed": "2003-05-17T00:00:00"
      },
      {
         "name": "Director_15",
         "dateAppointed": "2002-02-22T00:00:00"
      },
      {
         "name": "Director_16",
         "dateAppointed": "2011-09-14T00:00:00"
      }
   ],
   "legalObjectsDate": "2013-05-18T00:00:00",
   "regulatory": [
      "Registered Charity (CRA)",
      "Tax Relief (CHY)",
      "Approved Housing Body",
      "Tax Efficient Gifts"
   ],
   "governanceCodes": [
      {
         "governanceCodeDesc": "Statement of Guiding Principles for Fundraising",
         "governanceCodeUrl": "http://www.ictr.ie/content/fundraising-codes-practice"
      },
      {
         "governanceCodeDesc": "The Governance Code",
         "governanceCodeUrl": "http://www.governancecode.ie/"
      },
      {
         "governanceCodeDesc": "Charities SORP",
         "governanceCodeUrl": "http://charitysorp.org/"
      }
   ]
}
{
  "type": "object",
  "properties": {}
}
<Object />
{
  "type": "object",
  "properties": {}
}
<Object />
{
  "type": "object",
  "properties": {}
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.benefacts.ie/public/v1/Organisation/{id}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api.benefacts.ie/public/v1/Organisation/{id}?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.benefacts.ie/public/v1/Organisation/{id}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.benefacts.ie/public/v1/Organisation/{id}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.benefacts.ie/public/v1/Organisation/{id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.benefacts.ie/public/v1/Organisation/{id}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.benefacts.ie')
    conn.request("GET", "/public/v1/Organisation/{id}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.benefacts.ie')
    conn.request("GET", "/public/v1/Organisation/{id}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.benefacts.ie/public/v1/Organisation/{id}')

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body