Building reports

A bought report

The report a token opens. While its Checkout is open the report is first settled from Stripe's current state, so it reads paid as soon as Stripe has the payment. A paid report opens its building for 12 months from payment (accessUntil). Limited per report: 240 reads a minute with one token, its building's reads included.

get/public/building-reports/{token}

Request

  • Base URL: https://api.baseray.ai/v1
  • URL: https://api.baseray.ai/v1/public/building-reports/{token}
  • Auth: none required

Path parameters

tokenstring required

The report's token: 43 base64url characters, from the report's link (https://app.baseray.ai/report/{token}).

Response

OK

status'pending' | 'paid' | 'expired' required

pending while Checkout is open, paid, or expired when Checkout closed unpaid.

locale'en' | 'ro' | 'cs' | 'da' required

The language it was bought in.

paidAtstring date-time nullable required
accessUntilstring date-time nullable required

Until when the report opens its building: 12 months from payment.

Example response

{
  "status": "pending",
  "building": {
    "id": "c9eefd1b-8c8d-48fe-8b72-e015374d7720",
    "country": "cz",
    "title": "Vinohradská 1200/12, 120 00 Praha 2"
  },
  "locale": "cs",
  "paidAt": null,
  "accessUntil": null
}

Changes

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