Introdução Última atualização: 01/09/2026

Essa área é destinada para os desenvolvedores que desejam integrar o sDoc em seus sistemas.
Aqui você vai encontrar toda a referência técnica que precisa para realizar uma integração completa.

Exemplos

  • Postman
    Baixe aqui a nossa Collection feita no Postman.

Histórico de atualizações

  • Versão 1.4
    • Callback Completa (evento SolicitationCreated com participantes e arquivos)
    01/09/2026
  • Versão 1.3
    • Perfis de Aprovador e Visualizador
    • Notificação por WhatsApp e SMS (sujeito à habilitação da conta)
    • Listar pastas da conta
    01/09/2026
  • Versão 1.2 beta
    • Tipos de Assinatura (Digital e Eletrônica)
    • Posicionamento de Carimbo
    • Buscar Participante
    09/03/2022
  • Versão 1.0.2
    • Correção de bugs
    17/09/2021
  • Versão 1.0.1
    • Editar Solicitação
    31/08/2021
  • Versão 1.0
    • Lançamento da API de integração
    16/07/2021
  • sDoc Integration 2020
    Compatibilidade encerrada.

Tecnologias

  • .NET 10
    Nossa API de integração foi feita inteiramente com .NET 10 usando C#.
  • SQL Server
    Nossa base de dados é 100% Microsoft com SQL Server.
  • Windows Server (IIS)
    A API está hospedada nos servidores seguros da Safeweb com Windows.

Recursos e Funcionalidades

Criar Solicitações

Criar fluxos de coletas de assinatura no sDoc via integração.
A API não realiza qualquer tipo de assinatura, esse processo é feito inteiramente dentro do portal.

Contas

Gerencie as solicitações de sua empresa com o módulo de contas.
Válido somente para empresas que criaram a conta no portal.

Baixar Arquivo

Tenha acesso aos arquivos salvos em nuvem do sDoc.
Disponível somente para solicitações criadas via integração.

Callbacks

Seja notificado sempre que houver uma assinatura no arquivo.
A solicitação também pode aderir à Callback Completa, que envia a situação de todos os participantes e arquivos do envelope a cada evento.

Recursos não contemplados

  • QR Code
    O compartilhamento rápido de arquivos usando o QR Code não está disponível na Integração.
  • Gestão da Conta
    Nenhum recurso de gestão (ex. crias pastas / gerenciar usuários) é contemplado na integração.
  • Consultar Solicitações
    A Integração não suporta consultar a lista de solicitações criadas via portal ou integração.
    Consultas são exclusivamente feitas pelo identificador único de cada uma.

Autenticação

Autenticação é feito pelo Header da requisição.
Como no exemplo abaixo, envie o Token no Header pela chave Authorization.

Segurança do Token

  • O Token é exclusivo e intransferível.
    Você fica inteiramente responsável pela guarda do token.
  • O Token fica criptografado na nossa base de dados.
    Somente você tem a versão original.
  • A Safeweb não se responsabiliza pela perda ou vazamento do Token.
    Caso ocorra essa adversidade, entre no portal do sDoc, no menu Integração e clique em Gerar Token.
    Esse processo revoga o Token e a SecretKey geradas anteriormente.

Callbacks

Sempre que houver alguma notificação, o sDoc vai notificar seu sistema via callback cadastrado da plataforma ou vinculado a uma solicitação.

Notificações disponíveis

  • Assinatura realizada Vamos notificar sempre que houver uma nova assinatura na sua solicitação.

Callback Completa

O formato descrito abaixo é o da notificação simples. Para receber a situação de todos os participantes e arquivos do envelope, consulte a seção Callback Completa.

SecretKey

Para garantir a segurança de sua API de callback, vamos enviar um SecretKey, que somente seu sistema e o sDoc conhecem, junto com a notificação.
Assim seu sistema sabe que é o sDoc chamando e notificando a atualização de uma solicitação.

  • Guarde a SecretKey dentro do seu código no back-end.
    Assim você evita a exposição da SecretKey.
  • A Safeweb não se responsabiliza pela perda ou vazamento da SecretKey.
    Caso ocorra essa adversidade, entre no portal do sDoc, no menu Integração e clique em Gerar Token.
    Esse processo revoga o Token e a SecretKey geradas anteriormente.
Estrutura do conteúdo de resposta:
Atributo Tipo Descrição Tamanho
identifier string Identificador da solicitação. Identificador da solicitação que ocorreu uma alteração. 30
type int Tipo de notificação. Tipo de ação que ocorreu dentro da solicitação. Consulte a lista de enums para mais detalhes. -
secretKey string SecretKey da plataforma. Chave para que sua aplicação saiba que é o sDoc chamando. 130
Modelo JSON:
																	
{
	"identifier": "AAA000BBB111CCC222DDD333",
	"type": 0,
	"secretKey": "E35C7BE29087A8907136D9A0994CA96AF578C7A6F5CB94EF2D11D1BB83C1EDB3"					
}

Callback Completa

A callback completa é um canal paralelo à notificação simples: a cada evento do fluxo, enviamos um payload com o status da solicitação, quem realizou a ação e a situação de todos os participantes e de todos os documentos do envelope. A chamada é sempre um POST, com Content-Type: application/json; charset=utf-8.

Adesão

A adesão é explícita: envie "completeCallback": true no corpo da criação da solicitação, junto com a URL em callback. Além de true, aceitamos 1, sim, s, yes, y e on (sem diferenciar maiúsculas). Qualquer outro conteúdo — inclusive uma URL — não liga o canal.

A callback simples não muda

Quem já integra continua recebendo a notificação simples, no mesmo corpo e no mesmo evento (assinatura realizada). A callback completa é um canal adicional, e não uma substituição.

Eventos

São 9 eventos, um para cada etapa do ciclo de vida da solicitação — da criação até a conclusão, recusa ou exclusão.

event Descrição
SolicitationCreated Solicitação criada via API e vinculada à plataforma integradora. Primeiro disparo do ciclo; não parte de nenhum participante, então participant é omitido e todos os participants[] saem como pending.
queued Assinatura entrou em processamento — o participante concluiu a ação e o documento foi enfileirado. Estado transitório: não confirma a assinatura.
signed Assinatura realizada com sucesso pelo participante em participant. Único evento que a callback simples também emite.
approved Documento aprovado — o participante atua como aprovador, e não como signatário. Conta como assinatura processada para o fechamento da solicitação.
rejected Assinatura recusada. Leva a solicitação inteira para status: rejected, pois a recusa interrompe o fluxo.
error Falha ao processar a assinatura. Internamente a assinatura continua pendente, mas participante e arquivo aparecem como error; cabe nova tentativa.
completed Solicitação concluída — todas as assinaturas foram processadas (assinadas ou aprovadas). Evento de envelope, sem participant.
deleted Solicitação excluída logicamente pelo portal. Evento de envelope; o status vai para canceled.
participant_removed Participante removido do fluxo. participant traz quem saiu; participants[] já vem sem ele.

Campos do payload

Raiz:
Atributo Tipo Descrição
identifier string Identificador da solicitação na plataforma integradora. O mesmo que você já recebeu na criação da solicitação.
event string Evento que provocou o disparo. Domínio na tabela de eventos, acima.
status string Status da solicitação no instante do disparo, o mesmo que o sDoc mostra em tela.
date string Data e hora do evento no formato yyyy-MM-dd HH:mm:ss. Vai como texto, e não como data, para que o formato não dependa da configuração do serializador.
participant objeto Quem realizou a ação: apenas identifier e email. Omitido nos eventos de envelope (SolicitationCreated, completed e deleted).
participants array Todos os participantes do envelope com o status vigente no disparo, cada um com seus documentos. A ordem dos participantes é a de cadastro na solicitação.
secret_key string Shared secret do token ativo da plataforma. Vai no corpo para o receptor confirmar a origem sem depender do header — essencial quando a estratégia de autenticação é None. Omitido se a plataforma não tiver token ativo.
participants[]:
Atributo Tipo Descrição
identifier string Identificador estável do participante. Sobrevive a uma eventual correção do e-mail na solicitação.
email string E-mail do participante.
status string Status do participante, consolidação de files[] — os dois nunca divergem. Não aparece dentro de participant, que leva só identificador e e-mail.
files array Um item por assinatura que cabe ao participante. Omitido quando ele ainda não tem nenhuma assinatura criada — e também dentro de participant.
participants[].files[]:
Atributo Tipo Descrição
identifier string Identificador do documento.
status string Status desta assinatura. Mesmo vocabulário do participante.

Modelos JSON

Evento de participante (signed):
                                
{
  "identifier": "964C8DC5BB4342F19C3BA7FF5413A7",
  "event": "signed",
  "status": "in_progress",
  "date": "2026-03-19 15:44:00",
  "participant": {
    "identifier": "9F2A1C34-7B0E-4D55-9E11-6C8A2D3F4B10",
    "email": "joao@email.com"
  },
  "participants": [
    {
      "identifier": "9F2A1C34-7B0E-4D55-9E11-6C8A2D3F4B10",
      "email": "joao@email.com",
      "status": "signed",
      "files": [
        { "identifier": "1A7C9D02-55E4-4B31-8F60-0D2E7A9C4411", "status": "signed" },
        { "identifier": "44B8E6F1-9C23-4A07-B5D8-7E1F30C6A922", "status": "signed" }
      ]
    },
    {
      "identifier": "3B61D8AA-2E44-4C90-8A77-15D0B9E7C233",
      "email": "maria@email.com",
      "status": "pending",
      "files": [
        { "identifier": "1A7C9D02-55E4-4B31-8F60-0D2E7A9C4411", "status": "pending" },
        { "identifier": "44B8E6F1-9C23-4A07-B5D8-7E1F30C6A922", "status": "pending" }
      ]
    }
  ],
  "secret_key": "b3f1c8d2-4a77-4f0e-9d51-2c9a6e18b7aa"
}
Evento de envelope (SolicitationCreated) — mesmo corpo, sem o bloco participant:
                                
{
  "identifier": "0CC7DB57FE62497F825B9212D43D10",
  "event": "SolicitationCreated",
  "status": "pending",
  "date": "2026-08-19 10:24:23",
  "participants": [
    {
      "identifier": "9F2A1C34-7B0E-4D55-9E11-6C8A2D3F4B10",
      "email": "participante@dominio.com.br",
      "status": "pending",
      "files": [
        { "identifier": "1A7C9D02-55E4-4B31-8F60-0D2E7A9C4411", "status": "pending" },
        { "identifier": "44B8E6F1-9C23-4A07-B5D8-7E1F30C6A922", "status": "pending" }
      ]
    }
  ],
  "secret_key": "b3f1c8d2-4a77-4f0e-9d51-2c9a6e18b7aa"
}

Status da solicitação

O status da raiz é derivado do envelope inteiro, nesta ordem de precedência: excluída → canceled; alguma recusa → rejected; todas processadas → completed; alguma processada → in_progress; senão → pending.

Valor Regra
pending Nenhuma assinatura coletada ainda.
in_progress Parte já assinou ou aprovou; faltam outros.
completed Todas as assinaturas processadas (e há mais de zero).
rejected Alguma assinatura recusada.
canceled Solicitação excluída logicamente.

Status do participante e do arquivo

Valor Significado
pending Falta assinar algum documento, ou não há assinatura criada.
signed Assinou todos os documentos que lhe cabiam.
rejected Recusou algum documento.
approved Aprovou todos os documentos — perfil aprovador.
error A última tentativa de assinatura falhou. Vem da falha registrada na assinatura, e não do status interno, e tem precedência sobre ele.

Reenvio

  • São feitas 2 tentativas, com intervalo de 10 segundos entre elas.
    Somente falhas transitórias são repetidas (erro de rede, timeout, 5xx, 408 e 429). Respostas 4xx não são repetidas.
  • Falhando as duas tentativas, o envio é descartado.
    Não há reenvio automático posterior; o evento fica registrado nos nossos logs.
  • Responda a chamada com HttpStatus 2xx o mais rápido possível.
    Processe o payload de forma assíncrona no seu lado.

Enums

Status da Assinatura
nº Descrição
1 Pendente
2 Assinado
3 Rejeitado
4 Aprovado
Tipo de Assinatura
nº Descrição
1 Assinatura Digital.
2 Assinatura Eletrônica.
3 Aprovador.
4 Visualizador.
Tipo de Notificação
nº Descrição
1 Assinatura realizada.
2 Assinatura rejeitada. [ Não implementado ]
3 Solicitação editada no portal. [ Não implementado ]
4 Solicitação excluida via portal. [ Não implementado ]
5 Download de arquivo via portal. [ Não implementado ]

Solicitação

Crie fluxos de solicitações de assinaturas dentro do sDoc.

Limitações

  • Não é possível gerenciar solicitações criadas via portal.
  • Não é possível incluir novos participantes em solicitações criadas via API.
  • Não é possível adicionar novos arquivos em solicitações criadas via API.
  • Máximo de 5 arquivos por solicitação.
  • Máximo de 50 participantes por solicitação.
  • Assinatura do tipo 'eletrônica' deve ter seu carimbo posicionado após a criação da solicitação.

Envio de E-mail

Para utilizar o novo serviço de envio de e-mail ao criar uma solicitação via integração, será necessário realizar a inserção dos parâmetros de acordo com a estrutura do corpo de envio da requisição.

Conforme as instruções, você deverá adicionar os parâmetros de Settings conforme descrito na lista de parametros abaixo, além disso esta configuração é totalmente opcional.

caso você não queira realizar o envio de e-mails ao criar a solicitação, basta não adicionar os parâmetros ao corpo da requisição.

Criar

Método responsável por criar solicitações de assinatura dentro do portal do sDoc.

POST https://sdocs.safeweb.com.br/api/integration/v1/solicitation

(*) Atributos obrigatórios.

Estrutura do conteúdo de envio:
Atributo Tipo Descrição Tamanho ( min / max )
title* string Título da solicitação 5/200
description string Descrição da solicitação 5/400
callback string Link de callback para notificações 5/200
completeCallback bool Adesão à callback completa Quando true, o callback recebe o payload completo do envelope. Padrão: false. Consulte a seção Callback Completa. -
organization {
identifier string Identificador da conta 20
folder string Identificador da pasta 10
}
files [
{
name* string Nome do arquivo + extensão 5/200
type* string MimeType do arquivo 5/150
tempIdentifier* string Identificador temporário do arquivo 20
}
]
participants [
{
name* string Nome completo do participante 5/250
email* string E-mail para contato do participante 1/150
cpf* string CPF / CNPJ do participante 11 ou 14
signatureType* int Tipo de Assinatura Define o perfil do participante: assinatura digital (com certificado), eletrônica, aprovador ou visualizador. Consulte a lista de enums para mais detalhes. -
phone string Celular do participante Somente números, com DDD (ex.: 51999998888). Obrigatório quando sendSMS ou sendWhatsapp estiverem ativos. 10/11
}
]
Settings {
sendEmail bool true/false Ativa o envio de e-mail aos participantes ao criar a solicitação. Padrão: false. -
sendWhatsapp bool true/false Ativa o envio da notificação por WhatsApp. Padrão: false. Requer o recurso habilitado para a conta e phone preenchido nos participantes. -
sendSMS bool true/false Ativa o envio da notificação por SMS. Padrão: false. Requer o recurso habilitado para a conta e phone preenchido nos participantes. -
}
JSON:
																	
{
    "title": "título da solicitação",
    "description": "descrição da solicitação",
    "callback": "link de callback exclusivo para essa solicitação",
    "completeCallback": true,
    "organization": {
        "identifier": "identificador da conta",
        "folder": "identificador da pasta onde a solicitação vai ser vinculada"
    },
    "files": [
        {
            "name": "nome do arquivo + extensão",
            "type": "mimeType do arquivo",
            "tempIdentifier": "identificador temporário do arquivo"
        }
    ],
    "participants": [
        {
            "name": "nome completo do participante",
            "email": "e-mail de contato do participante",
            "cpf": "cpf/cnpj do participante",
            "phone": "51999998888",
            "signatureType": 1
        }
    ],
    "settings": {
        "sendEmail": true,
        "sendWhatsapp": false,
        "sendSMS": false
    }
}
Estrutura do conteúdo de resposta:
Atributo Tipo Descrição Tamanho
identifier string Identificador da solicitação. Esse identificador é exclusivo para essa solicitação vinculado a plataforma. 30
title string Título da solicitação. O título passa por uma formatação antes de ser salvo em nossa base de dados. -
description string Descrição da solicitação. A descrição passa por uma formatação antes de ser salvo em nossa base de dados. -
callback string Link de callback para notificações. Caso não tenha sido informado no ato da criação, o link retornado será o que foi informado no cadastro da plataforma. -
createdDate datetime Data de criação da solicitação. A data é gerada pelo nosso banco de dados. -
organization {
identifier string Identificador da conta. Identificador da conta escolhida para atribuir a solicitação. -
folder string Identificador da pasta. Identificador da pasta da conta escolhida para atribuir a solicitação. -
}
files [
{
identifier string Identificador do arquivo. Identificador gerado exclusivamente para o arquivo dessa solicitação. 15
name string Nome do arquivo. O nome do arquivo passa por algumas validações e formatações antes de ser salvo na nossa base de dados. -
type string MimeType do arquivo. -
}
]
participants [
{
identifier string Identificador do participante. Identificador gerado para o participante. 8
fileIdentifier string Identificador do arquivo vinculado ao participante. Identificador para vincular essa participante (assinatura) ao arquivo. 15
name string Nome completo do participante. O nome passa por uma formatação antes de ser salvo na nossa base de dados. -
email string E-mail para contato do participante. -
cpf string CPF / CNPJ do participante. -
status int Status da assinatura para o participante vinculado ao arquivo. Como a solicitação acabou de ser criada, por padrão esse valor sempre retorna 1. -
signatureType int Tipo de assinatura definido para o participante. Consulte a lista de enums para obter mais detalhes. -
}
]
Resposta:
																	
{
	"error": false,
	"message": "Solicitação criada com êxito.",
	"result": {
		"identifier": "identificador gerado para a solicitação (30 CARACTERES)",
		"title": "título da solicitação formatado",
		"description": "descrição da solicitação formatado",
		"callback": "link de callback que o sistema vai chamar para notificações",
		"createdDate": "2021-06-06T22:09:21", // data de criação da solicitação (gerada pelo nosso banco de dados)
		"organization": {
			"identifier": "identificador da conta.",
			"folder": "identificador da pasta onde a solicitação está."
		},
		"files": [
			{
			   "identifier": "identificação do arquivo",
			   "name": "nome do arquivo formatado",
			   "type": "tipo do arquivo"
			}
		],
		"participants": [
			{
			   "identifier": "identificador do participante",
			   "fileIdentifier": "identificação do arquivo vinculado ao participante",
			   "name": "nome do participante formatado",
			   "email": "e-mail formatado",
			   "cpf": "cpf/cnpj do participante",
			   "status": 1,         // status da assinatura
			   "signatureType": 1   // tipo de assinatura
			}
		]
	}

Editar

Método responsável por editar uma solicitação específica.

PUT https://sdocs.safeweb.com.br/api/integration/v1/solicitation?identifier=IDENTIFICADOR_DA_SOLICITAÇÃO

(*) Atributos obrigatórios.

Estrutura do conteúdo de envio:
Atributo Tipo Descrição Tamanho ( min / max )
title* string Título da solicitação Esse parâmetro sempre precisa ser enviado, mesmo que não seja modificado. 5/200
description string Descrição da solicitação Caso sua solicitação tenha uma descrição, e a API não receber esse parâmetro, o mesmo será removido. 5/400
callback string Link de callback para notificações Caso esse parâmetro não seja enviado, o callback atual não será substituido. 5/200
organization {
identifier string Identificador da conta Se sua solicitação estiver em uma conta, você pode move-lá para outra, mas não poderá mais retorna-lá para a Conta Pessoal. 20
folder string Identificador da pasta Parametro obrigatório, caso enviado o identificador da conta. 10
}
JSON:
																	
{
	"title": "novo título da solicitação",
	"description": "nova descrição da solicitação",
	"callback": "novo link de callback",
	"organization": {
		"identifier": "identificador da conta.",
		"folder": "identificador da pasta onde a solicitação vai ser vinculada."
	}			
}
Resposta:
																	
{
	"error": false,
	"message": "Solicitação editada com êxito."
}

Buscar

Método responsável por buscar uma solicitação específica.

GET https://sdocs.safeweb.com.br/api/integration/v1/solicitation?identifier=IDENTIFICADOR_DA_SOLICITAÇÃO

Resposta:
																	
{
	"error": false,
	"message": "Solicitação 'IDENTIFICADOR_DA_SOLICITAÇÃO' buscada com êxito.",
	"result": {
		"identifier": "IDENTIFICADOR_DA_SOLICITAÇÃO",
		"title": "título da solicitação",
		"description": "descrição da solicitação",
		"callback": "link de callback que o sistema vai chamar para notificações",
		"createdDate": "2021-06-06T22:09:21", // data de criação da solicitação
		"organization": {
			"identifier": "identificador da conta.",
			"folder": "identificador da pasta onde a solicitação está."
		},
		"files": [
			{
			   "identifier": "identificação do arquivo",
			   "name": "nome do arquivo",
			   "type": "tipo do arquivo"
			}
		],
		"participants": [
			{
			   "identifier": "identificador do participante",
			   "fileIdentifier": "identificação do arquivo vinculado ao participante",
			   "name": "nome do participante",
			   "email": "e-mail do participante",
			   "cpf": "cpf/cnpj do participante",
			   "status": 1 // status da assinatura
			}
		]
	}

Excluir

Método responsável por excluir uma solicitação criada via integração.

DELETE https://sdocs.safeweb.com.br/api/integration/v1/solicitation?identifier=IDENTIFICADOR_DA_SOLICITAÇÃO

Resposta:
																	
{
	"error": false,
	"message": "Solicitação excluída com êxito."	
}

Contas

Listagem de contas e suas respectivas pastas.

Limitações:

  • Não é possível gerenciar contas.
  • Não é possível gerenciar pastas.
  • Não é possível gerenciar usuários.
  • Não é possível mover solicitações criadas.

Recurso Descontinuado

O Módulo de contas está sendo descontinuado do sDoc. Quando isso de fato occorrer, você será notificado com antecedência para migrar as solicitações e adaptar sua aplicação.

Listar

Método responsável por listar contas que a plataforma faça parte.

GET https://sdocs.safeweb.com.br/api/integration/v1/organizations

Resposta:
                            									
{
    "error": false,
    "result": [
        {
            "identifier": "identificador da conta",
            "name": "nome da conta",
            "description": "descrição da conta",
            "folders": 00, // Total de pastas na conta.
            "users": 00 // Total de usuários vinculados na conta.
        },
        ...
    ]
}

Pastas

Método responsável por listar hierarquia de pastas de uma conta específica.

GET https://sdocs.safeweb.com.br/api/integration/v1/organization/{IDENTIFICADOR_DA_CONTA}/folders

Resposta:
                            									
{
    "error": false,
    "result": [
        {
            "identifier": "identificador da pasta",
            "name": "nome da pasta",
            "description": "descrição da pasta",
            "subFolders": [
                {
                    "identifier": "identificador da sub-pasta",
                    "name": "nome da sub-pasta",
                    "description": "descrição da sub-pasta",
                    "subFolders": [
                        ...
                    ]
                }
            ],
            ...
        }
}

Arquivo

Localizar e realizar upload de arquivos.

Limitações:

  • Somente um arquivo por chamada.
  • Somente arquivos de até 10MB.
  • Somente arquivos adicionados via integração.
  • Não é possível desenhar QR Code no arquivo PDF.

Upload

Método responsável por enviar um arquivo temporariamente ao servidor do sDoc.

POST https://sdocs.safeweb.com.br/api/integration/v1/file

Estrutura do conteúdo de envio:
Atributo Tipo Descrição Tamanho ( min / max )
base64* string Base64 do arquivo -

(*) Atributos obrigatórios.

JSON:
                            									
{
    "base64": "base64 válido",				
}
Resposta:
                            									
{
    "error": false,
    "result": {
        "tempIdentifier": "identificador temporário do arquivo (após criar a solicitação esse identificador é descartado)"
    }
}

Buscar

Método responsável por buscar um arquivo de uma solicitação pelo seu identificador.

GET https://sdocs.safeweb.com.br/api/integration/v1/file?identifier=IDENTIFICADOR_DO_ARQUIVO

Resposta:
                            									
{
    "error": false,
    "result": {
        "identifier": "IDENTIFICADOR_DO_ARQUIVO",
        "name": "nome do arquivo",
        "type": "tipo do arquivo",
        "base64": "base64 do arquivo no servidor (com ou sem assinaturas, dependendo do status dos participantes)."
    }
}

Buscar Protocolo

Método responsável por buscar o arquivo de protocolo de uma solicitação pelo seu identificador.

GET https://sdocs.safeweb.com.br/api/integration/v1/file/report?identifier=IDENTIFICADOR_DO_ARQUIVO

Resposta:
                            									
{
    "error": false,
    "result": {
        "identifier": "IDENTIFICADOR_DO_ARQUIVO",
        "name": "nome do arquivo",
        "type": "tipo do arquivo",
        "base64": "base64 do arquivo no servidor."
    }
}

Participante

Buscar, editar e posicionar carimbos para os participantes das solicitações.

Limitações:

  • Não é possível adicionar novos participantes ao fluxo.
  • Não é possível remover participantes inseridos no fluxo.
  • Somente participantes adicionados via integração.
  • Assinatura do tipo 'eletrônica' deve ter seu carimbo posicionado após a criação da solicitação.

Buscar

Método responsável por buscar um participante de uma solicitação pelo seu identificador.

GET https://sdocs.safeweb.com.br/api/integration/v1/participant?identifier=IDENTIFICADOR_DO_PARTICIPANTE

Estrutura do conteúdo de resposta:
Atributo Tipo Descrição Tamanho
identifier string Identificador do participante. 8
name string Nome completo do participante. -
email string E-mail para contato do participante. -
cpf string CPF / CNPJ do participante. -
status int Status da assinatura para o participante vinculado ao arquivo. Consulte a lista de enums para obter mais detalhes. -
signatureType int Tipo de assinatura definido para o participante. Consulte a lista de enums para obter mais detalhes. -
stamp {
page* string Página Número da página onde o carimbo deve ser posicionado no PDF. -
size {
width float Largura do Carimbo -
height float Altura do Carimbo -
}
position {
ury float URY -
urx float URX -
lly float LLY -
llx float LLX -
}
}
Resposta:
                            									
{
    "error": false,
    "result": {
        "identifier": "identificador do participante",
        "name": "nome do participante",
        "email": "e-mail do participante",
        "cpf": "cpf/cnpj do participante",
        "signatureType": 1,     // tipo de assinatura definido para o participante.
        "status": 1,            // status da assinatura
        "stamp": {              // Posição do carimbo ( se vinculado ao participante )
            "page": 1,
            "size": {
                "width": 180.57,
                "height": 60.94
            },
            "position": {
                "ury": 0.0,
                "urx": 0.0,
                "lly": 0.0,
                "llx": 0.0
            }	
        }
    }
}

Posicionar Carimbo

Método responsável por definir o posicionamento do carimbo para um participante.

POST https://sdocs.safeweb.com.br/api/integration/v1/participant/IDENTIFICADOR_DO_PARTICIPANTE/stamp

(*) Atributos obrigatórios.

Estrutura do conteúdo de envio:
Atributo Tipo Descrição Tamanho ( min / max )
page* string Página Número da página onde o carimbo deve ser posicionado no PDF. -
size {
width float Largura do Carimbo -
height float Altura do Carimbo -
}
position {
ury float URY -
urx float URX -
lly float LLY -
llx float LLX -
}
JSON:
																	
    {
        "page": 1,
        "size": {
            "width": 180.57,
            "height": 60.94
        },
        "position": {
            "ury": 0.0,
            "urx": 0.0,
            "lly": 0.0,
            "llx": 0.0
        }				
    }
Resposta:
                            									
    {
        "error": false,
        "message": "Carimbo posicionado com êxito."
    }

Remover Carimbo

Método responsável por buscar um arquivo de uma solicitação pelo seu identificador.

DELETE https://sdocs.safeweb.com.br/api/integration/v1/participant/IDENTIFICADOR_DO_PARTICIPANTE/stamp

Resposta:
                            									
    {
        "error": false,
        "message": "Carimbo removido com êxito."
    }