API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Algorep logo

Topics

  • Introduction
  • Authentication

Endpoints

  • Countries
    • Fetch Activated Countries GET
  • Declaration Periods
    • Fetch List Of Declaration Period GET
  • EcoProducts
    • Fetch Eco Product Details With Matching Eco Contributions GET
  • Onboardings
    • Setup Onboarding For Given Producer (Fetch Registrations & Save Them) POST
  • Origins
    • Fetch List Of Origins GET
    • Upsert Origin POST
  • Producer Credits
    • Fetch Producer Credits Amount GET
    • Add Credits To Producer Balance POST
  • Producer Declarations
    • Fetch Declarations Quantities Given Producer GET
    • Add Or Update Entries To Producer Declarations Quantities POST
    • Fetch Declaration Summary Given Producer GET
    • Add Multiple Quantities To Producer Catalogue POST
    • Update A Declaration Scheme POST
    • Update A Declaration PUT
  • Producer EcoProducts
    • Clone Eco Products Catalog From One Producer To Another POST
    • Fetch Eco Product Details For Given Producer GET
    • Add Multiple EcoProducts To Producer Catalogue POST
    • Add EcoProduct To Producer Catalogue POST
    • Fetch CSV Catalog GET
  • Producer Legal Information
    • Fetch Producer Legal Information GET
  • Producer Schemes
    • Fetch Registrations/Schemes For Given Producer GET
    • Fetch List Of Purchasable UINs For This Producer And Country/Period GET
  • Producer Summary
    • Fetch Summary For Given Producer GET
  • Producers
    • Fetch List Of Producers GET
    • Fetch Producer By NRN GET
    • Upsert Producer POST
  • Producers Registrations
    • Fetch registrations for a specific producer GET
    • Upsert Producer Registrations POST
  • Scheme Pro Declaration Period
    • Fetch Rules Of A Specific Declaration Period For A Specific Scheme Pro GET
  • Scheme Pros
    • Fetch List Of Scheme Pros GET
  • Sellers
    • Fetch List Of Sellers GET
    • Upsert Seller POST
  • Users
    • Upsert User POST
Powered by Bump.sh
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Algorep logo

Fetch Producer Legal Information

GET /producers/{ProducerNrn}/legal
App api authorizer

Path parameters

  • ProducerNrn string Required

    Producer Unique NRN

Query parameters

  • EprCountryCode string Required

    FR, ES, etc.

Responses

  • 200 application/json

    Response with legal information

    Hide response attributes Show response attributes object
    • _meta

      Default value is null.

    • data object

      Additional properties are allowed.

      Hide data attributes Show data attributes object
      • companyName string
      • vatNumber string
      • addressCountry string
      • addressLocality string
      • addressStreet string
      • addressPostalCode string
      • legalRepresentativeFirstName string
      • legalRepresentativeLastName string
      • sector string
      • primaryNrn string
      • secondaryNrn string
      • creationDate string
      • sectorCode string
  • 404 application/json

    An error happenned during the request, refer to error code for more information

    Hide response attribute Show response attribute object
    • error string

      One of:
      string-1 string string-2 string string-3 string string-4 string string-5 string string-6 string string-7 string string-8 string string-9 string string-10 string string-11 string string-12 string string-13 string string-14 string string-15 string string-16 string string-17 string string-18 string string-19 string string-20 string string-21 string string-22 string string-23 string string-24 string string-25 string string-26 string string-27 string string-28 string

      The server encountered an unknown error!

      Default value is ALGOREP_001.

      Eco product could not be found

      Default value is ALGOREP_002.

      Dgraph Failed To Process The Request

      Default value is ALGOREP_003.

      Producer could not be found

      Default value is ALGOREP_004.

      Bad Request

      Default value is ALGOREP_005.

      Declaration already validated for this product

      Default value is ALGOREP_006.

      Producer Batch Process Failed: Invalid ContentType, Request Should Be Multipart/FormData.

      Default value is ALGOREP_007.

      No file found on request

      Default value is ALGOREP_008.

      Too many files found on request

      Default value is ALGOREP_009.

      Qualification Pipeline Failed: ExternalId Not Found

      Default value is ALGOREP_010.

      Qualification Pipeline Failed: ExternalIdType Not Found / Could Not Be Determined

      Default value is ALGOREP_011.

      Qualification Pipeline Failed: ProducerNrn Not Found

      Default value is ALGOREP_012.

      Qualification Pipeline Failed: Product 'Title' Or 'Image' Could Not Be Determined, But Necessary To Compute Contributions.

      Default value is ALGOREP_013.

      Qualification Pipeline Failed: EcoFeez Could Not Determine Contributions.

      Default value is ALGOREP_014.

      Qualification Pipeline Failed: EcoFeez Could Not Determine Some Necessary Field.

      Default value is ALGOREP_015.

      Producer Batch Pre Process Pipeline Failed: Could Not Find CSV File On S3.

      Default value is ALGOREP_016.

      Producer Batch Pre Process Pipeline Failed: CSV File Contains Errors

      Default value is ALGOREP_017.

      Producer Batch Pre Process Pipeline Failed: Did Not Find Any Product To Process In CSV File

      Default value is ALGOREP_018.

      Producer Batch Pre Process Pipeline Failed: Not Enough Credit Balance To Process All Products

      Default value is ALGOREP_019.

      Producer Batch Pre Process Pipeline Failed: ProducerId Not Found

      Default value is ALGOREP_020.

      Producer Batch Pre Process Pipeline Failed: Unable To Insert Pipeline Information Into Database

      Default value is ALGOREP_021.

      Producer Batch Pre Process Pipeline Failed: Another Running Pipeline Already Exists For This Producer

      Default value is ALGOREP_022.

      Producer Batch Process Pipeline Failed: ProducerId Not Found

      Default value is ALGOREP_023.

      Producer Batch Process Pipeline Failed: ProductId Not Found

      Default value is ALGOREP_024.

      Producer Batch Process Pipeline Failed: EprCountryCode Not Found Or Empty

      Default value is ALGOREP_025.

      Producer Batch Process Pipeline Failed: DeclarationPeriodCode Not Found

      Default value is ALGOREP_026.

      Producer Batch Process Pipeline Failed: Too Many Records Consumed At Once

      Default value is ALGOREP_027.

      No Company Found With This NRN

      Default value is ALGOREP_028.

GET /producers/{ProducerNrn}/legal
curl \
 --request GET 'https://b6l4r8pq7c.execute-api.eu-west-3.amazonaws.com/producers/34368801600504/legal?EprCountryCode=FR' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "_meta": "null",
  "data": {
    "companyName": "string",
    "vatNumber": "string",
    "addressCountry": "string",
    "addressLocality": "string",
    "addressStreet": "string",
    "addressPostalCode": "string",
    "legalRepresentativeFirstName": "string",
    "legalRepresentativeLastName": "string",
    "sector": "string",
    "primaryNrn": "string",
    "secondaryNrn": "string",
    "creationDate": "string",
    "sectorCode": "string"
  }
}
Response examples (404)
{
  "error": "ALGOREP_001"
}