> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ephra.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Atualizar endereço da empresa

> Grava o endereço da empresa autenticada. É o endereço que sai em documento fiscal e o que a verificação de cadastro confere, então uma mudança de sede precisa passar por aqui antes da próxima emissão. Os campos omitidos ficam como estão; um corpo vazio não muda nada.



## OpenAPI

````yaml /openapi.yaml put /v1/company/address
openapi: 3.0.3
info:
  title: Ephra API
  description: >-
    API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks
    e a API do vendedor sobre catálogo, checkout, vendas, reembolsos,
    financeiro, crescimento e plataforma.


    **Limite de requisições.** 1000 requisições por minuto por IP de origem.
    Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e
    `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a
    resposta é `429` com `retry-after`.


    **Erros.** Toda falha responde o mesmo envelope: `{ "success": false,
    "message": "..." }`.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security: []
tags:
  - name: Catálogo
    description: Produtos, ofertas, categorias e cupons — o que a empresa vende.
  - name: Checkout
    description: Checkouts, order bumps, upsells e links de pagamento.
  - name: Vendas
    description: Vendas, clientes, assinaturas e entregas já realizadas.
  - name: Reembolsos
    description: Pedidos de reembolso, contestações e o quiz de retenção.
  - name: Financeiro
    description: Saldo, saques, antecipações, taxas e extratos da empresa.
  - name: Crescimento
    description: Afiliados, coprodução, indicações, pixels e integrações de marketing.
  - name: Plataforma
    description: Conta, membros, chaves de API, webhooks e configurações gerais.
paths:
  /v1/company/address:
    put:
      tags:
        - Plataforma
      summary: Atualizar endereço da empresa
      description: >-
        Grava o endereço da empresa autenticada. É o endereço que sai em
        documento fiscal e o que a verificação de cadastro confere, então uma
        mudança de sede precisa passar por aqui antes da próxima emissão. Os
        campos omitidos ficam como estão; um corpo vazio não muda nada.
      operationId: updateCompanyAddress
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                zipCode:
                  type: string
                  minLength: 8
                  maxLength: 9
                  description: CEP, com ou sem hífen.
                street:
                  type: string
                  minLength: 1
                  description: Logradouro.
                number:
                  type: string
                  minLength: 1
                  description: Número.
                complement:
                  type: string
                  description: Complemento.
                neighborhood:
                  type: string
                  minLength: 1
                  description: Bairro.
                city:
                  type: string
                  minLength: 1
                  description: Município.
                state:
                  type: string
                  minLength: 2
                  maxLength: 2
                  description: Unidade federativa, sigla.
              additionalProperties: false
            example:
              zipCode: '01310930'
              street: Avenida Paulista
              number: '1578'
              complement: Conjunto 402
              neighborhood: Bela Vista
              city: São Paulo
              state: SP
      responses:
        '200':
          description: Endereço depois da alteração.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: object
                    properties:
                      zipCode:
                        type: string
                        nullable: true
                        description: CEP, somente dígitos.
                      street:
                        type: string
                        nullable: true
                        description: Logradouro.
                      number:
                        type: string
                        nullable: true
                        description: Número.
                      complement:
                        type: string
                        nullable: true
                        description: Complemento.
                      neighborhood:
                        type: string
                        nullable: true
                        description: Bairro.
                      city:
                        type: string
                        nullable: true
                        description: Município.
                      state:
                        type: string
                        nullable: true
                        description: Unidade federativa, sigla de duas letras.
                      country:
                        type: string
                        nullable: true
                        description: País. `Brasil` quando nunca foi preenchido.
                    required:
                      - zipCode
                      - street
                      - number
                      - complement
                      - neighborhood
                      - city
                      - state
                      - country
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Endereço depois da alteração.
              example:
                success: true
                data:
                  zipCode: '01310930'
                  street: Avenida Paulista
                  number: '1578'
                  complement: Conjunto 402
                  neighborhood: Bela Vista
                  city: São Paulo
                  state: SP
                  country: Brasil
        '401':
          description: Token ausente, inválido, expirado ou de empresa bloqueada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Token ausente, inválido, expirado ou de empresa bloqueada.
              example:
                success: false
                message: Token inválido ou expirado
        '404':
          description: O recurso não existe, foi excluído ou pertence a outra empresa.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  O recurso não existe, foi excluído ou pertence a outra
                  empresa.
              example:
                success: false
                message: Recurso não encontrado
        '422':
          description: A requisição não passou na validação de schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: A requisição não passou na validação de schema.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Requisições demais: o limite é de 1000 requisições por minuto por IP
            de origem. Espere o número de segundos do header `retry-after` e
            repita com recuo exponencial.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Requisições demais: o limite é de 1000 requisições por minuto
                  por IP de origem. Espere o número de segundos do header
                  `retry-after` e repita com recuo exponencial.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Falha interna ao processar a requisição. Repita; se persistir, abra
            chamado com o horário e a rota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Falha interna ao processar a requisição. Repita; se persistir,
                  abra chamado com o horário e a rota.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Segundos a esperar antes de repetir a requisição.
      schema:
        type: integer
    x-ratelimit-limit:
      description: Teto de requisições na janela (1000). Presente em toda resposta.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Quantas requisições ainda cabem na janela atual. Presente em toda
        resposta.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Segundos até o contador da janela zerar. Presente em toda resposta.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````