Vai al contenuto

Onboarding


Questa procedura è finalizzata all'identificazione di un cliente ed emettendo un certificato di firma consentirgli di firmare un set documentale.

POST/api/v2/procedures/onboarding

Richiede autenticazione (token Bearer).

Corpo della richiesta

Content-Type: application/json · Schema: BaseOnboardingProcedureI

Campo Tipo Obbligatorio Descrizione
procedureEventSubscribers array[ProcedureEventSubscriberI] · nullable No
procedureTags array[ProcedureTagI] · nullable No
categoryId integer (int32) No
productId integer (int32) No
subProductId integer (int32) No
signers array[SignerI] · nullable No
redirectUrl string · nullable No
Esempio di richiesta
{
  "procedureEventSubscribers": [
    {
      "displayName": "string",
      "recipient": "string",
      "channel": 0
    }
  ],
  "procedureTags": [
    {
      "procedureId": 0,
      "tagKey": "string",
      "tagValue": "string"
    }
  ],
  "categoryId": 0,
  "productId": 0,
  "subProductId": 0,
  "signers": [
    {
      "name": "string",
      "surname": "string",
      "taxCode": "string",
      "email": "string",
      "phoneNumber": "string",
      "sendByEmail": true,
      "sendBySms": true,
      "birthPlace": "string",
      "birthProvince": "string",
      "birthDate": "2024-01-01T00:00:00Z",
      "gender": 0,
      "citizenship": "string",
      "signerOrder": 0,
      "forceQrCode": true,
      "identityDocuments": [
        {
          "data": {
            "id": 0,
            "docType": 1,
            "number": "string",
            "releaseDate": "2024-01-01T00:00:00Z",
            "firstReleaseDate": "2024-01-01T00:00:00Z",
            "releaseCity": "string",
            "releaseProvince": "string",
            "expiryDate": "2024-01-01T00:00:00Z",
            "releasedBy": 0,
            "icaoCode": "string",
            "polygraphicProgressiveNumber": "string",
            "flagNoExpiryDate": true,
            "order": 0
          },
          "front": {
            "content": "<base64>",
            "filename": "string",
            "mimeType": "string"
          },
          "back": {
            "content": "<base64>",
            "filename": "string",
            "mimeType": "string"
          }
        }
      ]
    }
  ],
  "redirectUrl": "string"
}

Risposte

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

Specifica OpenAPI completa

Parametri

ParametroTipoDescrizione
categoryIdintIdentificativo della categoria. Maggiori info.
productIdintIdentificativo del prodotto. Maggiori info.
subProductIdintIdentificativo del sotto prodotto. Maggiori info.
signersarrayIndica una lista di firmatari facenti parte della procedura che si vuole creare. Qui potrai trovare i campi che compongono questo modello.
redirectUrlstring( Opzionale ) Campo personalizzabile utile al redirect del soggetto della procedura di identificazione sullo specifico URL indicato.
procedureEventSubscribersarray( Opzionale ) Indica una lista di "contatti" che verranno associati alla procedura e che potranno ottenere una notifica ( per ora solo mail ) automatica al momento della creazione della procedura oppure manualmente tramite apposita API
procedureTagsarray( Opzionale ) Campi personalizzati per associare una "Tag" alla procedura che si va a creare ( possibile filtro nell'API di storico )

Warning

Nelle procedure Onboarding non è possibile identificare più utenti alla volta.