Vai al contenuto

Controfirma


Per poter effettuare l'operazione di firma/controfirma di uno o più documenti, l'Operatore deve ricordare il proprio PIN (Solo nel caso di FEQ) oltre che richiedere un OTP (One Time Password, codice numerico di 6 cifre randomiche), per ottenerlo bisogna effettuare una chiamata alla seguente API:

POST/api/v2/otp/send

Richiede autenticazione (token Bearer).

Parametri

Nome Posizione Tipo Obbligatorio Descrizione
channel query Channel No 1 = SMS

2 = Email

Corpo della richiesta

Content-Type: application/json · Schema: SendOtpI

Campo Tipo Obbligatorio Descrizione
purpose OtpPurpose No 0 = Sign

1 = Verification
Valori: 0, 1
userId string (uuid) · nullable No
procedureId integer (int32) · nullable No
Esempio di richiesta
{
  "purpose": 0,
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "procedureId": 0
}

Risposte

Codice Descrizione
200 Success
401 Unauthorized
403 Forbidden
Risposta 200 · BooleanLsWebResponse
{
  "error": {
    "httpStatusCode": 100,
    "level": 0,
    "levelName": "string",
    "message": "string",
    "stackTrace": "string",
    "exceptionMessage": "string"
  },
  "response": {
    "level": 0,
    "levelName": "string",
    "message": "string",
    "data": true
  }
}

Specifica OpenAPI completa

Warning

ATTENZIONE:

  • L'utente dal momento della chiamata ha 90 secondi di tempo per poter effettuare la prossima chiamata API e controfirmare con successo.
  • Nel caso in cui il tempo limite non è bastato, basterà effettuare nuovamente la chiamata all'API di questa scheda, richiedendo un nuovo OTP per la procedura di controfirma.

Finalmente l'utente, nei 90 secondi successivi alla precedente chiamata, può procedere a controfirmare dalle seguenti chiamate:

Caso di procedura FEA:

POST/api/v2/signatures/fea/counterSign

Richiede autenticazione (token Bearer).

Parametri

Nome Posizione Tipo Obbligatorio Descrizione
procedureId query integer (int32) No

Corpo della richiesta

Content-Type: application/json · Schema: SignDocI

Campo Tipo Obbligatorio Descrizione
keyPin string · nullable No
otp string · nullable No
docIds array[string] · nullable No
Esempio di richiesta
{
  "keyPin": "string",
  "otp": "string",
  "docIds": [
    "string"
  ]
}

Risposte

Codice Descrizione
200 Success
401 Unauthorized
403 Forbidden
Risposta 200 · BooleanLsWebResponse
{
  "error": {
    "httpStatusCode": 100,
    "level": 0,
    "levelName": "string",
    "message": "string",
    "stackTrace": "string",
    "exceptionMessage": "string"
  },
  "response": {
    "level": 0,
    "levelName": "string",
    "message": "string",
    "data": true
  }
}

Specifica OpenAPI completa

Caso di procedura FEQ:

POST/api/v2/signatures/feq/counterSign

Richiede autenticazione (token Bearer).

Parametri

Nome Posizione Tipo Obbligatorio Descrizione
procedureId query integer (int32) No

Corpo della richiesta

Content-Type: application/json · Schema: SignDocI

Campo Tipo Obbligatorio Descrizione
keyPin string · nullable No
otp string · nullable No
docIds array[string] · nullable No
Esempio di richiesta
{
  "keyPin": "string",
  "otp": "string",
  "docIds": [
    "string"
  ]
}

Risposte

Codice Descrizione
200 Success
401 Unauthorized
403 Forbidden
Risposta 200 · BooleanLsWebResponse
{
  "error": {
    "httpStatusCode": 100,
    "level": 0,
    "levelName": "string",
    "message": "string",
    "stackTrace": "string",
    "exceptionMessage": "string"
  },
  "response": {
    "level": 0,
    "levelName": "string",
    "message": "string",
    "data": true
  }
}

Specifica OpenAPI completa

Caso di procedura FES:

POST/api/v2/signatures/fes/counterSign

Richiede autenticazione (token Bearer).

Parametri

Nome Posizione Tipo Obbligatorio Descrizione
procedureId query integer (int32) No

Corpo della richiesta

Content-Type: application/json · Schema: SignDocI

Campo Tipo Obbligatorio Descrizione
keyPin string · nullable No
otp string · nullable No
docIds array[string] · nullable No
Esempio di richiesta
{
  "keyPin": "string",
  "otp": "string",
  "docIds": [
    "string"
  ]
}

Risposte

Codice Descrizione
200 Success
401 Unauthorized
403 Forbidden
Risposta 200 · BooleanLsWebResponse
{
  "error": {
    "httpStatusCode": 100,
    "level": 0,
    "levelName": "string",
    "message": "string",
    "stackTrace": "string",
    "exceptionMessage": "string"
  },
  "response": {
    "level": 0,
    "levelName": "string",
    "message": "string",
    "data": true
  }
}

Specifica OpenAPI completa

Parametri delle chiamate /counterSign

Parametro Tipo Descrizione
keyPin string

SOLO NELLA CHIAMATA /api/v2/signatures/feq/counterSign
Il pin del certificato emesso dell'operatore che controfirma

otp string La One Time Password ricevuta dopo la apposita chiamata API
docIds string[] Gli identificativi in formato GUID resitituiti dalla chiamata API