Seja bem-vindo à documentação oficial da API GreenSign. Este portal foi criado para oferecer a integradores, desenvolvedores e parceiros todas as informações necessárias para utilizar nossos serviços de comunicação digital com segurança, rastreabilidade e validade jurídica.
\nAtravés da nossa API, é possível realizar o envio de notificações digitais com validade jurídica por meio de múltiplos canais certificados, totalmente integráveis com seus sistemas:
\nGreenMail – Envio de e-mails transacionais e certificados
\nGreenSMS – SMS com entrega rastreada e validade jurídica
\nGreenZAP – Envio via WhatsApp certificado e rastreável
\nGreenVoice – Ligações automatizadas com leitura certificada
\nGreenCarta – Integração com Correios para envio físico rastreado
\nGreenRCS – Mensagens avançadas via operadora com certificado de entrega
\nGreenClick – Links certificados e rastreáveis para documentos e ações
\nTodos esses canais podem ser utilizados de forma individual ou orquestrada, permitindo a criação de fluxos inteligentes de envio, priorização e contingência, através do ecossistema de orquestração da GreenSign.
\nUse o menu lateral para explorar:
\n🔐 Autenticação e segurança
\n🔗 Endpoints por canal de envio
\n📨 Modelos de requisição e resposta
\n💡 Exemplos práticos (cURL, Postman etc.)
\n❗ Códigos de erro e tratamento de exceções
\nNosso objetivo é tornar a integração com a GreenSign rápida, transparente e totalmente adaptável aos seus fluxos de negócio.
\nCaso tenha dúvidas ou encontre dificuldades durante a implementação, nossa equipe técnica está pronta para te ajudar:
\n📧 E-mail: ti@greensign.com.br
\nAgradecemos por escolher a GreenSign como parceira estratégica em comunicação digital com validade jurídica.
\nEstamos comprometidos em oferecer uma API robusta, escalável e segura, contribuindo diretamente para a performance e confiabilidade da sua operação.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1554269","collectionId":"dd136039-2277-4ddb-ae52-6b2678080329","publishedId":"2sB34imfcc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"22FF62"},"publishDate":"2025-07-20T14:20:17.000Z"},"item":[{"name":"🔐 Autenticação e Acessos","item":[{"name":"Autenticação - Criar Token","id":"31be8cf1-208c-4e01-a6c5-5ec7cbdec38b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clientId\": \"Identificador do cliente da credenciação no padrão GUID, exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\r\n \"clientSecret\": \"Segredo do cliente da credenciação no padrão GUID, exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/GreenSign/Token","description":"Para consumir os recursos definidos abaixo é necessário enviar em TODA requisição o token no cabeçalho com o parâmetro Authorization e o Content-Type com o valor padrão de: application/json
Importante: Para obtenção das credenciais de homologação/produção, é necessário entrar contato com à nossa equipe de atendimento através do seu consultor, sistema de chamado ou através do e-mail ti@greensign.com.br.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"dd136039-2277-4ddb-ae52-6b2678080329","id":"dd136039-2277-4ddb-ae52-6b2678080329","name":"Documentação Integração GreenSign","type":"collection"}},"urlObject":{"path":["GreenSign","Token"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"31be8cf1-208c-4e01-a6c5-5ec7cbdec38b"}],"id":"ceb3bf34-c74d-4eae-b9cf-93c2a3de2f56","description":"A API da GreenSign utiliza autenticação via token JWT (JSON Web Token) para garantir a segurança nas comunicações entre sistemas. Todas as requisições autenticadas devem incluir um token de acesso válido no cabeçalho da requisição HTTP.
\nO cliente realiza uma requisição de autenticação fornecendo suas credenciais (geralmente clientId e clientSecret) ou outro método disponibilizado pela plataforma.
A API retorna um token JWT, que deve ser armazenado temporariamente pelo cliente.
\nEsse token deve ser incluído nas requisições subsequentes no cabeçalho Authorization.
O token possui um tempo de expiração definido.
\nAo expirar, será necessário solicitar um novo token de acesso utilizando o fluxo de autenticação apropriado.
\nÉ recomendável que o sistema do cliente trate erros HTTP 401 Unauthorized para realizar a renovação automaticamente.
Nunca compartilhe ou armazene o token em local inseguro.
\nO uso de HTTPS é obrigatório para todas as comunicações com a API, garantindo a confidencialidade dos dados trafegados.
\nIdentificador do usuário em formato numérico.
\n","type":"text/plain"},"key":"userId","value":"0000000000"}],"variable":[]}},"response":[],"_postman_id":"46fb542c-0bbe-49de-bd26-43e1b4d91896"},{"name":"Enviar Notificação GreenZap","id":"67b328ba-b850-4be3-9dc3-11bf2cb5b766","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Identificador do usuário em formato numérico.
\n","type":"text/plain"},"key":"userId","value":"0000000000"}],"variable":[]}},"response":[],"_postman_id":"67b328ba-b850-4be3-9dc3-11bf2cb5b766"},{"name":"Enviar Notificação GreenSMS","id":"982180e7-b3a1-4963-874b-bfaebe8152c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Identificador do usuário em formato numérico.
\n","type":"text/plain"},"key":"userId","value":"0000000000"}],"variable":[]}},"response":[],"_postman_id":"982180e7-b3a1-4963-874b-bfaebe8152c3"},{"name":"Enviar Notificação GreenVoice","id":"6570d0eb-3532-4db6-9791-d271263d7475","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Identificador do usuário em formato numérico.
\n","type":"text/plain"},"key":"userId","value":"0000000000"}],"variable":[]}},"response":[],"_postman_id":"6570d0eb-3532-4db6-9791-d271263d7475"}],"id":"2795d2ab-c52f-436a-9120-44334e9b4521","description":"A API da GreenSign permite o envio de notificações digitais com validade jurídica por múltiplos canais de comunicação, oferecendo flexibilidade, segurança e rastreabilidade em todo o processo.
\nOs canais disponíveis são:
\nGreenMail (e-mail)
\nGreenSMS (mensagem de texto)
\nGreenZAP (WhatsApp)
\nGreenVoice (mensagem de voz)
\nGreenCarta (carta registrada digital)
\nGreenRCS (mensagem enriquecida via operadora)
\nEsses canais podem ser utilizados individualmente ou combinados em estratégias de contingência, dentro do ecossistema de orquestração da GreenSign, que garante que a mensagem seja entregue pelo canal mais eficiente e rastreável possível.
\nO sistema do cliente realiza uma requisição POST para o endpoint de envio da GreenSign.
A requisição deve conter os dados do destinatário, o canal desejado (ex: GreenMail, GreenSMS etc.), o conteúdo da notificação e, quando aplicável, documentos em anexo.
\nApós o envio, a plataforma responde com o status da operação e um identificador único da notificação digital com validade jurídica.
\nAtualizações de status como \"enviado\", \"entregue\", \"aberto\" ou \"erro\" são informadas ao sistema do cliente via Webhook.
\nO envio de notificações pode ser orquestrado pela GreenSign para:
\nPriorizar canais com maior taxa de entrega e abertura
\nExecutar retentativas automáticas por canais alternativos
\nGarantir máxima efetividade na comunicação
\nCaso a sua empresa utilize um identificador único de processo que deva ser controlado e rastreado em todos os canais de comunicação, é possível informá-lo por meio do parâmetro CodigoProcesso no momento do envio da notificação. Esse mesmo identificador poderá ser posteriormente utilizado como critério de consulta nas rotinas de consulta de notificações, permitindo a localização, o acompanhamento e a auditoria do processo de forma centralizada, independentemente do canal utilizado.
Identificador do usuário em formato numérico.
\n","type":"text/plain"},"key":"UserId","value":"0000000000"},{"description":{"content":"E-mail do destinatario que recebeu a notificação (Obrigatório para GreenMail)
\n","type":"text/plain"},"key":"Destinatario","value":"email@dominio.tld"},{"description":{"content":"Identificador do canal utilizado para a notiicação: Email, SMS, WhatsApp, Voice ou Todos
\n","type":"text/plain"},"key":"canal","value":"Email"},{"description":{"content":"Identificador único do sistema de retaguarda no padrão numérico (este campo só deve ser utilizado se o campo \"IdentificadorCliente\" não for utilizado)
\n","type":"text/plain"},"key":"IdPesquisa","value":"000000000"},{"description":{"content":"Identificador único do sistema de retaguarda no padrão GUID, exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (este campo só deve ser utilizado se o campo \"IdPesquisa\" não for utilizado)
\n","type":"text/plain"},"key":"IdentificadorCliente","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"},{"description":{"content":"Número do processo do cliente em alfanumérico 50 posições, quando o número do processo for utilizado o canal deverá ser Todos
\n","type":"text/plain"},"key":"NumeroProcesso","value":"Alfanumérico 50 posições"}],"variable":[]}},"response":[],"_postman_id":"37a4d748-4d78-4be1-bcb6-511b240d13d4"},{"name":"Extração do Laudo Técnico","id":"48616a24-e580-47a0-b7b3-7240b8e1fac6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"tokenName","value":"A API de Extração do Laudo Técnico da GreenSign permite a obtenção programática do laudo técnico de notificação digital com validade jurídica, exclusivamente para notificações enviadas pelo canal de e-mail (GreenMail).
\nO laudo técnico é gerado individualmente por destinatário, consolidando as evidências técnicas específicas relacionadas ao envio, processamento e entrega da comunicação para cada endereço de e-mail notificado.
\nO laudo técnico extraído por meio desta API tem como objetivo:
\nComprovar a realização da notificação digital com validade jurídica para um destinatário específico
\nEvidenciar tecnicamente o processo de envio e entrega do e-mail individualmente
\nDemonstrar a integridade, autenticidade e rastreabilidade das informações transmitidas
\nSubsidiar processos administrativos, jurídicos ou auditorias
\nAtender requisitos de governança, segurança da informação e conformidade regulatória
\nO retorno da API contém, em formato estruturado, informações referentes exclusivamente ao destinatário consultado, incluindo:
\nIdentificação única da notificação (ID GreenSign)
\nDados do remetente e do destinatário do e-mail
\nDatas e horários relevantes (envio, processamento e entrega)
\nStatus detalhado da notificação
\nEvidências técnicas e registros de integridade
\nHashes criptográficos e metadados técnicos
\nInformações necessárias para rastreabilidade e comprovação jurídica
\nO retorno da API é exclusivamente em formato JSON
\nO laudo técnico é disponibilizado como arquivo codificado em Base64
\nO consumidor da API é responsável por realizar a decodificação do conteúdo Base64 para obtenção do arquivo original
\nO arquivo decodificado representa o laudo técnico individual do destinatário consultado
\nAPI REST para consulta e extração do laudo técnico
\nAutenticação obrigatória conforme credenciais configuradas na GreenSign
\nRetorno imutável, refletindo fielmente o estado da notificação no momento da extração
\nA extração do laudo não provoca qualquer alteração no status da notificação
\nO laudo técnico está disponível apenas para notificações enviadas via GreenMail
\nCada destinatário possui um laudo técnico próprio e independente, mesmo quando pertencente à mesma notificação
\nA GreenSign não interpreta, valida ou analisa o conteúdo do e-mail, limitando-se ao registro e preservação das evidências técnicas do processo
\nO uso da API deve respeitar as políticas de segurança, privacidade e limites de requisição definidos na plataforma
\nMétodo: GET https://dominio.tld/NomeDaApi/api/OAuth2/GreenMailLaudoTecnicoV1
Parâmetros de Consulta:
\nUserId: Identificador interno do destinatário (obrigatório)
Destinatario: e-mail do destinatário da notificação (obrigatório)
IdPesquisa: Identificador interno da notificação (ou ID gerado no envio)
IdentificadorCliente: GUID exclusivo fornecido pelo cliente para rastreabilidade
{\n \"id\": \"Identificador interno da notificação (ou ID gerado no envio)\",\n \"identificadorCliente\": \"GUID exclusivo fornecido pelo cliente para rastreabilidade\",\n \"laudo\": {\n \"nome\": \"nome do documento + extensão\",\n \"base64\": \"arquivo\"\n }\n}\n\nIdentificador do usuário em formato numérico.
\n","type":"text/plain"},"key":"UserId","value":"0000000000"},{"description":{"content":"E-mail do destinatario que recebeu a notificação (Obrigatório para GreenMail)
\n","type":"text/plain"},"key":"Destinatario","value":"email@dominio.tld"},{"description":{"content":"indentificador único do sistema de retaguarda no padrão numérico (este campo só deve ser utilizado se o campo \"IdentificadorCliente\" não for utilizado)
\n","type":"text/plain"},"key":"IdPesquisa","value":"000000000"},{"description":{"content":"indentificador único do sistema de retaguarda no padrão GUID, exemplo: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (este campo só deve ser utilizado se o campo \"IdPesquisa\" não for utilizado)
\n","type":"text/plain"},"key":"IdentificadorCliente","value":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}],"variable":[]}},"response":[],"_postman_id":"48616a24-e580-47a0-b7b3-7240b8e1fac6"}],"id":"43fb1be1-212f-4c87-98e3-60380a872b1a","description":"A API da GreenSign permite a consulta individualizada de notificações digitais com validade jurídica, possibilitando o acompanhamento completo do ciclo de vida de cada envio por canal.
\nEssa consulta é ideal para aplicações que desejam obter o status atualizado de uma notificação específica de forma ativa, sem depender exclusivamente do Webhook.
\nMétodo: GET
Parâmetros de Consulta:
\nUserId: Identificador interno do destinatário (obrigatório)
Destinatario: e-mail do destinatário da notificação (obrigatório para o canal GreenMail)
canal: Canal da notificação (ex: GreenMail, GreenSMS, GreenZAP, etc.)
IdPesquisa: Identificador interno da notificação (ou ID gerado no envio)
CodigoProcesso: Código alfanumérico do processo do cliente, com até 50 caracteres, utilizado para rastreabilidade e correlação das notificações. Quando este parâmetro for informado na consulta, o canal deverá ser definido como Todos, garantindo a recuperação das notificações relacionadas ao processo, independentemente do canal de envio
- `IdentificadorCliente`: GUID exclusivo fornecido pelo cliente para rastreabilidade\n- `CodigoProcesso`: Código alfanumérico do processo do cliente, com até **50 caracteres**, utilizado para **rastreabilidade e correlação** das notificações.Quando este parâmetro for informado na consulta, o **canal deverá ser definido como** _**Todos**_, garantindo a recuperação das notificações relacionadas ao processo, independentemente do canal de envio.\n\nO Webhook de Evento da GreenSign permite que sistemas parceiros recebam atualizações em tempo real sobre o status das notificações digitais enviadas via GreenSign, como e-mails, SMS e mensagens WhatsApp.
\nEssa integração garante que seu sistema seja informado assim que um evento relevante ocorrer — como o envio, entrega, abertura ou falha de entrega da notificação.
\nO cliente cadastra uma URL para recepção dos eventos (listener).
\nA GreenSign dispara uma requisição POST com os dados do evento toda vez que uma mudança de status ocorre.
O sistema do cliente processa os dados recebidos para fins de controle, auditoria, dashboards, entre outros.
\nMétodo: POST
URL: Definida pelo cliente (ex: https://cliente.com.br/api/evento-notificacao)
Headers:
\nContent-Type: application/json
Authorization: Bearer
evento: Pode ser um dos seguintes valores:
ENVIADO – Quando a notificação é emitida.
ENTREGUE – Quando o canal confirma o recebimento.
ABERTO – Quando há interação/visualização pelo destinatário.
ERRO – Quando ocorre falha no envio ou entrega.
dataEvento: Data e hora da ocorrência.
laudo: Quando configurado para enviar o laudo jurídico de acordo com o evento pré determinado.
nome – Nome do arquivo com a extensão.
base64 – Arquivo em base 64 de acordo com a configuração do webhook em sua conta.
link – Link para download do arquivo de acordo com a configuração do webhook em sua conta (link contém data de expiração).
erro (opcional): Detalhe do erro, se aplicável.
O sistema do cliente deve responder com:
\nsuccess boleano - indica o recebimento e o processamento correto do evento.
message string - pode conter informações adicionais em caso de erro.
O acesso ao Webhook é protegido via token JWT no cabeçalho Authorization.
\nRecomendado validar a origem da requisição e o conteúdo do payload para garantir integridade.
\nAtualização de status de envios em CRMs, ERPs e sistemas internos.
\nGeração de logs e trilhas de auditoria.
\nAcionamento de processos automatizados com base em eventos (ex: lembretes, reenvios, notificações internas).
\nA validação de e-mail da GreenSign garante que os endereços utilizados em notificações digitais com validade jurídica sejam corretos, entregáveis e rastreáveis.
\nO sistema parceiro envia o endereço de e-mail para o endpoint de validação.
\nA GreenSign executa verificações sintáticas e de domínio (DNS/MX).
\nO resultado indica se o e-mail é válido, inválido, temporário ou descartável.
\nO sistema do cliente pode registrar o status de validação para controle e auditoria.
\nMétodo: POST
\nHeaders:
\nContent-Type: application/json
Authorization: Bearer
{\n \"status\": 0,\n \"error\": \"\"\n}\n\nO sistema cliente deve processar o resultado retornado e agir conforme o status:
\nstatus: 0 → No (Não).
status: 1 → YesWithError (Sim, foi consultado e encontra-se com erro)
error: texto com o erro encontrado no e-mail verificadostatus: 2 → Yes (Sim, e-mail validado e sem erro)
Authorization: Bearer.Garantir entregabilidade de notificações digitais com validade jurídica.
\nPrevenir cadastros incorretos em CRMs, ERPs e plataformas de atendimento.
\nAutomatizar fluxos de confirmação de e-mail (duplo opt-in).
\nMelhorar reputação de remetente e reduzir rejeições de provedores.
\nA entrega efetiva é parte essencial da validade jurídica das notificações digitais.
\nAo validar previamente o endereço, a GreenSign assegura que o envio ocorra com integridade técnica e segurança probatória, fortalecendo o valor legal da comunicação.
\n","_postman_id":"835d1c6d-6354-4204-a430-9d2a99d189de","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"dd136039-2277-4ddb-ae52-6b2678080329","id":"dd136039-2277-4ddb-ae52-6b2678080329","name":"Documentação Integração GreenSign","type":"collection"}}}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"ee4d10d6-2774-412a-b606-375eabd417d2","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"9328e797-d515-48a4-b58f-6d016cbadf89","type":"text/javascript","packages":{},"exec":[""]}}]}