> ## 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. # Consultar dados da empresa > Devolve o cadastro da empresa autenticada: razão social, documento, situação cadastral, marca e endereço. Use para descobrir o identificador da própria empresa, para conferir se o cadastro está `active` antes de um lançamento, e para preencher documentos fiscais com o endereço registrado. ## OpenAPI ````yaml /openapi.yaml get /v1/company 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: get: tags: - Plataforma summary: Consultar dados da empresa description: >- Devolve o cadastro da empresa autenticada: razão social, documento, situação cadastral, marca e endereço. Use para descobrir o identificador da própria empresa, para conferir se o cadastro está `active` antes de um lançamento, e para preencher documentos fiscais com o endereço registrado. operationId: getCompany responses: '200': description: Cadastro da empresa autenticada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: id: type: string description: Identificador da empresa autenticada. name: type: string description: Razão social. document: type: string description: CNPJ ou CPF da empresa, somente dígitos. documentType: type: string enum: - PASSPORT - NATIONAL_ID - DRIVER_LICENSE - PROOF_OF_ADDRESS - SSN_OR_ITIN - STATE_ID - CERTIFICATE_OF_INC_OR_INCORPORATION - ARTICLES_OF_ORGANIZATION - VAT_NUMBER - COMPANY_REGISTRATION_CERT - MEMORANDUM_ARTICLES - CPF - CNPJ - COMPANY_ARTICLES_OF_ASSOCIATION - COMPANY_TAX_ID - TIN_OR_PAN - BUSINESS_LICENSE - TAX_ID - TFN_OR_IRD - ABN_OR_NZBN description: 'Tipo do documento: `CNPJ` ou `CPF`.' type: type: string enum: - individual - company description: >- Natureza do cadastro: pessoa jurídica ou pessoa física. status: type: string enum: - pending_analysis - active - blocked description: >- Situação cadastral. Só `active` opera normalmente; as demais limitam venda ou saque. isActive: type: boolean description: '`false` quando o cadastro foi desativado.' isBlocked: type: boolean description: >- `true` quando a conta está bloqueada e a API recusa o token. logoUrl: type: string nullable: true description: >- URL temporária do logo exibido no checkout e nos e-mails ao comprador. `null` quando não há logo. description: type: string nullable: true description: Descrição livre da empresa, exibida no perfil público. address: 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 createdAt: type: string format: date-time description: Momento em que a empresa foi cadastrada. updatedAt: type: string format: date-time description: Momento da última alteração no cadastro. required: - id - name - document - documentType - type - status - isActive - isBlocked - logoUrl - description - address - createdAt - updatedAt additionalProperties: false required: - success - data additionalProperties: false description: Cadastro da empresa autenticada. example: success: true data: id: cmtxx1uar0001hlg1u3ajbj6o name: Doce Ofício Confeitaria Digital LTDA document: '19131243000197' documentType: CNPJ type: company status: active isActive: true isBlocked: false logoUrl: >- https://documentos.ephra.io/companies/cmtxx1uar0001hlg1u3ajbj6o/logo.jpg?X-Amz-Expires=900 description: >- Cursos de confeitaria artesanal para quem vende doce em casa. address: zipCode: '01310930' street: Avenida Paulista number: '1578' complement: Conjunto 402 neighborhood: Bela Vista city: São Paulo state: SP country: Brasil createdAt: '2026-03-11T13:02:00.000Z' updatedAt: '2026-09-10T17:44:00.000Z' '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 ````