Schema ReferenceΒΆ
The Social Investment Data Lab Specification is maintained using JSON Schema. The Schema is the authoritative source for the specification, and defines the structure of an individual deal so that it can be annotated and validated.
When publishing an individual deal or a number of deals, these deals should be packaged into a single, valid JSON file.
These field names for properties are important for ensuring that data is published in a machine-readable format. The title gives a human-readable form, with information about each of the properties included in description.
The full JSON schema is described below.
| Title | Description | Type | Format | Required |
|---|---|---|---|---|
Deal |
object | |||
| Deal | A social finance deal | |||
Deal/identifier |
string | Required | ||
| Identifier | Unique internal identifier for the social finance deal. | |||
Deal/title |
string | Required | ||
| Title | A title for the deal. Ideally, this is concise and under 140 characters. | |||
Deal/status |
string | |||
| Status | Current status of the blended finance deal: in progress, an open investment, closed without funds being drawn down, closed without core funds being approved. | |||
Deal/recipientOrganization |
object | Required | ||
| Recipient Organization | The Organization in receipt of the funds from the social finance deal. See Organization |
|||
Deal/recipientOrganization/id |
string | Required | ||
| Identifier | A globally unique identifier for this Organization. This is important to enable data on funders and recipients to be linked up across different grant-makers. The Organization Identifier Standard guidance explains how to create this ID, based either on the known company or charity number, or upon identifiers held in the grant-maker's internal systems. | |||
Deal/recipientOrganization/name |
string | Required | ||
| Name | Organization name | |||
Deal/recipientOrganization/department |
string | |||
| Department | The department or sub-unit of this Organization making or receiving the grant. | |||
Deal/recipientOrganization/contactName |
string | |||
| Contact Name | The contact person at this Organization. | |||
Deal/recipientOrganization/charityNumber |
string | |||
| Charity Number | Registered charity number, if applicable. | |||
Deal/recipientOrganization/companyNumber |
string | |||
| Company Number | Registered UK company number, if applicable. | |||
Deal/recipientOrganization/streetAddress |
string | |||
| Street Address | Building number and street name. | |||
Deal/recipientOrganization/addressLocality |
string | |||
| City | City or town. | |||
Deal/recipientOrganization/addressRegion |
string | |||
| County | County | |||
Deal/recipientOrganization/addressCountry |
string | |||
| Country | Country | |||
Deal/recipientOrganization/postalCode |
string | |||
| Postal Code | Postal code (please try and provide a post code whenever possible) | |||
Deal/recipientOrganization/telephone |
string | |||
| Phone Number | Contact phone number. | |||
Deal/recipientOrganization/alternateName |
string | |||
| Alternate Name | An alternative name for this Organization (e.g. trading name) | |||
Deal/recipientOrganization/email |
string | |||
| The email address for this Organization. | ||||
Deal/recipientOrganization/description |
string | |||
| Description | A short description of this Organization and its area of work | |||
Deal/recipientOrganization/OrganizationType |
[string, null] | |||
| Organization Type | A description of this Organization | |||
Deal/recipientOrganization/url |
string | uri | ||
| Web Address | A web address for the Organization | |||
Deal/recipientOrganization/location |
array[object] | |||
| Location | Locations associated with the organization See Location |
|||
Deal/recipientOrganization/location/0/id |
string | |||
| Identifier | Location identifier | |||
Deal/recipientOrganization/location/0/name |
[string, null] | |||
| Name | A name for this location. | |||
Deal/recipientOrganization/location/0/countryCode |
[string, null] | |||
| Country Code | The ISO Country Code of the location of this activity. | |||
Deal/recipientOrganization/location/0/latitude |
[string, null] | |||
| Latitude | The latitude of a point location | |||
Deal/recipientOrganization/location/0/longitude |
[string, null] | |||
| Longitude | The longitude of a point location | |||
Deal/recipientOrganization/location/0/description |
[string, null] | |||
| Description | A description of this location. This could include details of the element of the activity that takes place here. | |||
Deal/recipientOrganization/location/0/geoCode |
[string, null] | |||
| Geographic Code | A code referring to a geographical area, drawn from an established gazetteer. For example, the code for a local authority ward, or parliamentary constituency. | |||
Deal/recipientOrganization/location/0/geoCodeType |
[string, null] | |||
| Geographic Code Type | The type of Geographic Code (geoCode) used (e.g. Ward, Parliamentary Constituency etc.). This value for this field should be drawn from the codelist of geographic code types. | |||
Deal/recipientOrganization/location/0/dateModified |
string | date-time | ||
| Last modified | The date and time when information about this location was last updated. | |||
Deal/recipientOrganization/dateModified |
string | date-time | ||
| Last modified | The date and time when information about this Organization was last updated. | |||
Deal/arrangingOrganization |
object | Required | ||
| Arranging Organization | The Organization arranging the social finance deal. See Organization |
|||
Deal/arrangingOrganization/id |
string | Required | ||
| Identifier | A globally unique identifier for this Organization. This is important to enable data on funders and recipients to be linked up across different grant-makers. The Organization Identifier Standard guidance explains how to create this ID, based either on the known company or charity number, or upon identifiers held in the grant-maker's internal systems. | |||
Deal/arrangingOrganization/name |
string | Required | ||
| Name | Organization name | |||
Deal/arrangingOrganization/department |
string | |||
| Department | The department or sub-unit of this Organization making or receiving the grant. | |||
Deal/arrangingOrganization/contactName |
string | |||
| Contact Name | The contact person at this Organization. | |||
Deal/arrangingOrganization/charityNumber |
string | |||
| Charity Number | Registered charity number, if applicable. | |||
Deal/arrangingOrganization/companyNumber |
string | |||
| Company Number | Registered UK company number, if applicable. | |||
Deal/arrangingOrganization/streetAddress |
string | |||
| Street Address | Building number and street name. | |||
Deal/arrangingOrganization/addressLocality |
string | |||
| City | City or town. | |||
Deal/arrangingOrganization/addressRegion |
string | |||
| County | County | |||
Deal/arrangingOrganization/addressCountry |
string | |||
| Country | Country | |||
Deal/arrangingOrganization/postalCode |
string | |||
| Postal Code | Postal code (please try and provide a post code whenever possible) | |||
Deal/arrangingOrganization/telephone |
string | |||
| Phone Number | Contact phone number. | |||
Deal/arrangingOrganization/alternateName |
string | |||
| Alternate Name | An alternative name for this Organization (e.g. trading name) | |||
Deal/arrangingOrganization/email |
string | |||
| The email address for this Organization. | ||||
Deal/arrangingOrganization/description |
string | |||
| Description | A short description of this Organization and its area of work | |||
Deal/arrangingOrganization/OrganizationType |
[string, null] | |||
| Organization Type | A description of this Organization | |||
Deal/arrangingOrganization/url |
string | uri | ||
| Web Address | A web address for the Organization | |||
Deal/arrangingOrganization/location |
array[object] | |||
| Location | Locations associated with the organization See Location |
|||
Deal/arrangingOrganization/location/0/id |
string | |||
| Identifier | Location identifier | |||
Deal/arrangingOrganization/location/0/name |
[string, null] | |||
| Name | A name for this location. | |||
Deal/arrangingOrganization/location/0/countryCode |
[string, null] | |||
| Country Code | The ISO Country Code of the location of this activity. | |||
Deal/arrangingOrganization/location/0/latitude |
[string, null] | |||
| Latitude | The latitude of a point location | |||
Deal/arrangingOrganization/location/0/longitude |
[string, null] | |||
| Longitude | The longitude of a point location | |||
Deal/arrangingOrganization/location/0/description |
[string, null] | |||
| Description | A description of this location. This could include details of the element of the activity that takes place here. | |||
Deal/arrangingOrganization/location/0/geoCode |
[string, null] | |||
| Geographic Code | A code referring to a geographical area, drawn from an established gazetteer. For example, the code for a local authority ward, or parliamentary constituency. | |||
Deal/arrangingOrganization/location/0/geoCodeType |
[string, null] | |||
| Geographic Code Type | The type of Geographic Code (geoCode) used (e.g. Ward, Parliamentary Constituency etc.). This value for this field should be drawn from the codelist of geographic code types. | |||
Deal/arrangingOrganization/location/0/dateModified |
string | date-time | ||
| Last modified | The date and time when information about this location was last updated. | |||
Deal/arrangingOrganization/dateModified |
string | date-time | ||
| Last modified | The date and time when information about this Organization was last updated. | |||
Deal/dealDate |
[string, null] | date-time | ||
| Deal date | The date that the deal was awarded. Dates should be in yyyy-mm-dd format. | |||
Deal/investments |
object | |||
| Investments | ||||
Deal/investments/grants |
array[Grant] | |||
| Grants | Grants made as part of the social investment deal. See Grant |
|||
Deal/investments/grants/0/identifier |
string | |||
| Identifier | ||||
Deal/investments/grants/0/currency |
string | |||
| Currency | ||||
Deal/investments/grants/0/fundingProgramme |
object | |||
| Funding Programme | Funding programme that the grant forms a part of. See FundingProgramme |
|||
Deal/investments/grants/0/fundingProgramme/code |
string | |||
| Code | An identifier for this funding programme. | |||
Deal/investments/grants/0/fundingProgramme/title |
[string, null] | |||
| Title | The title of this funding programme. | |||
Deal/investments/grants/0/fundingProgramme/description |
[string, null] | |||
| Description | A description of this funding programme. | |||
Deal/investments/grants/0/fundingProgramme/url |
[string, null] | uri | ||
| URL | A web link to more details of this funding programme. | |||
Deal/investments/grants/0/fundingProgramme/dateModified |
string | date-time | ||
| Last modified | The date and time when information about this funding programme was last updated. | |||
Deal/investments/equity |
array[Equity] | |||
| Equity Investments | Equity components of the social investment deal. See Equity |
|||
Deal/investments/equity/0/identifier |
string | |||
| Identifier | ||||
Deal/investments/equity/0/currency |
string | |||
| Currency | ||||
Deal/investments/equity/0/fundingProgramme |
object | |||
| Funding Programme | Funding programme that the grant forms a part of. See FundingProgramme |
|||
Deal/investments/equity/0/fundingProgramme/code |
string | |||
| Code | An identifier for this funding programme. | |||
Deal/investments/equity/0/fundingProgramme/title |
[string, null] | |||
| Title | The title of this funding programme. | |||
Deal/investments/equity/0/fundingProgramme/description |
[string, null] | |||
| Description | A description of this funding programme. | |||
Deal/investments/equity/0/fundingProgramme/url |
[string, null] | uri | ||
| URL | A web link to more details of this funding programme. | |||
Deal/investments/equity/0/fundingProgramme/dateModified |
string | date-time | ||
| Last modified | The date and time when information about this funding programme was last updated. | |||
Deal/investments/credit |
array[Credit] | |||
| Credit Investments | Loan, bonds and leasing components of the social investment deal. See Credit |
|||
Deal/investments/credit/0/identifier |
string | |||
| Identifier | ||||
Deal/investments/credit/0/currency |
string | |||
| Currency | ||||
Deal/investments/credit/0/fundingProgramme |
object | |||
| Funding Programme | Funding programme that the grant forms a part of. See FundingProgramme |
|||
Deal/investments/credit/0/fundingProgramme/code |
string | |||
| Code | An identifier for this funding programme. | |||
Deal/investments/credit/0/fundingProgramme/title |
[string, null] | |||
| Title | The title of this funding programme. | |||
Deal/investments/credit/0/fundingProgramme/description |
[string, null] | |||
| Description | A description of this funding programme. | |||
Deal/investments/credit/0/fundingProgramme/url |
[string, null] | uri | ||
| URL | A web link to more details of this funding programme. | |||
Deal/investments/credit/0/fundingProgramme/dateModified |
string | date-time | ||
| Last modified | The date and time when information about this funding programme was last updated. | |||
Deal/projects |
array[Project] | |||
| Project | Projects associated with the deal. See Project |
|||
Deal/projects/0/identifier |
string | |||
| Identifier | ||||
Deal/projects/0/title |
string | |||
| Title | The title of this project | |||
Deal/projects/0/description |
string | |||
| Description | A description of this project | |||
Deal/projects/0/location |
array[object] | |||
| Location | Locations address with the project See Location |
|||
Deal/projects/0/location/0/id |
string | |||
| Identifier | Location identifier | |||
Deal/projects/0/location/0/name |
[string, null] | |||
| Name | A name for this location. | |||
Deal/projects/0/location/0/countryCode |
[string, null] | |||
| Country Code | The ISO Country Code of the location of this activity. | |||
Deal/projects/0/location/0/latitude |
[string, null] | |||
| Latitude | The latitude of a point location | |||
Deal/projects/0/location/0/longitude |
[string, null] | |||
| Longitude | The longitude of a point location | |||
Deal/projects/0/location/0/description |
[string, null] | |||
| Description | A description of this location. This could include details of the element of the activity that takes place here. | |||
Deal/projects/0/location/0/geoCode |
[string, null] | |||
| Geographic Code | A code referring to a geographical area, drawn from an established gazetteer. For example, the code for a local authority ward, or parliamentary constituency. | |||
Deal/projects/0/location/0/geoCodeType |
[string, null] | |||
| Geographic Code Type | The type of Geographic Code (geoCode) used (e.g. Ward, Parliamentary Constituency etc.). This value for this field should be drawn from the codelist of geographic code types. | |||
Deal/projects/0/location/0/dateModified |
string | date-time | ||
| Last modified | The date and time when information about this location was last updated. | |||
Deal/projects/0/funding |
object | |||
| Funding | The funding from the deal associated with this project. | |||
Deal/projects/0/funding/currency |
string | |||
| Currency | Currency of the deal. | |||
Deal/projects/0/funding/funding |
number | |||
| Funding | Total funding from the deal for this project as a number. | |||
Deal/dateModified |
[string, null] | date-time | ||
| Last modified | The date and time about when any part of the information for this deal was last updated. Should be in yyyy-mm-ddThh:mm:ssZ format. | |||
Deal/dataSource |
[string, null] | uri | ||
| Data Source | A web link pointing to the source of this data, such as the actual data file or the publisher's website. | |||