Introduction

Welcome to our API documentation! Currently, we offer a REST API that allows you to interact programmatically with our services. Our API is designed to be simple and intuitive, making it easy for developers to integrate our features into their applications.

Authentication

To ensure secure access, all API requests must be authenticated using an API token. Please include your API token in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY
            

To get your API key, please contact us at info@susapi.com

Feedback and Feature Requests

We are committed to providing a robust and versatile API. If you have any specific needs or requests for new endpoints or additional features to the existing API, please don't hesitate to contact us. We welcome your feedback and are eager to work with you to enhance our API to better serve your needs.

Certificates

Get Certificates

Retrieve certificate information by given search filters

GET /api/certificates?search=_search_query_,limit=10,country_code=US
          

Example Request Query Params

{
  "search": "Procter & Gamble",
  "country_code": "US",
  "limit": 10
}

[optional] search: - Search by company name

[optional] country_code: - Filter by country code (max length 2 symbols). Some certificates dont have country code and have `00` value

[optional] limit: - Limit the number of results. Default is 10. Max limit is 100. For more, please contact us to increase the limit

Example Response

[
  {
    "id": "e8fe1f17-fe97-4843-9695-9da0ce9af070",
    "name": "Procter & Gamble",
    "country_code": "US",
    "sector": "Consumer Goods",
    "issued_at": "2021-10-01",
    "status": "certified",
    "country": "United States",
    "organization": "RTRS"
  }
]

[required] id: - ID of the record. Don't store this ID as it can change

[required] name: - Name of the company

[required] country_code: - Country code of the company. Some certificates dont have country code and have `00` value

[optional] sector: - Sector of the company

[optional] issued_at: - Date when the certificate was issued

[required] status: - Status of the certificate

[optional] country: - Country of the company in human-readable format

[required] organization: - Organization that issued the certificate