✔️PATCH/api/v1/processo/{idProcesso}/reenviar-processo
PreviousGET/api/v1/processo/{idprocesso}/dados-signatariosNextPATCH/api/v1/processo/{idProcesso}/cancelar-processo
Last updated
Last updated
O objetivo deste método é permitir que o usuário reenvie o processo para os destinatários pendentes de assinaturas na ordem atual.
O usuário poderá informar para qual destinatário pendente de assinatura deseja reenviar o documento. Caso não informe os destinatários, o serviço reenvia o processo para todos os destinatários participantes do processo com ação de assinar eletronicamente e que estejam pendentes de assinaturas na ordem atual.
Além disso, o usuário poderá editar os destinatários pendentes de assinatura para os quais deseja reenviar o processo.
Neste método o usuário irá nos enviar o ID do Processo, e nós reenviaremos para os destinatários pendentes de assinatura na ordem de assinatura atual, conforme dados informados no JSON.
Geral: Os parâmetros não obrigatórios listados abaixo devem constar no JSON, e caso não seja necessário para o documento, enviar com o valor null na frente:
-> Ref. 03: “Destinatarios” - Caso não informe os destinatários, o serviço reenvia o processo para todos os destinatários participantes do processo com ação de assinar online e que estejam pendentes de assinaturas na ordem atual.
-> Ref. 03.02 “idFormaEnvioProcesso” - é possível alterar a forma de entrega do documento, mas não é obrigatório.
-> Ref. 03.03 “nome”
-> Ref. 03.06 “idMeioEnvioCodigoSeguranca” - é possível alterar a forma de entrega tanto do código de segurança, mas não é obrigatório.
Não é permitido inserir código de segurança para destinatários que não possuem essa configuração. É permitido apenas alterar a forma de entrega do código de segurança para os destinatários que já possuem essa configuração.
-> Ref. 03.09 “permitirReenviarCodigo”
Ref. 01: “AppKey” é a chave de autorização para se autenticar na API. Esta chave deve ser válida e estar vinculada a uma conta ArqSign ativa.
Ref. 02: “idProcesso” - Para reenviar o processo, deve ser enviado como parâmetro o Id do Processo de assinatura na plataforma ArqSign. Este ID a API devolve como retorno de sucesso, após a chamada do método: POST/api/v1/processo/enviar-documento-para-assinar. Outra forma de obter o ID do processo e por meio da plataforma ArqSign, na opção “Histórico” do documento disponível nas caixas de Entrada, Enviados e Excluídos.
Ref. 03: “Destinatarios” - nesta parte do JSON devem ser definidos os destinatários, os quais serão reenviado o documento, podendo ser alterados ou não.
Ref. 03.01: “idProcessoDestinatario” - neste campo deve ser enviado o Id do destinatário que será reenviado o documento.
Ref. 03.04: “email” - quando no JSON, o campo “idFormaEnvio” estiver com o valor 1 = E-mail, é necessário enviar neste campo a informação do email que o destinatário recebeu o documento ou o novo email será reenviado o documento .
Ref. 03.05: “telefone” - quando no JSON, o campo “idFormaEnvio” estiver com o valor 2 = WhatsApp, é necessário enviar neste campo a informação do telefone que o destinatário recebeu o documento ou o novo telefone será reenviado o documento .
Ref. 03.07: “emailSeguranca” - quando no JSON, o campo “idMeioEnvioCodigoSeguranca” estiver com o valor 3 = Email, é necessário enviar neste campo a informação do e-mail que o destinatário recebeu o documento ou o novo e-mail será reenviado o documento .
Ref. 03.08: “telefoneSeguranca” quando no JSON, o campo “idMeioEnvioCodigoSeguranca” estiver com o valor 1 = SMS ou 2 = WhatsApp, é necessário enviar neste campo a informação do telefone que o destinatário recebeu o documento ou o novo telefone será reenviado o documento.
Ref. 01 - Código 200: Como retorno de sucesso, a aplicação retornará o código 200 juntamente com a mensagem de documento reenviado com sucesso.
Ref. 02 - Código 400: Mensagem de item obrigatório: Esta mensagem será exibida no singular ou plural quando um ou mais itens obrigatórios não tiver sido enviado na chamada da API.
Ref. 03 - Código 400: Mensagem de formato incorreto: Esta mensagem será exibida no singular ou plural quando um ou mais itens estiverem sido enviados com formato incorreto.
Ref. 04 - Código 400: Mensagem de Ids inexistentes: Esta mensagem será exibida no singular ou plural quando um ou mais Id enviado não existir.
Ref. 05 - Código 400: Mensagem de parâmetro está incorreto ou é inexistente: Quando a chamada é feita com algum parâmetro escrito errado ou parâmetro que não existe no método.
Ref. 07 - Código 401: Mensagem de usuário da API não autorizado: AppKey inválida ou não localizada.
