Skip to main content
Retorna o objeto organization completo. Os campos financeiros (activation_status, activation_status_updated_at, activation_submitted_at, requirements e statement_descriptor) são sempre preenchidos. Os campos platform e metadata descrevem a relação entre a plataforma autenticada e a organização conectada.

​
Autenticação

A organização vem do {id} da URL. Não envie o header Organization: o vínculo ativo é validado usando a plataforma da chave e o ID do caminho. API keys de organizações padrão não acessam esta rota.
activation_status não controla o acesso a esta rota. Uma organização conectada continua consultável quando o cadastro financeiro está not_submitted, in_review ou disabled. O status active indica aptidão para receber pagamentos, não a existência da conexão.

​
Parâmetros de caminho

​
string
required
ID da organização.

​
Resposta

​
string
ID público da organização.
​
string
Sempre "organization".
​
boolean
true em produção; false quando a leitura usa uma API key de teste.
​
string
Nome público da organização.
​
string | null
E-mail principal.
​
string | null
URL do logo/avatar.
​
string | null
CPF/CNPJ normalizado, somente dígitos.
​
string | null
Tipo do documento da organização.
​
string | null
Site público.
​
array
Lista [{ platform, url }].
​
string | null
Nome usado em cobranças.
​
object | null
Endereço de cobrança.
​
string | null
Informação adicional de cobrança.
​
object
Identidade visual usada por invoices e pelo portal do cliente: brand_color, accent_color, font_family, theme, border_style. Sempre presente; campos não configurados vêm null. O checkout hospedado usa a configuração separada do Checkout Builder.
​
object | null
Perfil de negócio declarado: annual_revenue (centavos), mcc, url. null até algum dado existir.
​
object | null
Dados cadastrais da empresa (CNPJ): address, email, name, opening_date, phone, trade_name. null em organizações CPF ou antes da coleta.
​
object | null
Pessoa física titular (CPF): address, birthdate, document, email, first_name, last_name, phone. null em organizações CNPJ ou antes da coleta.
​
object | null
Representante legal (CNPJ), mesmo formato de individual. null em organizações CPF ou antes da coleta.
​
object | null
Aceite dos termos: accepted_at, ip, user_agent. null antes do aceite.
​
string
Quando a organização foi criada.
​
string | null
Última modificação da organização.
​
object | null
Conta para saques ativa conectada à organização. Use este campo para exibir banco, agência/roteamento, titular e últimos 4 dígitos no admin da plataforma. null quando não há conta conectada. O número completo da conta nunca é retornado.
​
string | null
ID da plataforma quando a leitura usa API key de plataforma; caso contrário null.
​
object
Lista de tarefas da ativação financeira: disabled_reason, errors, missing e pending_verification. Sempre presente; em organização active, tudo vazio. Veja o formato completo em O objeto Organization e o fluxo de correção em Requisitos de ativação.
​
string
Status financeiro da organização. Sempre presente. Em disabled, requirements explica o motivo e a organização pode iniciar uma nova tentativa de ativação.
​
string | null
Data/hora da última atualização de activation_status.
​
string | null
Quando o cadastro foi enviado para análise. null antes do envio.
​
string | null
Nome exibido na fatura do comprador. Compartilhado entre organizações com o mesmo CPF/CNPJ; null antes do primeiro envio do cadastro.
​
object
Metadata da relação entre a plataforma autenticada e a organização conectada. {} quando vazia.
O exemplo abaixo mostra uma organização em análise (in_review): requirements.pending_verification lista o que está sendo verificado.
Em um 404, confira o org_*, o ambiente da API key e se a conexão com a plataforma continua ativa. Não adicione o header Organization: ele não é usado para resolver esta rota. Guarde o X-Request-Id da resposta se precisar acionar o suporte.