Setfin Connect
DocumentaçãoAplicativo
DocumentaçãoAplicativo
Falar com suporte
  1. Documentação
  • Introdução
  • Autenticação
    • Autenticação
      POST
    • Validação OTP
      POST
    • Validar Telefone
      GET
    • Get Autenticação
      GET
  • Empresa
    • Verificar CNPJ
      GET
    • Consultar Empresa
      GET
    • Criar Empresa
      POST
    • Atualizar Empresa
      PATCH
  • Impostos
    • Consultar Impostos
      GET
    • Consultar Imposto Individual
      GET
    • Criar Imposto
      POST
    • Emitir Guia de Pagamento
      POST
  • Dados Cadastrais
    • Introdução
    • Pessoa Jurídica
      • Consultar Dados
      • Consultar Sócios
      • Consultar Score
    • Pessoa Física
      • Consultar Dados
      • Consultar Empresas no CPF
  • Certificado
    • Consultar Certificado
      GET
    • Criar Certificado
      POST
    • Deletar Certificado
      DELETE
  • Nota Fiscal
    • Guia de integração
    • Nota de produto
      • Consultar Notas de Produto
      • Consultar uma Nota de Produto
      • Consultar Anexos de Nota de Produto
      • Emitir Nota de Produto
      • Cancelar Nota de Produto
    • Nota de serviço
      • Consultar Notas de Serviço
      • Consultar uma Nota de Serviço
      • Consultar Anexos de Nota de Serviço
      • Emitir Nota de Serviço
      • Cancelar Nota de Serviço
    • Consultar Status de Configuração
      GET
    • Configurar Emissão de Nota Fiscal
      POST
  • Serviços Municipais
    • Consultar Status do Município
    • Consultar Serviços Municipais
  • Cobrança
    • Cedente
      • Consultar Carteiras
      • Criar Cedente
    • Criar cobrança
    • Vincular carteira
  1. Documentação

Introdução

Sobre o Connect#

Bem-vindo à documentação da Setfin Connect API! Esta é a API principal que permite integração completa com o ecossistema Setfin, oferecendo soluções robustas para gestão financeira, emissão de notas fiscais, conciliação bancária e muito mais.

O que é o Setfin Connect?#

O Setfin Connect é uma plataforma de integração que conecta empresas a serviços financeiros e fiscais através de uma API REST moderna e segura.

Arquitetura da API#

Nossa API é construída com NestJS e segue os princípios de Clean Architecture, garantindo:
Escalabilidade - Suporte a milhares de requisições simultâneas
Segurança - Autenticação JWT e autorização por scopes
Confiabilidade - Tratamento robusto de erros e validações
Manutenibilidade - Código limpo e bem estruturado
Documentação - Swagger/OpenAPI integrado

Tecnologias Utilizadas#

Backend: NestJS + TypeScript
Banco de Dados: PostgreSQL + Prisma ORM
Autenticação: JWT + Guards personalizados
Integrações: Pluggy (Open Banking), Webmaniabr (NFe), Firebase (Notificações)
Monitoramento: Sentry + Amplitude
Containerização: Docker + Docker Compose

Autenticação#

Todos os endpoints requerem autenticação via Bearer Token:

Estrutura de Resposta#

Sucesso: 200 OK, 201 Created, 204 No Content
Erro do Cliente: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 422 Unprocessable Entity
Erro do Servidor: 500 Internal Server Error

Produtos Ofertados#

Gestão Financeira Completa
Controle total do fluxo de caixa com lançamentos automáticos e relatórios personalizados.
Emissão de Notas Fiscais
Emita e gerencie notas fiscais de forma simples e automatizada.
Open Banking
Integração completa com bancos via Pluggy para sincronização automática.
Conciliação Bancária
Concilie lançamentos com extrato bancário de forma simples.
Gestão de Contatos
CRM completo integrado com validação de documentos e importação em lote.
Sistema de Permissões
Controle granular de acesso por usuário com roles e scopes personalizados.
Modificado em 2025-09-09 01:16:39
Próxima página
Autenticação
Built with