Navegação

Introdução

Esta API permite realizar assinaturas digitais em documentos PDF utilizando a Chave Móvel Digital (CMD).

O processo é composto por três etapas principais: autenticação, inicialização do processo de assinatura e finalização com código OTP.

Importante

Certifique-se de ter as credenciais da API (apiKey e apiSecret) antes de começar.

Login com credenciais da API

POST https://api.digsign.wallid.io/api/auth/api-login

Request:

{
  "apiKey": "<apiKey>",
  "apiSecret": "<apiSecret>"
}

Response:

{
  "message": "Successfully logged in",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3ZDJlY2Y5NjQxY2E0Y2U0MDM0YWVjNCIsImVtYWlsIjoidml0b3IudmlhbmErMUB3YWxsaWQuaW8iLCJpYXQiOjE3NTI3MzY1OTAsImV4cCI6MTc1NzkyMDU5MH0.XZo7TLqBtcQuhJ3QYKxRlkKxy2h-uL41caUzuPm1ltw"
}

Token de Autenticação

Guarde o token da resposta. Será necessário para autenticar as próximas requisições como Bearer Token.

Iniciar processo de assinatura

POST - FormData https://api.digsign.wallid.io/api/sign/start-sign-document

Autenticação Necessária

Esta requisição requer o token obtido no login como Bearer Token no header Authorization.

Headers:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3ZDJlY2Y5NjQxY2E0Y2U0MDM0YWVjNCIsImVtYWlsIjoidml0b3IudmlhbmErMUB3YWxsaWQuaW8iLCJpYXQiOjE3NTI3MzY1OTAsImV4cCI6MTc1NzkyMDU5MH0.XZo7TLqBtcQuhJ3QYKxRlkKxy2h-uL41caUzuPm1ltw

Request Body:

{
  "pdfFile": "<pdfFile>",
  "userId": "<user phone>",
  "userPin": "<userPin>",
  "displayName": "<displayName>"
}

Exemplo:

{
  "pdfFile": "ficheiro PDF a assinar",
  "userId": "+351 933911919",
  "userPin": "0000",
  "displayName": "Nome a exibir na assinatura visual"
}

Response:

{
  "processID": "4c5fa846-f400-480c-b0e6-6093b4010c7d",
  "message": "Processo de assinatura iniciado com sucesso"
}

Process ID

Guarde o processID da resposta. Será necessário para finalizar o processo de assinatura.

Finalizar processo de assinatura

POST https://api.digsign.wallid.io/api/sign/finishDocument

Autenticação Necessária

Esta requisição requer o token obtido no login como Bearer Token no header Authorization.

Headers:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3ZDJlY2Y5NjQxY2E0Y2U0MDM0YWVjNCIsImVtYWlsIjoidml0b3IudmlhbmErMUB3YWxsaWQuaW8iLCJpYXQiOjE3NTI3MzY1OTAsImV4cCI6MTc1NzkyMDU5MH0.XZo7TLqBtcQuhJ3QYKxRlkKxy2h-uL41caUzuPm1ltw

Request Body:

{
  "processID": "<processID>",
  "otpCode": "<otpCode>"
}

Exemplo:

{
  "processID": "4c5fa846-f400-480c-b0e6-6093b4010c7d",
  "otpCode": "111111"
}

Response:

{
  "message": "Documento assinado com sucesso",
  "signedDocumentUrl": "https://api.digsign.wallid.io/documents/signed/4c5fa846-f400-480c-b0e6-6093b4010c7d.pdf",
  "status": "completed"
}

Processo Concluído

O documento foi assinado com sucesso. Use o signedDocumentUrl para fazer download do documento assinado.

Fluxo do Processo

Autenticação

Faça login com suas credenciais da API para obter o token de acesso.

Iniciar Assinatura

Envie o documento PDF e os dados do utilizador para iniciar o processo de assinatura.

Finalizar

Complete o processo com o código OTP recebido pelo utilizador.