Organizações
Enviar o cadastro de uma organização
Envia o cadastro da organização para análise.
Envia para análise o cadastro que já foi declarado na organização. Não recebe corpo: tudo o que vai para a análise foi gravado antes com
POST /v1/organizations/{id}.
Chame este endpoint quando requirements.missing estiver vazio. Enquanto faltar qualquer campo, a resposta é 400 com code: "requirements_incomplete" e a lista do que falta.
O envio é assíncrono: a resposta 200 confirma que o cadastro entrou na fila de análise (activation_status: "in_review"), não que foi aprovado. O resultado chega por organization.updated.
Autenticação
O
{id} da URL identifica a organização. Com chave de plataforma, a API confirma que esse org_* tem uma conexão ativa com a plataforma da chave.Parâmetros de caminho
string
required
ID da organização (
org_*).Corpo da requisição
Nenhum parâmetro. Se você enviar um corpo, ele precisa ser um objeto JSON válido — o conteúdo é ignorado.Comportamento
- Idempotente por estado. Organização já
in_reviewouactiveresponde200com o objeto atual, sem reenviar nada e sem abrir uma análise nova. Repetir a chamada por timeout é seguro. - Validação antes da fila. O envio só entra na fila quando o cadastro está completo e consistente. Falta de campo vira
400 requirements_incomplete, comparamapontando o primeiro caminho derequirements.missing. - Reenvio após reprovação. Em
disabledcomrequirements.disabled_reason: null, corrija os campos apontados emrequirements.missingcomPOST /v1/organizations/{id}e chame/submitde novo — mesma organização, mesmoorg_*. Comdisabled_reasonpreenchido não há caminho de autoatendimento; encaminhe ao suporte. - Modo de teste. Funciona com credencial de teste; o desfecho é escolhido pelo CPF/CNPJ da organização. Veja a tabela em Ativação por API.
Resposta
200 OK com o objeto organization completo. activation_submitted_at carimba o envio e activation_status passa para in_review.
requirements.pending_verification começa vazio e passa a listar o que está sendo verificado conforme a análise avança — releia a organização (ou espere o próximo organization.updated) para acompanhar.
Erros
Acompanhando o resultado
A análise é assíncrona. O veredito chega pororganization.updated:
- Aprovado →
activation_status: "active"erequirementstodo vazio. - Reprovado →
activation_status: "disabled",requirements.errorscom o motivo erequirements.missingcom o que dá para corrigir. - Falha do envio → a organização volta para
not_submitted,activation_submitted_atvolta paranullerequirements.errorsexplica o que impediu o envio. Corrija e chame/submitde novo.
requirements está em Requisitos de ativação.
