Countries

Request a country

Asks for baseray in a country it does not cover yet, for a person who agrees to be emailed when it does. One request per address and country: asking again changes nothing and answers the same, so the answer never tells whether an address had asked before. A country baseray already covers answers live and stores nothing. The address is never shown or shared; product analytics count the country only.

post/public/country-requests

Request

  • Base URL: https://api.baseray.ai/v1
  • URL: https://api.baseray.ai/v1/public/country-requests
  • Auth: none required

Request body

countrystring required

The country asked for: an ISO 3166-1 alpha-2 code, such as DE.

emailstring email required

Where to write when baseray covers the country. Compared in lower case: the same address asks for a country once.

consenttrue required

Must be true: the person agrees to be emailed about this country. Kept for 24 months at most and deleted on request (privacy@baseray.ai).

companystring nullable

The person's company, up to 200 characters.

use_case'solar_prospecting' | 'heating_upgrades' | 'energy_efficiency' | 'insurance_underwriting' | 'real_estate_prospecting' | 'market_research' | 'other' | 'null' nullable

What they want the buildings for.

localestring nullable

The language to write back in, as a two-letter code (en, ro, cs).

Example request

{
  "country": "DE",
  "email": "ana@example.com",
  "consent": true,
  "company": "Example GmbH",
  "use_case": "insurance_underwriting",
  "locale": "en"
}

Response

baseray already covers this country; nothing was stored.

status'received' | 'live' required

received: the request is on the list (also when this address had asked before). live: baseray already covers the country; nothing was stored.

countrystring required

The country asked for, upper case.

Example response

{
  "status": "received",
  "country": "DE"
}

Changes

No recorded changes to this operation across all 1 revision of this API.