Skip to Content

Upload an establishment's logo

PUT
/v1/ec/establishments/{code}/logo

Replaces the previous one. The RIDE and the emails of the documents issued at this establishment wear it instead of the business's, which an establishment without a logo of its own inherits. PNG or JPEG, up to 512 KB: the format is read from the file, not from its name.

Authorization

headerAuthorizationBearer <token>

Your API key, which acts for the one business it was created for: fb_live_… keys work at api.fiscalbase.io and issue in live, and fb_sandbox_… keys work at api-sandbox.fiscalbase.io and issue in sandbox, on the simulated SRI. A key sent to the other host is refused with api_key_wrong_host, which names its host.

Path Parameters

code*string

The establishment's three digits.

Match^\d{3}$

Header Parameters

Fiscalbase-Environment?string

The environment the call acts in. Required with a person's session; a key's own environment is the one that counts, so a key may leave it out, and naming another is 422 environment_mismatch.

Value in"sandbox""test""live"
Fiscalbase-Business?string

The business the call acts for. With a person's session, the one the call is about (without it, a call about one business is 422 business_required and a list covers every business of the organization); a key acts for its own, so naming another is 422 business_mismatch.

Formatuuid
Fiscalbase-Channel?string

Which of Fiscalbase's own integrations a key's call comes from, recorded as the channel of the documents it issues: a record, not a permission. Without it, api. A person's call is always console.

Value in"api""mcp"
Fiscalbase-Agent?string

The AI agent a key's call comes from, as its client names itself (the MCP server sets it); recorded with the request and shown in the console's request log.

Request Body

multipart/form-data
  1. body
file*file

The logo, as PNG or JPEG, up to 512 KB.

Formatbinary

Response Body

The establishment

application/json
  1. response
object*"establishment"
Value in"establishment"
business_id*string
Formatuuid
code*string
Match^\d{3}$
name*|

What the issuer calls the establishment, so its teams recognize it. Null if it did not name it.

address*|

Where it is, as its documents print it.

logo*|

The establishment's own logo, or null when it has none and inherits the business's.

effective_logo*|

The logo the RIDE and the emails of the documents issued at this establishment wear: its own, or the business's when it has none; null when neither has one.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X PUT 'https://api.fiscalbase.io/v1/ec/establishments/string/logo' \
  -F 'file=string'
Example Response
{
  "object": "establishment",
  "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  "code": "string",
  "name": "string",
  "address": "string",
  "logo": {
    "url": "http://example.com",
    "content_type": "image/png",
    "size": 0
  },
  "effective_logo": {
    "url": "http://example.com",
    "content_type": "image/png",
    "size": 0
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}