Dilligence — certidões de empresas

Cria a conta do usuário com o e-mail dele e 10 créditos grátis (10 certidões). Devolve api_key, mcp_url (URL do conector já com a chave, para o usuário configurar e não perder o acesso) e app_url. Funciona sem autenticação. O usuário recebe um e-mail avisando.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "agent_name": {
      "type": "string",
      "description": "Seu nome, ex. Claude"
    }
  },
  "required": [
    "email"
  ]
}

Conta atual: saldo em créditos (1 crédito = 1 certidão emitida), membros, chaves, extrato e pagamento (pacotes, cartão salvo).

{
  "type": "object",
  "properties": {},
  "required": []
}

Cria um link de pagamento do Stripe para o usuário comprar um pacote de créditos: 10 créditos por R$ 80, 30 créditos por R$ 200, 80 créditos por R$ 500. Você não paga: passe checkout_url ao usuário; o cartão salvo aparece preenchido. Depois chame check_payment com o session_id. Pergunte o pacote ao usuário antes.

{
  "type": "object",
  "properties": {
    "credits": {
      "type": "number",
      "enum": [
        10,
        30,
        80
      ],
      "description": "Créditos do pacote"
    }
  },
  "required": [
    "credits"
  ]
}

Confere se o usuário pagou o link de buy_credits e credita o saldo (uma vez só). Devolve paid, credited e o saldo atual em créditos.

{
  "type": "object",
  "properties": {
    "session_id": {
      "type": "string"
    }
  },
  "required": [
    "session_id"
  ]
}

Convida alguém para o workspace (vê e edita todas as diligências). Envia e-mail de convite: só use se o usuário pediu.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    }
  },
  "required": [
    "email"
  ]
}

Tira um membro do workspace (id de account.members).

{
  "type": "object",
  "properties": {
    "user_id": {
      "type": "string"
    }
  },
  "required": [
    "user_id"
  ]
}

Cria outra chave de API (para outro agente ou sistema). A chave aparece só nesta resposta.

{
  "type": "object",
  "properties": {
    "label": {
      "type": "string"
    }
  },
  "required": [
    "label"
  ]
}

Revoga uma chave (id de account.keys).

{
  "type": "object",
  "properties": {
    "key_id": {
      "type": "string"
    }
  },
  "required": [
    "key_id"
  ]
}

Certidões que buscamos: órgão, validade, taxa do órgão, se é automática. Com cnpj, só as que valem para aquela empresa, com o TRT e o TRF da região dela. Famílias regionais: "trt" (TRT da região de cada empresa, TRT-1 a 24) e "trf" (TRF da região, TRF1 a 6) servem como id em create_diligence; ids regionais (trt15, trf1…) pedem um tribunal específico, ex. TRT-15 para uma filial em Campinas. 1 crédito por certidão emitida; reuso em 24 h e falhas não cobram.

{
  "type": "object",
  "properties": {
    "cnpj": {
      "type": "string",
      "description": "Opcional: só as certidões que valem para esta empresa (pela sede na Receita)"
    }
  },
  "required": []
}

Modelos de diligência prontos (ma: aquisição/M&A, credito, fornecedor, licitacao, imovel), já ajustados à sede de cada CNPJ: TRT e TRF da região de cada empresa (todos os TRTs e TRFs); onde não buscamos (TJ, Sefaz e prefeitura fora de SP, prefeituras fora da capital) o modelo troca a certidão de SP pela local (TJMG, SEFAZ-MG...) como documento que a empresa envia, só para aquela empresa. Devolve cada modelo com os itens (certidão do catálogo ou documento, e para quais cnpjs), o que mudou por local (adjustments) e um modelo sugerido pelo nome da diligência. Use antes de create_diligence com template.

{
  "type": "object",
  "properties": {
    "cnpjs": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string",
      "description": "Nome da diligência, para sugerir o modelo"
    }
  },
  "required": []
}

Monitoramento contínuo de CNPJs (renovar certidões antes de vencer e avisar quando algo muda) está em acesso antecipado. Coloca o e-mail do usuário na lista; só use se ele pediu. Funciona sem autenticação.

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string"
    },
    "note": {
      "type": "string",
      "description": "Opcional: quantos CNPJs e para quê, ex. 300 fornecedores"
    }
  },
  "required": [
    "email"
  ]
}

Abre uma diligência para os CNPJs com a lista de documentos que o usuário quer. certidoes: ids de list_catalog, que pedimos aos órgãos. documents: qualquer outro documento (contrato social, balanço, alvará...), que fica com alguém para enviar. Só monta a lista: os pedidos aos órgãos começam quando você chama fetch_certidoes (ou passe fetch=true se o usuário já pediu para buscar). Se o usuário tem um checklist, passe por match_documents antes e confirme a lista com ele. Sem certidoes nem documents, entram todas as certidões do catálogo. 1 crédito por certidão emitida (cobrado só quando sai); documentos enviados não cobram.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "cnpjs": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "template": {
      "type": "string",
      "description": "Modelo de list_templates (ma, credito, fornecedor, licitacao, imovel): monta a lista ajustada à sede de cada empresa; certidoes e documents somam a ela"
    },
    "certidoes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "ids de list_catalog"
    },
    "documents": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Títulos de documentos fora do catálogo"
    },
    "fetch": {
      "type": "boolean",
      "description": "Já pede as certidões aos órgãos"
    }
  },
  "required": [
    "cnpjs"
  ]
}

Pede aos órgãos as certidões da diligência que ainda não foram pedidas (status "ready"), ou só item_ids (também repete as que pararam). Gasta créditos quando a certidão sai: confirme com o usuário se ele não pediu para buscar.

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "item_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "diligence_id"
  ]
}

Pedidos do workspace: a pessoas (link de envio; quem abriu, lembretes) e aos órgãos (cada busca), com o que já chegou. Use para acompanhar e cobrar.

{
  "type": "object",
  "properties": {
    "open_only": {
      "type": "boolean"
    }
  },
  "required": []
}

Faz um pedido de documentos. to="robot" pede certidões aos órgãos; to={name,email} pede a uma pessoa por link (e-mail só se o usuário pediu: send=true). Dentro de uma diligência (diligence_id; item_ids reaproveita itens dela) ou avulso (cnpj, sem diligência). certidoes e documents como em create_diligence.

{
  "type": "object",
  "properties": {
    "to": {
      "description": "\"robot\" ou {name, email, send}"
    },
    "diligence_id": {
      "type": "string"
    },
    "cnpj": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "certidoes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "documents": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "item_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "to"
  ]
}

Manda de novo o e-mail de um pedido a uma pessoa, com o que ainda falta (id de list_requests). Só se o usuário pediu.

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string"
    }
  },
  "required": [
    "request_id"
  ]
}

Tira um documento da lista da diligência. Uma certidão que ainda não foi pedida ao órgão é cancelada.

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "item_id": {
      "type": "string"
    }
  },
  "required": [
    "diligence_id",
    "item_id"
  ]
}

Lê uma lista de documentos pedidos (checklist colado, e-mail, planilha ou foto em base64) e diz, para cada um, quais certidões do catálogo atendem (source_ids) ou se é um documento que alguém precisa enviar (source_ids vazio). Use antes de create_diligence ou add_document.

{
  "type": "object",
  "properties": {
    "text": {
      "type": "string"
    },
    "content_base64": {
      "type": "string",
      "description": "Arquivo (PDF, Excel, Word, CSV, imagem) em vez de text"
    },
    "filename": {
      "type": "string"
    }
  },
  "required": []
}

Lista as diligências do workspace com progresso.

{
  "type": "object",
  "properties": {},
  "required": []
}

Situação de cada item (status, responsável, resultado, validade, código, resumo), links de envio e de leitura, e app_url.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Espera até 45 s por mudanças na diligência. Passe o cursor devolvido na chamada anterior. Repita enquanto houver itens fetching ou waiting.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "cursor": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ]
}

Renomeia a diligência.

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "diligence_id",
    "name"
  ]
}

Adiciona documentos à lista de uma diligência já aberta, para todas as empresas (ou só party_ids, de get_diligence.parties): certidoes (ids de list_catalog) e documents (títulos livres, ex. contrato social, que alguém envia). Também aceita title para um só documento livre. As certidões esperam fetch_certidoes, ou passe fetch=true.

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "certidoes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "documents": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "title": {
      "type": "string"
    },
    "party_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "fetch": {
      "type": "boolean"
    }
  },
  "required": [
    "diligence_id"
  ]
}

Detalhe completo de um item: resumo inteiro, motivo de ter parado, protocolo, próxima checagem, taxa, tentativas e histórico.

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "item_id": {
      "type": "string"
    }
  },
  "required": [
    "diligence_id",
    "item_id"
  ]
}

Lê o documento de um item (certidão emitida ou arquivo enviado): texto completo do PDF, resultado, validade e código. include_file=true também anexa o PDF em base64.

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "item_id": {
      "type": "string"
    },
    "include_file": {
      "type": "boolean"
    }
  },
  "required": [
    "diligence_id",
    "item_id"
  ]
}

Busca a certidão de novo (item que falhou, parou num muro, ou para renovar).

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "item_id": {
      "type": "string"
    }
  },
  "required": [
    "diligence_id",
    "item_id"
  ]
}

Aprova a taxa do órgão para um item (ex. CETESB R$ 138 = 25 créditos, além do crédito da certidão) e retoma a busca. Gasta créditos: confirme com o usuário antes.

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "item_id": {
      "type": "string"
    }
  },
  "required": [
    "diligence_id",
    "item_id"
  ]
}

Marca o item como "não se aplica", com o motivo.

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "item_id": {
      "type": "string"
    },
    "reason": {
      "type": "string"
    }
  },
  "required": [
    "diligence_id",
    "item_id",
    "reason"
  ]
}

Define o responsável por um item: "me", o id de um membro (u:...), ou {name,email,send_email} de alguém de fora (recebe link de envio; e-mail só com send_email=true).

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "item_id": {
      "type": "string"
    },
    "owner": {}
  },
  "required": [
    "diligence_id",
    "item_id",
    "owner"
  ]
}

Uma ação em vários itens de uma vez: action="owner" (owner como em assign_item, ou null para tirar), "retry" (busca de novo as certidões que pararam ou não foram pedidas; gasta créditos quando saem), "na" (não se aplica, com reason) ou "remove" (tira da lista). Itens em que a ação não cabe são pulados e contados em skipped.

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "action": {
      "type": "string",
      "enum": [
        "owner",
        "retry",
        "na",
        "remove"
      ]
    },
    "item_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "owner": {},
    "reason": {
      "type": "string"
    }
  },
  "required": [
    "diligence_id",
    "action",
    "item_ids"
  ]
}

Pede vários itens a uma pessoa de fora (ex. o financeiro da empresa). Devolve o link de envio, sem login, com o passo a passo de cada documento. Só envia e-mail se send_email=true.

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "item_ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "email": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "send_email": {
      "type": "boolean"
    }
  },
  "required": [
    "diligence_id",
    "item_ids",
    "email"
  ]
}

Anexa um arquivo (PDF, PNG, JPG) a um item, por file_url ou content_base64. PDFs de certidão são lidos (resultado, validade, código).

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "item_id": {
      "type": "string"
    },
    "file_url": {
      "type": "string"
    },
    "content_base64": {
      "type": "string"
    },
    "filename": {
      "type": "string"
    }
  },
  "required": [
    "diligence_id",
    "item_id"
  ]
}

Liga ou desliga o link de leitura da diligência (quem tiver o link vê os itens e baixa os PDFs, sem login).

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "diligence_id",
    "enabled"
  ]
}

Link de um ZIP com todos os documentos da diligência (pasta Documentos/) e uma planilha .xlsx com uma linha por documento: situação, resultado, validade, código, protocolo, resumo e link para o arquivo. Usa o link de leitura; se estiver desligado, passe enable_share=true para ligá-lo.

{
  "type": "object",
  "properties": {
    "diligence_id": {
      "type": "string"
    },
    "enable_share": {
      "type": "boolean"
    }
  },
  "required": [
    "diligence_id"
  ]
}