{"info":{"_postman_id":"59721796-b7b9-47f7-9891-aa08e222820e","name":"ESGPedia Developer Guide v1.2.7","description":"

1. Introduction

STACS ESGpedia is a platform that stores holistic and forward-looking ESG Data from various verified sources. ESGpedia aims to consolidate Certification and ESG Data across various sectors & industries from verified sources into a single data registry to promote, enhance and aid in monitoring the mobilisation of ESG Capital.\nThis is in partnership with the Monetary Authority of\nSingapore's (MAS) Project Greenprint.

1.1. RESTful HTTP APIs

This set of RESTful HTTP APIs focuses on:

Ingestion of Certification from the certification bodies, agencies and registries.
Ingestion of Project Data which are real-time and aggregated raw from technology partners.
Ingestion of Self Disclosure information from 3rd Party sources.
Member Information that are associated to the Corporates.
Query of ESG Data by Data Consumers.

1.2. Data Provider - Features

Management of certified companies and their certified assets.
\n
- A global list of corporates which allow data consumers to review dataset pertaining to a corporate. These datasets may include a corporate’s ESG Certificates, ongoing project information or even self disclosure information.
\n
Digitalisation and Management of certificate standards.
\n
- An extensive repository of certificates across all ESG Standards. This module ingests certifications from a range of certification bodies, agencies and registries (eg Verra, Gold Standard registry etc), providing users with a cross-sectorial and cross-geographical view of certificates that have been obtained by different corporates. With the dataset received, information is harmonised in a structured manner for reporting.
\n
Real-time and aggregated raw ESG data ingestion and tagging to companies and assets
\n
- A project registry that stores and manages ongoing, independent ESG data across various green projects undertaken by the corporates. It allows trusted technology partners to channel a project’s dataset to ESGpedia, allowing data consumers (buyers, verifiers or regulators) to tap on this repository to obtain ongoing, independent data about a certain project.
\n
Self Disclosure information of corporates.
\n
- Disclosure information that are ingested by a trusted 3rd Party Institution for ESG Data Validation.
\n

1.3. Data Consumers - Features

Query of companies
\n
- Get all companies.
- Get assets, projects, self disclosures that are associated to a corporate.
\n
Query of certificates
\n
- Get all certificates, filter by various parameters.
- Get details of a certificate.
\n

2. Onboarding and Setup

You will need to send an onboarding request to a STACS representative via\nemail, bd@stacs.io.

Once onboarded, you will receive the following:

your unique API endpoint along with an API key

ESGpedia is using OAuth2.0 Authorization Code Grant for authentication and\nauthorization for all API requests.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14813587","collectionId":"59721796-b7b9-47f7-9891-aa08e222820e","publishedId":"VUxNR7rQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-08-31T04:00:47.000Z"},"item":[{"name":"Data Provider","item":[{"name":"Certification","item":[{"name":"Ingest Certification file","id":"8ca211ac-5372-4181-9ec5-c4c8408d61d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

(Required) API key is required for all API requests

\n","key":"x-api-key","value":""},{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://api-studios.esgpedia.io/certificates/file-ingest","description":"

Ingest Certification file into ESGPedia.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"59721796-b7b9-47f7-9891-aa08e222820e","id":"59721796-b7b9-47f7-9891-aa08e222820e","name":"ESGPedia Developer Guide v1.2.7","type":"collection"}},"urlObject":{"path":["certificates","file-ingest"],"host":["https://api-studios.esgpedia.io"],"query":[],"variable":[]}},"response":[{"id":"b0cac80c-1148-44cd-a9e4-8544b95bdad9","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file"}]},"url":"https://api-studios.esgpedia.io/certificates/file-ingest"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"filename\": \"\",\n\t\"batchId\": \"\",\n\t\"receiptStatus\": \"\"\n}"},{"id":"ef693f4e-8ff6-4bd4-9c51-b04412123240","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file"}]},"url":"https://api-studios.esgpedia.io/certificates/file-ingest"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"ea19a9d0-1ca0-4051-9bb6-3f2bcff7a7f3","name":"Unauthorised","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file"}]},"url":"https://api-studios.esgpedia.io/certificates/file-ingest"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"659538d7-84b9-4769-abbc-2ed5aeffc3b1","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file"}]},"url":"https://api-studios.esgpedia.io/certificates/file-ingest"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"d8e0f9e5-43fd-49cc-8d36-8028abe90421","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file"}]},"url":"https://api-studios.esgpedia.io/certificates/file-ingest"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8ca211ac-5372-4181-9ec5-c4c8408d61d7"},{"name":"Ingest Certification data","id":"949caa0a-ea84-440f-93cf-4d34675e410a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

(Required) API key is required for all API requests

\n","key":"x-api-key","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"companyName\": \"\",\n\t\"countryOfIncorporation\": \"\",\n\t\"companySector\": \"\",\n\t\"certificationStandard\": \"\",\n\t\"certificateIssuer\": \"\",\n\t\"certificationID\": \"\",\n\t\"issuingDate\": \"\",\n\t\"expiringDate\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-studios.esgpedia.io/certificates/data-ingest","description":"

Input the certification information in a well-formed json format. No constraints on paramaters.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"59721796-b7b9-47f7-9891-aa08e222820e","id":"59721796-b7b9-47f7-9891-aa08e222820e","name":"ESGPedia Developer Guide v1.2.7","type":"collection"}},"urlObject":{"path":["certificates","data-ingest"],"host":["https://api-studios.esgpedia.io"],"query":[],"variable":[]}},"response":[{"id":"6ecd6b23-0eb7-4b78-a69a-e0c296caa277","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n\t\"companyName\": \"\",\n\t\"countryOfIncorporation\": \"\",\n\t\"companySector\": \"\",\n\t\"certificationStandard\": \"\",\n\t\"certificateIssuer\": \"\",\n\t\"certificationID\": \"\",\n\t\"issuingDate\": \"\",\n\t\"expiringDate\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-studios.esgpedia.io/certificates/data-ingest"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n\t\"batchId\": \"\",\n\t\"receiptStatus\": \"\"\n}"},{"id":"af8f848f-f220-437e-be1e-69cea8bb148e","name":"Bad Request","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n\t\"companyName\": \"\",\n\t\"countryOfIncorporation\": \"\",\n\t\"companySector\": \"\",\n\t\"certificationStandard\": \"\",\n\t\"certificateIssuer\": \"\",\n\t\"certificationID\": \"\",\n\t\"issuingDate\": \"\",\n\t\"expiringDate\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-studios.esgpedia.io/certificates/data-ingest"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"0ae05f0a-69d8-442d-a171-0a375b2643d1","name":"Unauthorised","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n\t\"companyName\": \"\",\n\t\"countryOfIncorporation\": \"\",\n\t\"companySector\": \"\",\n\t\"certificationStandard\": \"\",\n\t\"certificateIssuer\": \"\",\n\t\"certificationID\": \"\",\n\t\"issuingDate\": \"\",\n\t\"expiringDate\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-studios.esgpedia.io/certificates/data-ingest"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"9f51ef4d-e818-440a-93c1-a0bc43e2932c","name":"Forbidden","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n\t\"companyName\": \"\",\n\t\"countryOfIncorporation\": \"\",\n\t\"companySector\": \"\",\n\t\"certificationStandard\": \"\",\n\t\"certificateIssuer\": \"\",\n\t\"certificationID\": \"\",\n\t\"issuingDate\": \"\",\n\t\"expiringDate\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-studios.esgpedia.io/certificates/data-ingest"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"a4b806c8-2bb2-4787-9429-eafd1bb41314","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n\t\"companyName\": \"\",\n\t\"countryOfIncorporation\": \"\",\n\t\"companySector\": \"\",\n\t\"certificationStandard\": \"\",\n\t\"certificateIssuer\": \"\",\n\t\"certificationID\": \"\",\n\t\"issuingDate\": \"\",\n\t\"expiringDate\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-studios.esgpedia.io/certificates/data-ingest"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"949caa0a-ea84-440f-93cf-4d34675e410a"},{"name":"List all Certification batchId","id":"c8d0a928-ec99-4a01-a1bf-c67c1a776802","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) API key is required for all API requests

\n","key":"x-api-key","value":""},{"key":"Accept","value":"application/json"}],"url":"https://api-studios.esgpedia.io/certificates/batches","description":"

Returns all certification batch Id from ESGPedia.

\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":true,"source":{"_postman_id":"59721796-b7b9-47f7-9891-aa08e222820e","id":"59721796-b7b9-47f7-9891-aa08e222820e","name":"ESGPedia Developer Guide v1.2.7","type":"collection"}},"urlObject":{"path":["certificates","batches"],"host":["https://api-studios.esgpedia.io"],"query":[],"variable":[]}},"response":[{"id":"f9613bf1-b03b-4cf6-9efd-8131cbdb523b","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"url":"https://api-studios.esgpedia.io/certificates/batches"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n\t{\n\t\t\"batchId\": \"\",\n\t\t\"uploadDate\": \"\"\n\t},\n\t{\n\t\t\"batchId\": \"\",\n\t\t\"uploadDate\": \"\"\n\t}\n]"},{"id":"f2be7a70-0cec-476b-9ac5-2d1e5e6c7766","name":"Bad Request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"url":"https://api-studios.esgpedia.io/certificates/batches"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"d3ff0fa1-46de-4c51-b436-5399ca79aaae","name":"Unauthorised","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"url":"https://api-studios.esgpedia.io/certificates/batches"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"9cc7ca43-1cf0-4dd5-881a-92cac4ddeb17","name":"Forbidden","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"url":"https://api-studios.esgpedia.io/certificates/batches"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"91bc421a-c106-4e62-bc33-8581a9bd0f59","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"url":"https://api-studios.esgpedia.io/certificates/batches"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c8d0a928-ec99-4a01-a1bf-c67c1a776802"},{"name":"Download Certification file based on batchId","id":"cb6aec9e-7fa8-4a57-a123-f03798cd8a6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) API key is required for all API requests

\n","key":"x-api-key","value":""},{"key":"Accept","value":"application/octet-stream"}],"url":"https://api-studios.esgpedia.io/certificates/:batchId/download","description":"

Data sent via /fileingest or /dataingest will be returned in a file format.

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"batchId"}]}},"response":[{"id":"f560d65e-14ed-4035-abdb-1e9603766723","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""},{"description":"(Required) API key is required for all API requests","key":"x-api-key","value":""}],"url":{"raw":"https://api-studios.esgpedia.io/certificates/:batchId/download","host":["https://api-studios.esgpedia.io"],"path":["certificates",":batchId","download"],"variable":[{"key":"batchId","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/octet-stream"}],"cookie":[],"responseTime":null,"body":"