✔️PATCH/api/v2/processo/{idProcesso}/reenviar-processo
Last updated
Last updated
Este serviço permite aos Clientes, via API, reenviar o processo para os destinatários pendentes de assinatura na ordem de assinatura atual, permitindo editar dados os destinatários pendentes de assinatura.
Quando campo requerido estiver como “Sim” = Sempre requerido
Quando campo requerido estiver como “Não” = Informação Opcional
Quando campo requerido estiver como “Talvez” = Em alguns casos ele será requerido. Para saber estes casos, consultar a descrição do tópico, conforme o número de referência da linha na tabela.
Exemplo Body - Sem edição
Exemplo Body - Com edição
Para autenticar na API da ArqSign deve-se informar a AppKey da conta que está reenviando o processo. Esta conta deve estar ativa e com a devida permissão para o uso da integração Arqsign.
01. idProcessoDestinatario
Descrição: Parâmetro informando o Id do destinatário que será reenviado o processo.
Formato: Guid
Requerido: Sim, quando houver dados para edição.
Validação: O reenvio do processo é permitido somente para destinatários com ação de Assinar Online que estejam com ação de assinatura pendente nos documentos. Não é permitido o envio do processo para destinatários com ação de Receber Cópia.
02. IdFormaEnvioProcesso
Descrição: Parâmetro informando a forma de reenvio do processo
Formato: Bit - 1 - E-mail ou 2 - Whatsapp
Requerido: Não
03. nome
Descrição: Parâmetro informando o nome do destinatário.
Formato: String
Requerido: Não
04. email
Descrição: Parâmetro informando o e-mail para reenviar o processo.
Formato: String
Requerido: Sim, quando o parâmetro idFormaEnvio for igual a 1.
Validação: O e-mail informado deve estar em um formato válido
05. telefone
Descrição: Parâmetro informando o telefone para reenviar o processo.
Formato: String
Requerido: Sim, quando o parâmetro idFormaEnvio for igual a 2.
Validação: Somente é possível reenviar processo por WhatsApp (idFormaEnvioProcesso = 2) quando o tipo de assinatura destinatário for eletrônica.
06. idMeioEnvioCodigoSeguranca
Descrição: Os dados de Código de Segurança podem ser editados somente para destinatários que possuam a configuração de código de segurança, não permitindo inserir código de segurança para destinatários que não foram configurados inicialmente para usar o código de segurança. É permitido apenas alterar a forma de entrega do código de segurança para os destinatários que possuam esta configuração no processo.
Formato: Bit, 1- SMS (Somente Brasil), 2 – Whatsapp, 3 – Email ou 4 - Não enviar
Requerido: Não
07. emailSeguranca
Descrição: Parâmetro informando o e-mail para envio do código de segurança.
Formato: String
Requerido: Sim, quando o parâmetro idMeioEnvioCodigoSeguranca for igual a 3.
08. telefoneSeguranca
Descrição: Parâmetro informando o telefone para envio do código de segurança.
Formato: String
Requerido: Sim, quando o parâmetro idMeioEnvioCodigoSeguranca for igual a 1 ou 2.
09. permitirReenviarCodigo
Descrição: Permitir o reenvio do código de segurança
Formato: Bit, 1 = true ou 0 = False
Requerido: Não
10.dadosAssinatura
Esta parte do JSON é opcional e permite editar os dados de assinatura dos destinatários com idTipoAssinatura igual a 1 = eletrônica que possuam estes dados configurados, que podem ser usados para preenchimento de campos ou validação do documento no momento que o destinatário assinar os documentos do processo como pessoa física e/ou jurídica.
Quando forem enviados dados de assinatura para destinatários que não foram configurados inicialmente com estes dados, estes serão desconsiderados.
10.1 Signatário: Parâmetros para editar nome e documento do signatário que serão utilizados para preenchimento de campos na tela ou validação do documento do signatário.
a. nome
Descrição: Parâmetro informando o nome do signatário que será alterado ao reenviar o processo.
Formato: Varchar(250)
Requerido: Não
b. numeroDocumento
Descrição: Parâmetro informando o documento do signatário que será alterado ao reenviar o processo.
Formato: String
Requerido: Não
c. validarDocumento
Descrição: Parâmetro informando se o número do documento do destinatário alterado no parâmetro numeroDocumento do objeto signatario será utilizado para validação ou não.
Formato: Bit: 1 – True ou 0 - False
Requerido: Não
Os dados informados neste parâmetro serão desconsiderados quando o parâmetro numeroDocumento objeto signatario for nulo ou não for enviado.
Quando este parâmetro não for enviado ou for enviado com null ou com valor 0, significa que os dados informados no parâmetro numeroDocumento serão utilizados somente para preenchimento automático no momento da assinatura como pessoa física.
Quando este parâmetro for enviado com valor 1, significa que os dados informados no parâmetro numeroDocumento serão utilizados para validação no momento da assinatura como pessoa física.
d. DescartarDadosAnteriores
Descrição: Parâmetro informando se os dados não informados no objeto signatario serão descartados.
Formato: Bit: 1 – True ou 0 - False
Requerido: Não
Os dados informados neste parâmetro serão desconsiderados quando os parâmetros nome e numeroDocumento do objeto signatario forem enviados.
Quando este parâmetro não for enviado ou for enviado com null ou com valor 0, significa que nenhum parâmetro do objeto signatario será descartado.
Quando este parâmetro for enviado com valor 1, significa que os dados não informados do objeto signatario devem ser removidos do processo.
10.2 empresa: Parâmetros para editar nome e documento da empresa que serão utilizados para preenchimento de campos na tela ou validação do documento do signatário.
Atenção: Os dados de empresa serão desconsiderados quando o signatário estiver configurado para assinar somente como pessoa física.
a. nome
Descrição: Parâmetro informando o nome da empresa que será alterado ao reenviar o processo.
Formato: Varchar(250)
Requerido: Não
b. numeroDocumento
Descrição: Parâmetro informando o documento da empresa será alterado ao reenviar o processo.
Formato: String
Requerido: Não
Validação: Quando este parâmetro NÃO for informado ou for nulo e o parâmetro DescartarDadosAnteriores for enviado com valor 1, a informação de documento será excluída do processo.
c. validarDocumento
Descrição: Parâmetro informando se o número do documento da empresa alterado no parâmetro numeroDocumento do objeto empresa será utilizado para validação ou não.
Formato: Bit: 1 – True ou 0 - False
Requerido: Não
Os dados informados neste parâmetro devem ser desconsiderados quando o parâmetro numeroDocumento objeto empresa for nulo
Quando este parâmetro não for enviado ou for enviado com null ou com valor 0, significa que os dados informados no parâmetro numeroDocumento serão utilizados somente para preenchimento automático no momento da assinatura como pessoa jurídica.
Quando este parâmetro for enviado com valor 1, significa que os dados informados no parâmetro numeroDocumento serão utilizados para validação no momento da assinatura como pessoa física.
d. DescartarDadosAnteriores
Descrição: Parâmetro informando se os dados não informados no objeto empresa serão descartados.
Formato: Bit: 1 – True ou 0 - False
Requerido: Não
Os dados informados neste parâmetro serão desconsiderados quando os parâmetros nome e numeroDocumento do objeto empresa forem enviados.
Quando este parâmetro não for enviado ou for enviado com null ou com valor 0, significa que nenhum parâmetro do objeto empresa será descartado.
Quando este parâmetro for enviado com valor 1, significa que os dados não informados do objeto empresa serão removidos do processo.
Este erro é retornado quando não for possível interpretar a requisição e/ou o servidor tenta processar a solicitação, mas algum parâmetro da solicitação não é válido, por exemplo, um recurso formatado incorretamente ou uma tentativa de requisição com dados faltantes. As informações sobre a solicitação são fornecidas no corpo da resposta e incluem um código de erro e uma mensagem de erro.
a. Item obrigatório: Esta mensagem será exibida no singular ou plural quando um ou mais itens obrigatórios não estiverem sido enviados na chamada da API: O(s) item(ns) listado(s) é(são) obrigatório(s): “nome dos itens separados por vírgula”.
b. Formato incorreto: Esta mensagem será exibida no singular ou plural quando um ou mais itens estiverem sido enviados com formato incorreto: O(s) item(ns) listado(s) está(ão) com o formato incorreto: “nome dos itens separados por vírgula”.
c. Ids inexistente: Esta mensagem será exibida no singular ou plural quando um ou mais Id enviados não existirem: O(s) id(s) listado(s) não existe(m): “nome dos itens que são Ids de tabela, separados por vírgula”.
d. Algum parâmetro está incorreto ou é inexistente: Esta mensagem será exibida quando a chamada for feita com algum parâmetro escrito errado ou quando é enviado uma informação que não existe no método: Algum parâmetro está incorreto ou é inexistente.
Este erro é retornado quando:
• A chave de autenticação da API ArqSign está incorreta ou não foi informada corretamente.
• Conta está com status diferente de Ativo.
Este erro é retornado quando o recurso solicitado ou o endpoint não foi localizado.
Este erro é retornado quando a requisição foi recebida com sucesso, porém contém parâmetros inválidos.
Este erro é retornado quando:
• Ocorre um erro interno no servidor.
• Ocorre uma falha na plataforma ArqSign.
• Formato do parâmetro incorreto.
• Formato do JSON incorreto.
Code 200 – OK
Ao executar o reenvio do processo com sucesso, o sistema retornará os dados dos participantes do processo pendentes de assinatura dos documentos.
Atenção: Mesmo que o destinatário não tenha sido informado para reenvio, os dados deste também retornará se estiver pendente de assinatura.
Por exemplo:
Em um processo que possui 3 signatários pendentes de assinatura.
Ao reenviar o processo sem editar dados, retornará os dados dos 3 signatários pendentes de assinatura.
Ao reenviar o processo editando dados de um signatário, retornará os dados dos 3 signatários pendentes de assinatura.
a. idProcessoDestinatario
A API retorna o id do processo destinatário
b. ordem
API retorna a ordem de assinatura do destinatário.
c. formaEnvioProcesso
A API retorna a forma de envio do processo para o destinatário, e-mail ou telefone do destinatário, em questão.
d. Nome
A API retorna o nome do destinatário.
e. Anexo
A API retorna as configurações de anexo do destinatário, se houver.
