Verifica Identità

Video Identificazione in modalità Automatica o con Operatore

La soluzione perfetta per l'attività di digital onboarding, adeguata verifica e per contrattualistica a distanza

Tutte le informazioni di cui hai bisogno

Qui trovi qualche consiglio da prendere in considerazione per approcciare a questa API. Se preferisci forniamo esempi di codice, documentazione in OAS3, la possibilità di provare l'API dal vivo con la Swagger UI oppure importare l'intera collezione in Postman. Offriamo inoltre un ambiente di Sandbox dove puoi sperimentare tutte le API gratuitamente.

Utili consigli per iniziare con Verifica Identità

Prendi il token nell'apposita sezione prima di cominciare.

Usa lo strumento online o generalo via API. Imposta una data di scadenza e aggiungi una serie di Scopes per limitare le possibli azioni permesse al token.

Scegli il tipo di video riconoscimento ed ottieni il link

Richiedi il tipo di videoriconoscimento in base alle tue esigenze:
/automatic/selfie/live,  Nel payload della tua richiesta compila le sezioni:
  • "user"
    Può essere impostato a NULL se l'utente va riconosciuto da zero o configurato per effettuare una verifica di identità es:
                      {
                        "firstName": "Franco",
                        "lastName": "Rossi",
                        "gender": "M",
                        "birthCountry": "Italia",
                        "birthDate": "1977-11-06",
                        "birthPlace": "Roma",
                        "taxCode": "RSSMRA02D16A662G"
                      }
                    
  • "healthCard"
    Determina se acquisire o meno le foto della tessera sanitaria. Se "required" è impostato a true, sarà possibile attivare un ulteriore controllo ("checkExpire") per verificare la scadenza della tessera sanitaria acquisita. es:
    { "required": true, "checkExpire": true }
  • "phoneNumber"
    Verifica e/o acquisisci il numero di telefono dell'utente certificato da un codice OTP inviato automaticamente dal sistema. es:
    { "required": true, "editable": false, "number": "123456789"}
    impostando editable a true sarà possibile cambiare il numero di telefono in fase di videoriconoscimento
  • "policy"
    Attraverso questo parametro, il cliente specifica il link all'informativa sulla privacy. Questo link verrà utilizzato come collegamento esterno nella pagina di accettazione del consenso. es:
    { "url": "https://www.company.it/privacy-policy/" }
  • "output"
    Determina se la documentazione acquisita sarà renderizzata in un unico file pdf o verrà ritornato un archivio contenente i singoli file grafici separati. es:
    { "imagesAsPdf": false }
  • "layout"
    Configura l'interfaccia di videoriconscimento personalizzandone la UI. es:
    {
                        "title": "Video ID",
                        "logo": "https://www.website.it/logo.png",
                        "favicon": "https://www.website.it/favicon.png",
                        "backgroundColor": "#cecece",
                        "textColor": "#000000",
                        "footer": "Company Spa, P.IVA 11111111111"
                      }
  • "callback"
    Configura un tuo webhook per ricevere aggiornamenti asincroni sulla procedura. es:
    {
                        "url": "https://mycallback.site/",
                        "method": "POST",
                        "field": "data",
                        "headers": {
                          "session_id": "oiwejdf89453urf945jfg"
                        }
                      }

Esamina la risposta

La risposta conterrà oltre allo stato della pratica ed il suo "id" anche un "link". Esso va inviato all'utente che deve effettuare il video riconoscimento. es:
{
              "data": {
                "id": "aaaaaaaa-1111-2222-dddd-123456789",
                "link": "https://sit-openapi.certid.it/aaaaaaaa-1111-2222-dddd-12345678",
                "message": "The link for the automated Video Identification service.",
                "status": "running",
                "owner": "[email protected]"
              },
              "success": true,
              "message": "",
              "error": null
            }

Attendi che il video riconoscimento sia completo e ottieni il risultato

Se hai impostato la "callback", una volta completato il video riconoscimento riceverai una richiesta http sul tuo webhook, a questo punto se lo stato "completed" è uguale a "true" puoi procedere a scaricare il dettaglio della verifica compresi i documenti prodotti durante il riconoscimento:
{
        "_id": "28b3a20e-ffcc-4245-843a-563e9ff5f31b",
        "callback": {
          "url": "https://webhook.site/ab91d3f3-c246-498a-9af5-828bf13dd8ef",
          "method": "POST",
          "field": "data",
          "headers": {
            "session_id": "oiwejdf89453urf945jfg"
          },
          "data": {}
        },
        "link": "https://openapi.certid.it/28b3a20e-ffcc-4245-843a-563ddff5f31b",
        "status": "ok",
        "completed": true,
        "owner": "[email protected]",
        "creationTimestamp": 1706283108,
        "lastUpdateTimestamp": 1706283108,
        "reason": null
      }

Se non hai impostato impostato la "callback" potrai comunque controllare lo stato della tua richiesta all'endpoint: /IT-identity-verifications/{id}

Per ottenere il dettaglio della procedura basta effettuare una chiamata a: /IT-identity-verifications/{id}/{type} dove {id} è l'id della procedura e {type} è una delle due opzioni:
  • "data": che ritorna il dato strutturato con le informazioni riguardanti il soggetto riconosciuto:
    {
              "firstName": "Franco",
              "lastName": "Rossi",
              "gender": "M",
              "birthCountry": "Italia",
              "birthDate": "1977-11-06",
              "birthPlace": "Roma",
              "taxCode": "RSSMRA02D16A662G",
              "documentType": "drive_license",
              "documentNumber": "1111111111",
              "documentDate": "2011-01-10",
              "documentExpiration": "2033-11-06",
              "healthCardExpiration": "2028-01-19",
              "healthCardID": "81111111111111111100"
            }
  • "archive": che ritorna un pacchetto zip (Content Type: application/zip) contenente i file relativi alla procedura: (video se presente, immagini del documento e del soggetto)
.

IDENTITY VERIFICATION (1.0.0)

Il servizio di Video Recognition offre agli utenti un'esperienza di onboarding digitale snella e sicura. Questo processo guidato consente agli utenti di accedere e autenticarsi sulla piattaforma attraverso un'identificazione positiva supportata da un sistema avanzato di verifica dei dati.

Attraverso la Video Recognition, gli utenti possono fornire le informazioni necessarie per l'onboarding. Il sistema verifica le identità in tempo reale, approvando le richieste che soddisfano criteri predefiniti. In caso di esito negativo durante il processo, il sistema notifica al fornitore informazioni dettagliate sulla causa del rifiuto, consentendo correzioni o azioni appropriate.

Per facilitare l'integrazione e la comprensione del servizio, è disponibile un ambiente sandbox per testare le funzionalità del Video Recognition. Il collegamento al sandbox permette di sperimentare varie caratteristiche e di simulare scenari di identificazione in un ambiente controllato.

Il presente documento tecnico illustra il flusso e i diversi risultati possibili durante il processo di identificazione video, compresi scenari quali identificazioni positive, esiti negativi ripetibili o definitivi e le relative comunicazioni al sistema del fornitore.

IDENTITY VERIFICATION

Elenco delle vostre richieste di verifica

Questo metodo mostra l'elenco delle richieste fatte per il riconoscimento video.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects (SuccessResponse)
success
boolean
message
string
error
integer

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://videoid.openapi.com/IT-identity-verifications");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{}

Controllare lo stato

Questo metodo mostra la richiesta specifica di riconoscimento video per verificarne lo stato.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: AAAAAAA-9122-4ec9-b93b-8c63a301dc79

Id della richiesta

Responses

Response Schema: application/json
object (SuccessResponse)
success
boolean
message
string
error
integer

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://videoid.openapi.com/IT-identity-verifications/%7Bid%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
application/json
{}

Per richiedere i dati

  • /dati: Restituisce un JSON con tutti i dati.
  • /archivio: Restituisce un PDF o le immagini dei documenti in base al valore 'output' impostato durante la richiesta POST con il valore 'output': {"imagesAsPdf": false }.
Authorizations:
bearerAuth
path Parameters
id
required
string
Example: AAAAAAA-9122-4ec9-b93b-8c63a301dc79

Id della richiesta

type
required
string
Example: data

/dati o /archivio

Responses

Response Schema:
object (SuccessResponse)
success
boolean
message
string
error
integer

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://videoid.openapi.com/IT-identity-verifications/%7Bid%7D/%7Btype%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

Content type
{
  • "data": {
    },
  • "success": true,
  • "message": "",
  • "error": null
}

Riconoscimento video automatico

Questo servizio consente di ottenere un link per accedere a una piattaforma per avviare il riconoscimento video automatico. Gli utenti si sottopongono autonomamente alla procedura di riconoscimento video in qualsiasi momento, seguendo un processo definito che prevede l'acquisizione di documenti, foto del volto e un breve video di conferma della presenza. La piattaforma esegue controlli automatici basati su algoritmi di OCR, verifica della veridicità e matching dei volti.

Authorizations:
bearerAuth
Request Body schema: application/json
required
object (Callback)
mail
required
string
required
string or object

può essere impostato con i parametri richiesti per aggiungere la verifica dei dati, altrimenti può essere lasciato nullo.

required
object

Tramite questo parametro, il cliente può indicare la volontà di acquisire o meno le foto della tessera sanitaria. Se impostato a true, sarà possibile attivare un ulteriore controllo per verificare la scadenza della tessera sanitaria acquisita. Se "required" è impostato a true, il secondo campo, "checkExpire", diventa obbligatorio.

required
object

Attraverso questo parametro, il client può specificare se verificare e/o acquisire il numero di telefono dell'utente certificato da un codice OTP inviato automaticamente dal sistema. Esempi di seguito:

  • Verifica e possibilità per l'utente di modificare il numero di telefono: "numero di telefono":{ "richiesto": vero "modificabile": true "numero": "3391122334" }

  • Verifica senza la possibilità per l'utente di modificare il numero di telefono: "phoneNumber":{ "obbligatorio": true "editabile": false "numero": "3391122334" }

  • Verifica con numero di telefono inserito dall'utente (senza modifica da parte dell'utente): "phoneNumber":{ "richiesto": true "editabile": false "number": null }

  • Richiesta senza verifica del numero di telefono: "phoneNumber":{ "required": false "editabile": false "number": null }

required
object

Attraverso questo parametro, il cliente specifica il link all'informativa sulla privacy. Questo link verrà utilizzato come collegamento esterno nella pagina di accettazione del consenso.

required
object

Attraverso questo parametro, il cliente specifica le proprie preferenze in merito al formato delle foto del documento d'identità acquisite dal sistema.

Esempio di richiesta con output in un unico PDF: "output": {"imagesAsPdf": true } csharp Codice di copia Esempio di richiesta con output in file separati: "output": { "imagesAsPdf": false }

required
object

Attraverso questo parametro, il cliente può specificare varie preferenze utili per la caratterizzazione del layout web. È possibile specificare i seguenti elementi:

  • Titolo: Il titolo visualizzato nel layout web. - Logo: L'URL dell'immagine del logo da visualizzare. - Favicon: L'URL dell'immagine favicon da visualizzare. - Colore di sfondo: il colore di sfondo preferito per il layout. - Colore del testo: il colore del testo da utilizzare. - Piè di pagina: Informazioni o testo aggiuntivo da visualizzare nel piè di pagina del layout.

Responses

Response Schema: application/json
object
success
boolean
message
string
error
string

Callbacks

Request samples

Content type
application/json
{
  • "callback": {
    }
}

Response samples

Content type
application/json
{}

Callback payload samples

Callback
POST: I cambiamenti di stato vengono notificati tramite
Content type
application/json
{}

Riconoscimento video selfie

Questo servizio consente di ottenere un link per accedere a una piattaforma per avviare il riconoscimento video automatico. L'utente esegue il riconoscimento video in qualsiasi momento, seguendo una procedura guidata che prevede la registrazione di un breve video e l'acquisizione di documenti. La validazione dei dati inseriti sarà effettuata successivamente da operatori di back office.

Authorizations:
bearerAuth
Request Body schema: application/json
required
object (Callback)
mail
required
string
required
string or object

può essere impostato con i parametri richiesti per aggiungere la verifica dei dati, altrimenti può essere lasciato nullo.

required
object

Tramite questo parametro, il cliente può indicare la volontà di acquisire o meno le foto della tessera sanitaria. Se impostato a true, sarà possibile attivare un ulteriore controllo per verificare la scadenza della tessera sanitaria acquisita. Se "required" è impostato a true, il secondo campo, "checkExpire", diventa obbligatorio.

required
object

Attraverso questo parametro, il client può specificare se verificare e/o acquisire il numero di telefono dell'utente certificato da un codice OTP inviato automaticamente dal sistema. Esempi di seguito:

  • Verifica e possibilità per l'utente di modificare il numero di telefono: "numero di telefono":{ "richiesto": vero "modificabile": true "numero": "3391122334" }

  • Verifica senza la possibilità per l'utente di modificare il numero di telefono: "phoneNumber":{ "obbligatorio": true "editabile": false "numero": "3391122334" }

  • Verifica con numero di telefono inserito dall'utente (senza modifica da parte dell'utente): "phoneNumber":{ "richiesto": true "editabile": false "number": null }

  • Richiesta senza verifica del numero di telefono: "phoneNumber":{ "required": false "editabile": false "number": null }

required
object

Attraverso questo parametro, il cliente specifica il link all'informativa sulla privacy. Questo link verrà utilizzato come collegamento esterno nella pagina di accettazione del consenso.

required
object

Attraverso questo parametro, il cliente specifica le proprie preferenze in merito al formato delle foto del documento d'identità acquisite dal sistema.

Esempio di richiesta con output in un unico PDF: "output": {"imagesAsPdf": true } csharp Codice di copia Esempio di richiesta con output in file separati: "output": { "imagesAsPdf": false }

required
object

Attraverso questo parametro, il cliente può specificare varie preferenze utili per la caratterizzazione del layout web. È possibile specificare i seguenti elementi:

  • Titolo: Il titolo visualizzato nel layout web. - Logo: L'URL dell'immagine del logo da visualizzare. - Favicon: L'URL dell'immagine favicon da visualizzare. - Colore di sfondo: il colore di sfondo preferito per il layout. - Colore del testo: il colore del testo da utilizzare. - Piè di pagina: Informazioni o testo aggiuntivo da visualizzare nel piè di pagina del layout.

Responses

Response Schema: application/json
object
success
boolean
message
string
error
string

Callbacks

Request samples

Content type
application/json
{
  • "callback": {
    }
}

Response samples

Content type
application/json
{}

Callback payload samples

Callback
POST: I cambiamenti di stato vengono notificati tramite
Content type
application/json
{}

Riconoscimento video in tempo reale

Questo servizio consente di ottenere un link per accedere a una piattaforma per avviare il riconoscimento automatico dei video. L'utente è supportato in tempo reale da un operatore durante tutta la procedura di riconoscimento video e la verifica dell'accuratezza dei dati.

Authorizations:
bearerAuth
Request Body schema: application/json
required
object (Callback)
mail
required
string
required
string or object

può essere impostato con i parametri richiesti per aggiungere la verifica dei dati, altrimenti può essere lasciato nullo.

required
object

Tramite questo parametro, il cliente può indicare la volontà di acquisire o meno le foto della tessera sanitaria. Se impostato a true, sarà possibile attivare un ulteriore controllo per verificare la scadenza della tessera sanitaria acquisita. Se "required" è impostato a true, il secondo campo, "checkExpire", diventa obbligatorio.

required
object

Attraverso questo parametro, il client può specificare se verificare e/o acquisire il numero di telefono dell'utente certificato da un codice OTP inviato automaticamente dal sistema. Esempi di seguito:

  • Verifica e possibilità per l'utente di modificare il numero di telefono: "numero di telefono":{ "richiesto": vero "modificabile": true "numero": "3391122334" }

  • Verifica senza la possibilità per l'utente di modificare il numero di telefono: "phoneNumber":{ "obbligatorio": true "editabile": false "numero": "3391122334" }

  • Verifica con numero di telefono inserito dall'utente (senza modifica da parte dell'utente): "phoneNumber":{ "richiesto": true "editabile": false "number": null }

  • Richiesta senza verifica del numero di telefono: "phoneNumber":{ "required": false "editabile": false "number": null }

required
object

Attraverso questo parametro, il cliente specifica il link all'informativa sulla privacy. Questo link verrà utilizzato come collegamento esterno nella pagina di accettazione del consenso.

required
object

Attraverso questo parametro, il cliente specifica le proprie preferenze in merito al formato delle foto del documento d'identità acquisite dal sistema.

Esempio di richiesta con output in un unico PDF: "output": {"imagesAsPdf": true } csharp Codice di copia Esempio di richiesta con output in file separati: "output": { "imagesAsPdf": false }

required
object

Attraverso questo parametro, il cliente può specificare varie preferenze utili per la caratterizzazione del layout web. È possibile specificare i seguenti elementi:

  • Titolo: Il titolo visualizzato nel layout web. - Logo: L'URL dell'immagine del logo da visualizzare. - Favicon: L'URL dell'immagine favicon da visualizzare. - Colore di sfondo: il colore di sfondo preferito per il layout. - Colore del testo: il colore del testo da utilizzare. - Piè di pagina: Informazioni o testo aggiuntivo da visualizzare nel piè di pagina del layout.

Responses

Response Schema: application/json
object
success
boolean
message
string
error
string

Callbacks

Request samples

Content type
application/json
{
  • "callback": {
    }
}

Response samples

Content type
application/json
{}

Callback payload samples

Callback
POST: I cambiamenti di stato vengono notificati tramite
Content type
application/json
{}