Vérification d'identité

  1. Home
  2. Bibliothèque d'API
  3. Vérification d'identité
Identification vidéo en mode automatique ou avec opérateur

La solution parfaite pour les activités de l'onboarding numérique, la vérification conforme et les processus contractuels à distance.

Toutes les connaissances dont vous avez besoin

Vous trouverez ici quelques conseils à prendre en compte pour aborder cette API. Si vous préférez, nous fournissons des exemples de code, la documentation OAS3, la possibilité d'essayer l'API en direct via Swagger UI ou d'importer l'intégralité de la collection dans Postman. Nous proposons également un environnement Sandbox où vous pouvez expérimenter toutes sortes de requêtes de manière totalement gratuite.

Conseils utiles pour commencer Vérification d'identité

Obtenir le Token dans la section appropriée avant de commencer.

Utilisez l'outil en ligne ou générez-le via l'API. Définissez la date d'expiration, un nom utile et ajoutez maintenant un ensemble d'étendues pour limiter les actions possibles que votre jeton peut effectuer.
En savoir plus sur l'API oauth Gérer mes jetons

Choisissez le type de reconnaissance vidéo et obtenez le lien

Demandez le type de reconnaissance vidéo en fonction de vos besoins :
/automatic,  /selfie,  /live,  Dans la charge utile de votre demande, remplissez les sections :
  • "user"
    Il peut être défini à NULL si l'utilisateur doit être reconnu à partir de zéro ou configuré pour une vérification d'identité, par exemple : 
                {
              "firstName": "Franco",
              "lastName": "Rossi",
              "gender": "M",
              "birthCountry": "Italie",
              "birthDate": "1977-11-06",
              "birthPlace": "Rome",
              "taxCode": "RSSMRA02D16A662G"
            }
  • "healthCard"
    Détermine s'il faut acquérir ou non les photos de la carte de santé. Si "required" est défini sur true, une vérification supplémentaire ("checkExpire") peut être activée pour vérifier l'expiration de la carte de santé acquise. Par exemple : 
    { "required": true, "checkExpire": true }
  • "phoneNumber"
    Vérifiez et/ou acquérez le numéro de téléphone de l'utilisateur certifié par un code OTP envoyé automatiquement par le système. Par exemple : 
    { "required": true, "editable": false, "number": "123456789"}
    En définissant editable sur true, il est possible de changer le numéro de téléphone pendant la reconnaissance vidéo.
  • "policy"
    À travers ce paramètre, le client spécifie le lien vers la politique de confidentialité. Ce lien sera utilisé comme lien externe sur la page d'acceptation du consentement. Par exemple : 
    { "url": "https://www.company.it/privacy-policy/" }
  • "output"
    Détermine si la documentation acquise sera rendue dans un seul fichier PDF ou si une archive contenant des fichiers graphiques individuels séparés sera renvoyée. Par exemple : 
    { "imagesAsPdf": false }
  • "layout"
    Configure l'interface de reconnaissance vidéo en personnalisant son interface utilisateur. Par exemple : 
    {
            "title": "Video ID",
            "logo": "https://www.website.it/logo.png",
            "favicon": "https://www.website.it/favicon.png",
            "backgroundColor": "#cecece",
            "textColor": "#000000",
            "footer": "Company Spa, TVA 11111111111"
          }
  • "callback"
    Configurez votre webhook pour recevoir des mises à jour asynchrones sur la procédure. Par exemple : 
    {
            "url": "https://mycallback.site/",
            "method": "POST",
            "field": "data",
            "headers": {
              "session_id": "oiwejdf89453urf945jfg"
            }
          }

Examinez la réponse

La réponse contiendra, en plus de l'état du processus et de son "id", également un "lien". Il doit être envoyé à l'utilisateur qui doit effectuer la reconnaissance vidéo. Par exemple : 
{
        "data": {
          "id": "aaaaaaaa-1111-2222-dddd-123456789",
          "link": "https://sit-openapi.certid.it/aaaaaaaa-1111-2222-dddd-12345678",
          "message": "Le lien pour le service automatisé d'identification vidéo.",
          "status": "en cours",
          "owner": "[email protected]"
        },
        "success": true,
        "message": "",
        "error": null
      }

Attendez que la reconnaissance vidéo soit terminée et obtenez le résultat

Si vous avez configuré le "callback", une fois la reconnaissance vidéo terminée, vous recevrez une demande HTTP sur votre webhook. À ce stade, si le statut "completed" est égal à "true", vous pouvez procéder au téléchargement des détails de la vérification, y compris les documents produits pendant la reconnaissance : 
{
        "_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
      }

Si vous n'avez pas configuré le "callback", vous pouvez toujours vérifier l'état de votre demande à l'endpoint : /IT-identity-verifications/{id}

Pour obtenir les détails de la procédure, effectuez un appel à : /IT-identity-verifications/{id}/{type} où {id} est l'ID de la procédure et {type} est l'une des deux options :
  • "data": renvoie des données structurées avec des informations sur le sujet reconnu : 
    {
            "firstName": "Franco",
            "lastName": "Rossi",
            "gender": "M",
            "birthCountry": "Italie",
            "birthDate": "1977-11-06",
            "birthPlace": "Rome",
            "taxCode": "RSSMRA02D16A662G",
            "documentType": "permis_de_conduire",
            "documentNumber": "1111111111",
            "documentDate": "2011-01-10",
            "documentExpiration": "2033-11-06",
            "healthCardExpiration": "2028-01-19",
            "healthCardID": "81111111111111111100"
          }
  • "archive": renvoie un paquet zip (Content Type: application/zip) contenant des fichiers liés à la procédure (vidéo si présente, images du document et du sujet)
.
API docs by Redocly

IDENTITY VERIFICATION (1.0.0)

URL: https://openapi.it/en/support License: Apache 2.0 Terms of Service

Le service de reconnaissance vidéo offre aux utilisateurs une expérience d'accueil numérique simplifiée et sécurisée. Ce processus guidé permet aux utilisateurs d'accéder à la plateforme et de s'authentifier grâce à une identification positive soutenue par un système avancé de vérification des données.

Grâce à la reconnaissance vidéo, les utilisateurs peuvent fournir les informations nécessaires à l'intégration. Le système vérifie les identités en temps réel et approuve les demandes qui répondent à des critères prédéfinis. En cas de résultats négatifs au cours du processus, le système notifie le fournisseur avec des informations détaillées sur la cause du refus, ce qui permet d'apporter des corrections ou de prendre les mesures qui s'imposent.

Pour faciliter l'intégration et la compréhension du service, un environnement sandbox est disponible pour tester les fonctionnalités de la reconnaissance vidéo. Le lien sandbox permet d'expérimenter diverses fonctionnalités et de simuler des scénarios d'identification dans un environnement contrôlé.

Ce document technique illustre le flux et les différents résultats possibles au cours du processus d'identification vidéo, y compris les scénarios tels que les identifications positives, les résultats négatifs répétables ou définitifs, et les communications correspondantes avec le système du fournisseur.

C'est la première fois que vous venez ici ? Générer un nouveau jeton d'accès

IDENTITY VERIFICATION

Liste des vérifications de vos demandes

Cette méthode affiche la liste des demandes de reconnaissance vidéo.

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
{}

Vérifier l'état

Cette méthode permet d'afficher la demande spécifique de reconnaissance vidéo afin d'en vérifier l'état.

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

Identifiant de la demande

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
{}

Pour demander les données

  • /data : Retourne un JSON avec toutes les données.
  • /archive : Renvoie un PDF ou des images des documents en fonction de la valeur "output" définie lors de la requête POST avec la valeur "output" : { 'imagesAsPdf' : false }.
Authorizations:
bearerAuth
path Parameters
id
required
string
Example: AAAAAAA-9122-4ec9-b93b-8c63a301dc79

Identifiant de la demande

type
required
string
Example: data

/data ou /archive

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
}

Reconnaissance automatique des vidéos

Ce service permet d'obtenir un lien pour accéder à une plateforme d'initiation à la reconnaissance vidéo automatique. Les utilisateurs peuvent se soumettre à la procédure de reconnaissance vidéo à tout moment, en suivant un processus défini qui comprend l'acquisition de documents, des photos du visage et une courte vidéo pour confirmer l'authenticité de la personne. La plateforme effectue des vérifications automatiques basées sur des algorithmes de reconnaissance optique de caractères, des vérifications d'authenticité et des comparaisons de visages.

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

peut être défini avec les paramètres requis pour ajouter la vérification des données, sinon il peut être laissé à l'état nul.

required
object

En utilisant ce paramètre, le client peut indiquer sa volonté d'acquérir ou non les photos de la carte de santé. Si la valeur "true" est attribuée, il sera possible d'activer un contrôle supplémentaire pour vérifier l'expiration de la carte de santé acquise. Si la valeur "required" est fixée à "true", le deuxième champ, "checkExpire", devient obligatoire.

required
object

Grâce à ce paramètre, le client peut spécifier s'il doit vérifier et/ou acquérir le numéro de téléphone de l'utilisateur certifié par un code OTP envoyé automatiquement par le système. Exemples ci-dessous :

  • Vérification et possibilité pour l'utilisateur de modifier le numéro de téléphone : "phoneNumber":{ "requis" : true "modifiable" : true "number" : "3391122334" }

  • Vérification sans possibilité pour l'utilisateur de modifier le numéro de téléphone : "phoneNumber":{ "requis" : true "modifiable" : false "number" : "3391122334" }

  • Vérification avec le numéro de téléphone saisi par l'utilisateur (sans modification par l'utilisateur) : "phoneNumber":{ "requis" : true "editable" : false "number" : null }

  • Demande sans vérification du numéro de téléphone : "phoneNumber":{ "required" : faux "modifiable" : false "number" : null }

required
object

Ce paramètre permet au client de spécifier le lien vers la politique de confidentialité. Ce lien sera utilisé comme lien externe sur la page d'acceptation du consentement.

required
object

Ce paramètre permet au client de spécifier ses préférences concernant le format des photos des documents d'identité acquises par le système.

Exemple de demande avec sortie en un seul PDF : "output" : { "imagesAsPdf" : true } csharp Copier le code Exemple de demande avec sortie dans des fichiers séparés : "output" : { "imagesAsPdf" : false }

required
object

Grâce à ce paramètre, le client peut spécifier diverses préférences utiles pour la caractérisation de la mise en page web. Les éléments suivants peuvent être spécifiés :

  • Titre : Le titre affiché sur la page web. - Logo : L'URL de l'image du logo à afficher. - Favicon : L'URL de l'image du favicon à afficher. - Couleur d'arrière-plan : la couleur d'arrière-plan préférée pour la mise en page. - Couleur du texte : couleur préférée du texte à utiliser. - Pied de page : Informations ou texte supplémentaires à afficher dans le pied de page de la mise en page.

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: Les changements d'état sont notifiés par des API d
Content type
application/json
{}

Reconnaissance vidéo du selfie

Ce service permet d'obtenir un lien pour accéder à une plateforme d'initiation à la reconnaissance vidéo automatique. L'utilisateur effectue une reconnaissance vidéo à tout moment, en suivant une procédure guidée qui comprend l'enregistrement d'une courte vidéo et la capture de documents. La validation des données saisies sera effectuée ultérieurement par des opérateurs de back-office.

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

peut être défini avec les paramètres requis pour ajouter la vérification des données, sinon il peut être laissé à l'état nul.

required
object

En utilisant ce paramètre, le client peut indiquer sa volonté d'acquérir ou non les photos de la carte de santé. Si la valeur "true" est attribuée, il sera possible d'activer un contrôle supplémentaire pour vérifier l'expiration de la carte de santé acquise. Si la valeur "required" est fixée à "true", le deuxième champ, "checkExpire", devient obligatoire.

required
object

Grâce à ce paramètre, le client peut spécifier s'il doit vérifier et/ou acquérir le numéro de téléphone de l'utilisateur certifié par un code OTP envoyé automatiquement par le système. Exemples ci-dessous :

  • Vérification et possibilité pour l'utilisateur de modifier le numéro de téléphone : "phoneNumber":{ "requis" : true "modifiable" : true "number" : "3391122334" }

  • Vérification sans possibilité pour l'utilisateur de modifier le numéro de téléphone : "phoneNumber":{ "requis" : true "modifiable" : false "number" : "3391122334" }

  • Vérification avec le numéro de téléphone saisi par l'utilisateur (sans modification par l'utilisateur) : "phoneNumber":{ "requis" : true "editable" : false "number" : null }

  • Demande sans vérification du numéro de téléphone : "phoneNumber":{ "required" : faux "modifiable" : false "number" : null }

required
object

Ce paramètre permet au client de spécifier le lien vers la politique de confidentialité. Ce lien sera utilisé comme lien externe sur la page d'acceptation du consentement.

required
object

Ce paramètre permet au client de spécifier ses préférences concernant le format des photos des documents d'identité acquises par le système.

Exemple de demande avec sortie en un seul PDF : "output" : { "imagesAsPdf" : true } csharp Copier le code Exemple de demande avec sortie dans des fichiers séparés : "output" : { "imagesAsPdf" : false }

required
object

Grâce à ce paramètre, le client peut spécifier diverses préférences utiles pour la caractérisation de la mise en page web. Les éléments suivants peuvent être spécifiés :

  • Titre : Le titre affiché sur la page web. - Logo : L'URL de l'image du logo à afficher. - Favicon : L'URL de l'image du favicon à afficher. - Couleur d'arrière-plan : la couleur d'arrière-plan préférée pour la mise en page. - Couleur du texte : couleur préférée du texte à utiliser. - Pied de page : Informations ou texte supplémentaires à afficher dans le pied de page de la mise en page.

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: Les changements d'état sont notifiés par des API d
Content type
application/json
{}

Reconnaissance vidéo en direct

Ce service permet d'obtenir un lien pour accéder à une plateforme permettant d'initier la reconnaissance automatique de vidéos. L'utilisateur est assisté en temps réel par un opérateur tout au long de la procédure de reconnaissance vidéo et de la vérification de l'exactitude des données.

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

peut être défini avec les paramètres requis pour ajouter la vérification des données, sinon il peut être laissé à l'état nul.

required
object

En utilisant ce paramètre, le client peut indiquer sa volonté d'acquérir ou non les photos de la carte de santé. Si la valeur "true" est attribuée, il sera possible d'activer un contrôle supplémentaire pour vérifier l'expiration de la carte de santé acquise. Si la valeur "required" est fixée à "true", le deuxième champ, "checkExpire", devient obligatoire.

required
object

Grâce à ce paramètre, le client peut spécifier s'il doit vérifier et/ou acquérir le numéro de téléphone de l'utilisateur certifié par un code OTP envoyé automatiquement par le système. Exemples ci-dessous :

  • Vérification et possibilité pour l'utilisateur de modifier le numéro de téléphone : "phoneNumber":{ "requis" : true "modifiable" : true "number" : "3391122334" }

  • Vérification sans possibilité pour l'utilisateur de modifier le numéro de téléphone : "phoneNumber":{ "requis" : true "modifiable" : false "number" : "3391122334" }

  • Vérification avec le numéro de téléphone saisi par l'utilisateur (sans modification par l'utilisateur) : "phoneNumber":{ "requis" : true "editable" : false "number" : null }

  • Demande sans vérification du numéro de téléphone : "phoneNumber":{ "required" : faux "modifiable" : false "number" : null }

required
object

Ce paramètre permet au client de spécifier le lien vers la politique de confidentialité. Ce lien sera utilisé comme lien externe sur la page d'acceptation du consentement.

required
object

Ce paramètre permet au client de spécifier ses préférences concernant le format des photos des documents d'identité acquises par le système.

Exemple de demande avec sortie en un seul PDF : "output" : { "imagesAsPdf" : true } csharp Copier le code Exemple de demande avec sortie dans des fichiers séparés : "output" : { "imagesAsPdf" : false }

required
object

Grâce à ce paramètre, le client peut spécifier diverses préférences utiles pour la caractérisation de la mise en page web. Les éléments suivants peuvent être spécifiés :

  • Titre : Le titre affiché sur la page web. - Logo : L'URL de l'image du logo à afficher. - Favicon : L'URL de l'image du favicon à afficher. - Couleur d'arrière-plan : la couleur d'arrière-plan préférée pour la mise en page. - Couleur du texte : couleur préférée du texte à utiliser. - Pied de page : Informations ou texte supplémentaires à afficher dans le pied de page de la mise en page.

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: Les changements d'état sont notifiés par des API d
Content type
application/json
{}
Web Service Revision: 2.0.0