✔️GET/api/v1/processo/{idprocesso}/dados-signatarios

Requisição

Clique na imagem para ampliar.

Detalhamento do Header e Parameters

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 se obter o status do 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.

---

Retorno

Clique na imagem para ampliar.

Detalhamento do Retorno

Ref. 01 - Código 200: Como retorno de sucesso, a aplicação retornará o código 200 juntamente com os dados dos signatários do processo no formato JSON.

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 documento excluído: Esta mensagem será exibida quando o processo em questão tiver sido excluído logicamente.

Ref. 06 - 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.

Exemplo de JSON de Retorno

Exemplo Body

{
    "nomeProcesso": "string",
    "status": "string",
    "dataExpiracao": "datetime",
    "signatarios": [
        {
                           "ordem":"tinyint",
            "IdProcessoDestinatario": "guid",
            "nome": "string",
            "idTipoAssinatura":"tinyint",
            "IdFormaEnvioProcesso":"bit",
            "email": "string",
            "telefone": "string",
            "tipoAcao": "string",
            "IdMeioEnvioCodigoSeguranca": "bit",
            "emailSeguranca": "string",
            "telefoneSeguranca": "string",
            "permitirReenviarCodigo": "bit",
            "falhaEnvio": "string",
            "assinado": " bit"
        }
    ]
}