Skip to content

Entity: Institution

Represents the nonprofit institution's profile data, used to display contact and identity information.

Fields

FieldTypeNullableDefaultDescription
idserialnoautoPrimary key
namevarcharnoInstitution name
slugvarcharnoURL-friendly version of the name, unique
instagramvarcharyesnullInstagram handle (without @)
whatsappvarcharyesnullWhatsApp number, digits only in DB
pix_keyvarcharyesnullPIX key (any format: CPF, email, phone, random)

Relations

None.

Business rules

  • Only one institution record exists at a time (singleton).
  • whatsapp must contain only digits when received via API request.
  • All fields except id, name, and slug are optional.
  • slug is derived from name at write time (lowercased, accents removed, spaces replaced with hyphens).
  • slug must be unique.

Notes

  • whatsapp is stored as varchar in the DB to preserve formatting flexibility, but the API validates it as digits-only.