Video-Identifikation im automatischen oder Operator-Modus

Die perfekte Lösung für digitales Onboarding, angemessene Überprüfung und Fernverträge.

Nützliche Tipps für den Einstieg Video-Identifikation

Holen Sie sich das Token im entsprechenden Abschnitt, bevor Sie beginnen.

Verwenden Sie das Online-Tool oder generieren Sie es über die API. Legen Sie das Ablaufdatum, einen nützlichen Namen fest und fügen Sie jetzt eine Vielzahl von Scopes hinzu, um die möglichen Aktionen Ihres Tokens zu begrenzen.

Wählen Sie den Typ der Videoerkennung und erhalten Sie den Link

Fordern Sie den Typ der Videoerkennung entsprechend Ihren Bedürfnissen an:
/automatic, /selfie, /live, Im Payload Ihrer Anfrage füllen Sie die Abschnitte aus:

"user"

Es kann auf NULL gesetzt werden, wenn der Benutzer von Grund auf erkannt werden soll oder für die Identitätsprüfung konfiguriert ist, zum Beispiel:

            {
              "firstName": "Franco",
              "lastName": "Rossi",
              "gender": "M",
              "birthCountry": "Italien",
              "birthDate": "1977-11-06",
              "birthPlace": "Rom",
              "taxCode": "RSSMRA02D16A662G"
            }

"healthCard"
Bestimmt, ob die Fotos der Krankenversicherungskarte erfasst werden sollen oder nicht. Wenn "required" auf true gesetzt ist, kann eine zusätzliche Überprüfung ("checkExpire") aktiviert werden, um das Ablaufdatum der erfassten Krankenversicherungskarte zu überprüfen. Zum Beispiel:
```
{ "required": true, "checkExpire": true }
```
"phoneNumber"
Überprüfen und/oder erfassen Sie die Telefonnummer des Benutzers, die durch einen automatisch gesendeten OTP-Code vom System zertifiziert ist. Zum Beispiel:
```
{ "required": true, "editable": false, "number": "123456789"}
```
Wenn editable auf true gesetzt ist, kann die Telefonnummer während der Videoerkennung geändert werden.
"policy"
Über diesen Parameter gibt der Kunde den Link zur Datenschutzrichtlinie an. Dieser Link wird als externer Link auf der Zustimmungsannahmeseite verwendet. Zum Beispiel:
```
{ "url": "https://www.company.it/privacy-policy/" }
```
"output"
Bestimmt, ob die erfasste Dokumentation in einer einzigen PDF-Datei gerendert oder ein Archiv mit einzelnen separaten Grafikdateien zurückgegeben wird. Zum Beispiel:
```
{ "imagesAsPdf": false }
```

"layout"

Konfiguriert die Benutzeroberfläche der Videoerkennung und passt sie an. Zum Beispiel:

{
            "title": "Video ID",
            "logo": "https://www.website.it/logo.png",
            "favicon": "https://www.website.it/favicon.png",
            "backgroundColor": "#cecece",
            "textColor": "#000000",
            "footer": "Company Spa, USt-IdNr. 11111111111"
          }

"callback"

Konfigurieren Sie Ihren Webhook, um asynchrone Updates zum Verfahren zu erhalten. Zum Beispiel:

{
            "url": "https://mycallback.site/",
            "method": "POST",
            "field": "data",
            "headers": {
              "session_id": "oiwejdf89453urf945jfg"
            }
          }

Überprüfen Sie die Antwort

Die Antwort enthält neben dem Status des Vorgangs und seiner "id" auch einen "Link". Dieser sollte an den Benutzer gesendet werden, der die Videoerkennung durchführen muss. Zum Beispiel:

{
        "data": {
          "id": "aaaaaaaa-1111-2222-dddd-123456789",
          "link": "https://sit-openapi.certid.it/aaaaaaaa-1111-2222-dddd-12345678",
          "message": "Der Link für den automatisierten Video Identifikationsdienst.",
          "status": "in Bearbeitung",
          "owner": "[email protected]"
        },
        "success": true,
        "message": "",
        "error": null
      }

Warten Sie, bis die Videoerkennung abgeschlossen ist, und erhalten Sie das Ergebnis

Wenn Sie das "Callback" eingerichtet haben, erhalten Sie nach Abschluss der Videoerkennung eine HTTP-Anfrage auf Ihrem Webhook. An dieser Stelle können Sie, wenn der Status "completed" gleich "true" ist, mit dem Herunterladen der Verifizierungsdetails fortfahren, einschließlich der während der Erkennung erstellten Dokumente:

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

Wenn Sie das "Callback" nicht eingerichtet haben, können Sie den Status Ihrer Anfrage trotzdem am Endpunkt überprüfen: /IT-identity-verifications/{id}

Um die Details des Verfahrens zu erhalten, rufen Sie auf: /IT-identity-verifications/{id}/{type} wobei {id} die Verfahrens-ID und {type} eine der beiden Optionen ist:

"data": gibt strukturierte Daten mit Informationen über das erkannte Subjekt zurück:

{
            "firstName": "Franco",
            "lastName": "Rossi",
            "gender": "M",
            "birthCountry": "Italien",
            "birthDate": "1977-11-06",
            "birthPlace": "Rom",
            "taxCode": "RSSMRA02D16A662G",
            "documentType": "Führerschein",
            "documentNumber": "1111111111",
            "documentDate": "2011-01-10",
            "documentExpiration": "2033-11-06",
            "healthCardExpiration": "2028-01-19",
            "healthCardID": "81111111111111111100"
          }

"archive": gibt ein Zip-Paket zurück (Content Type: application/zip) mit Dateien im Zusammenhang mit dem Verfahren (Video, falls vorhanden, Bilder des Dokuments und des Subjekts)

Oas file url https://console.openapi.com/oas/de/videoid.openapi.json
Fork or import with Postman
Production domain videoid.openapi.com
Sandbox domain test.videoid.openapi.com
Production Scopes 4
Sandbox Scopes 4
- GET test.videoid.openapi.com/IT-identity-verifications
- POST test.videoid.openapi.com/IT-selfie
- POST test.videoid.openapi.com/IT-live
- POST test.videoid.openapi.com/IT-automatic

IDENTITY VERIFICATION (1.0.0)

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

Der Videoerkennungsdienst bietet ein optimiertes und sicheres digitales Onboarding-Erlebnis für Nutzer. Dieser geführte Prozess ermöglicht es den Nutzern, auf die Plattform zuzugreifen und sich durch eine positive Identifizierung mit Hilfe eines fortschrittlichen Datenüberprüfungssystems zu authentifizieren.

Mit Hilfe von Video Recognition können die Nutzer die notwendigen Informationen für das Onboarding bereitstellen. Das System prüft die Identitäten in Echtzeit und genehmigt die Anträge, die den vordefinierten Kriterien entsprechen. Im Falle negativer Ergebnisse während des Prozesses benachrichtigt das System den Anbieter mit detaillierten Informationen über den Grund der Ablehnung und ermöglicht so Korrekturen oder geeignete Maßnahmen.

Um die Integration und das Verständnis des Dienstes zu erleichtern, steht eine sandbox-Umgebung zur Verfügung, um die Funktionalität von Video Recognition zu testen. Die Sandbox-Verbindung ermöglicht das Experimentieren mit verschiedenen Funktionen und die Simulation von Identifizierungsszenarien in einer kontrollierten Umgebung.

Dieses technische Dokument veranschaulicht den Ablauf und die verschiedenen möglichen Ergebnisse während des Videoidentifizierungsprozesses, einschließlich Szenarien wie positive Identifizierungen, wiederholbare oder endgültige negative Ergebnisse und die entsprechenden Mitteilungen an das Providersystem.

Zum ersten Mal hier? Generieren Sie ein neues Zugangstoken

IDENTITY VERIFICATION

Liste der von Ihnen angeforderten Nachweise

Diese Methode zeigt die Liste der Anfragen zur Videoerkennung an.

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

{

"data": [
- {
  - "link": "https://sit-openapi.certid.it/AAAAAAA-9122-4ec9-b93b-8c63a301dc79",
  - "status": "ok",
  - "owner": "[email protected]",
  - "creationTimestamp": 1701342095,
  - "lastUpdateTimestamp": 1701342095,
  - "id"": "AAAAAAA-9122-4ec9-b93b-8c63a301dc79"
  },
- {
  - "link": "https://sit-openapi.certid.it/bbbbbb-9122-4ec9-b93b-8c63a301dc79",
  - "status": "running",
  - "owner": "[email protected]",
  - "creationTimestamp": 1701342095,
  - "lastUpdateTimestamp": 1701342095,
  - "id"": "bbbbbb-9122-4ec9-b93b-8c63a301dc79"
  },
- {
  - "link": "https://sit-openapi.certid.it/bbbbbb-9122-4ec9-b93b-8c63a301dc79",
  - "status": "validation",
  - "owner": "[email protected]",
  - "creationTimestamp": 1701342095,
  - "lastUpdateTimestamp": 1701342095,
  - "id"": "bbbbbb-9122-4ec9-b93b-8c63a301dc79"
  }
],
"success": true,
"message": "",
"error": null

}

Status prüfen

Diese Methode zeigt Ihnen die spezifische Anfrage zur Videoerkennung an, um deren Status zu überprüfen.

Authorizations:

bearerAuth

path Parameters

required

string

Example: AAAAAAA-9122-4ec9-b93b-8c63a301dc79

Anfrage-ID

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

{

"data": {
- "link": "https://sit-openapi.certid.it/AAAAAAA-9122-4ec9-b93b-8c63a301dc79",
- "status": "ok",
- "owner": "[email protected]",
- "creationTimestamp": 1701342095,
- "lastUpdateTimestamp": 1701342095,
- "id"": "AAAAAAA-9122-4ec9-b93b-8c63a301dc79"
},
"success": true,
"message": "",
"error": null

}

So fordern Sie die Daten an

/data": Gibt ein JSON mit allen Daten zurück.
/archive: Gibt ein PDF oder Bilder der Dokumente zurück, basierend auf dem 'output'-Wert, der während der POST-Anfrage mit dem Wert 'output' festgelegt wurde: { 'imagesAsPdf': false }.

Authorizations:

bearerAuth

path Parameters

id required	string Example: AAAAAAA-9122-4ec9-b93b-8c63a301dc79 Anfrage-ID
type required	string Example: data /Daten oder /Archiv

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/%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

application/json

{

"data": {
- "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"
},
"success": true,
"message": "",
"error": null

}

Automatische Videoerkennung

Dieser Dienst ermöglicht es, einen Link zu erhalten, der den Zugang zu einer Plattform für die automatische Videoerkennung ermöglicht. Die Nutzer können das Videoerkennungsverfahren jederzeit selbständig durchführen, indem sie einem festgelegten Prozess folgen, der die Erfassung von Dokumenten, Gesichtsfotos und ein kurzes Video zur Bestätigung der Echtheit umfasst. Die Plattform führt automatische Überprüfungen auf der Grundlage von OCR-Algorithmen, Echtheitsprüfungen und Gesichtsabgleich durch.

Authorizations:

bearerAuth

Request Body schema: application/json

required	object (Callback)
mail required	string
required	string or object user kann mit den erforderlichen Parametern versehen werden, um eine Datenüberprüfung hinzuzufügen, andernfalls kann es als Null belassen werden.
required	object Mit diesem Parameter kann der Kunde angeben, ob er bereit ist, die Fotos der Gesundheitskarte zu erwerben oder nicht. Wird er auf "true" gesetzt, kann eine zusätzliche Überprüfung des Ablaufs der erworbenen Gesundheitskarte aktiviert werden. Wenn "required" auf "true" gesetzt wird, wird das zweite Feld "checkExpire" obligatorisch.
required	object Mit diesem Parameter kann der Kunde festlegen, ob die Telefonnummer des Benutzers durch einen automatisch vom System gesendeten OTP-Code verifiziert und/oder bestätigt werden soll. Beispiele unten: Verifizierung und die Möglichkeit für den Benutzer, die Telefonnummer zu bearbeiten: "phoneNumber":{ "erforderlich": wahr "editierbar": wahr "number": "3391122334" } Überprüfung ohne die Möglichkeit des Benutzers, die Rufnummer zu bearbeiten: "phoneNumber":{ "erforderlich": true "bearbeitbar": false "number": "3391122334" } Verifizierung mit vom Benutzer eingegebener Telefonnummer (ohne Benutzereingabe): "phoneNumber":{ "erforderlich": true "editierbar": false "number": null } Anfrage ohne Überprüfung der Telefonnummer: "phoneNumber":{ "erforderlich": false "editierbar": false "Nummer": null }
required	object Mit diesem Parameter gibt der Kunde den Link zur Datenschutzrichtlinie an. Dieser Link wird als externer Link auf der Seite für die Zustimmung verwendet.
required	object Mit diesem Parameter gibt der Kunde seine Präferenzen bezüglich des Formats der vom System erfassten Ausweisfotos an. Beispielanforderung mit Ausgabe in einem einzigen PDF: "output": { "imagesAsPdf": true } csharp Code kopieren Beispielanforderung mit Ausgabe in separaten Dateien: "output": { "imagesAsPdf": false }
required	object Über diesen Parameter kann der Kunde verschiedene Präferenzen angeben, die für die Charakterisierung des Weblayouts nützlich sind. Die folgenden Elemente können angegeben werden: Titel: Der Titel, der im Weblayout angezeigt wird. - Logo: Die URL des anzuzeigenden Logo-Bildes. - Favicon: Die URL des anzuzeigenden Favicon-Bildes. - Hintergrundfarbe: Die bevorzugte Hintergrundfarbe für das Layout. - Textfarbe: Die bevorzugte Textfarbe, die verwendet werden soll. - Fußzeile: Zusätzliche Informationen oder Text, der in der Fußzeile des Layouts angezeigt werden soll.

Responses

Response Schema: application/json

	object
success	boolean
message	string
error	string

Callbacks

Request samples

Content type

application/json

{

"callback": {
- "url": "https://mycallback.site/",
- "method": "POST",
- "field": "data",
- "headers": {
  - "session_id": "oiwejdf89453urf945jfg"
  },
- "mail": "[email protected]",
- "user": {
  - "firstName": "Franco",
  - "lastName": "Rossi",
  - "gender": "M",
  - "birthCountry": "Italia",
  - "birthDate": "1977-11-06",
  - "birthPlace": "Roma",
  - "taxCode": "RSSMRA02D16A662G"
  },
- "healthCard": {
  - "required": true,
  - "checkExpire": true
  },
- "phoneNumber": {
  - "required": true,
  - "editable": false,
  - "number": "123456789"
  },
- "policy": {
  - "url": "https://www.company.it/privacy-policy/"
  },
- "output": {
  - "imagesAsPdf": false
  },
- "layout": {
  - "title": "Video identificazione",
  - "logo": "https://www.website.it/logo.png",
  - "favicon": "https://www.website.it/favicon.png",
  - "backgroundColor": "#cecece",
  - "textColor": "#000000",
  - "footer": "Company Spa, P.IVA 11111111111"
  }
}

}

Response samples

Content type

application/json

{

"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

}

Callback payload samples

Callback

POST: Zustandsänderungen werden über Callback-APIs gemel

Content type

application/json

{

"data": {
- "callback": {
  - "url": "https://your_domain.it/your_callback.php",
  - "method": "JSON",
  - "headers": null,
  - "session_id": "oiwejdf89453urf945jfg",
  - "data": { }
  },
- "id": "6cae4f77-9122-4ec9-b93b-8c63a301dc79",
- "link": "https://sit-openapi.certid.it/6cae4f77-9122-4ec9-b93b-8c63a301dc79",
- "status": "validation",
- "completed": null,
- "reason": null,
- "owner": "[email protected]"
},
"success": true,
"message": "",
"error": null

}

Selfie-Videoerkennung

Dieser Dienst ermöglicht es, einen Link zu erhalten, der den Zugang zu einer Plattform für die automatische Videoerkennung ermöglicht. Der Nutzer kann jederzeit eine Videoerkennung durchführen, indem er einem geführten Verfahren folgt, das die Aufnahme eines kurzen Videos und die Erfassung von Dokumenten umfasst. Die Validierung der eingegebenen Daten wird später von Back-Office-Mitarbeitern durchgeführt.

Authorizations:

bearerAuth

Request Body schema: application/json

required	object (Callback)
mail required	string
required	string or object user kann mit den erforderlichen Parametern versehen werden, um eine Datenüberprüfung hinzuzufügen, andernfalls kann es als Null belassen werden.
required	object Mit diesem Parameter kann der Kunde angeben, ob er bereit ist, die Fotos der Gesundheitskarte zu erwerben oder nicht. Wird er auf "true" gesetzt, kann eine zusätzliche Überprüfung des Ablaufs der erworbenen Gesundheitskarte aktiviert werden. Wenn "required" auf "true" gesetzt wird, wird das zweite Feld "checkExpire" obligatorisch.
required	object Mit diesem Parameter kann der Kunde festlegen, ob die Telefonnummer des Benutzers durch einen automatisch vom System gesendeten OTP-Code verifiziert und/oder bestätigt werden soll. Beispiele unten: Verifizierung und die Möglichkeit für den Benutzer, die Telefonnummer zu bearbeiten: "phoneNumber":{ "erforderlich": wahr "editierbar": wahr "number": "3391122334" } Überprüfung ohne die Möglichkeit des Benutzers, die Rufnummer zu bearbeiten: "phoneNumber":{ "erforderlich": true "bearbeitbar": false "number": "3391122334" } Verifizierung mit vom Benutzer eingegebener Telefonnummer (ohne Benutzereingabe): "phoneNumber":{ "erforderlich": true "editierbar": false "number": null } Anfrage ohne Überprüfung der Telefonnummer: "phoneNumber":{ "erforderlich": false "editierbar": false "Nummer": null }
required	object Mit diesem Parameter gibt der Kunde den Link zur Datenschutzrichtlinie an. Dieser Link wird als externer Link auf der Seite für die Zustimmung verwendet.
required	object Mit diesem Parameter gibt der Kunde seine Präferenzen bezüglich des Formats der vom System erfassten Ausweisfotos an. Beispielanforderung mit Ausgabe in einem einzigen PDF: "output": { "imagesAsPdf": true } csharp Code kopieren Beispielanforderung mit Ausgabe in separaten Dateien: "output": { "imagesAsPdf": false }
required	object Über diesen Parameter kann der Kunde verschiedene Präferenzen angeben, die für die Charakterisierung des Weblayouts nützlich sind. Die folgenden Elemente können angegeben werden: Titel: Der Titel, der im Weblayout angezeigt wird. - Logo: Die URL des anzuzeigenden Logo-Bildes. - Favicon: Die URL des anzuzeigenden Favicon-Bildes. - Hintergrundfarbe: Die bevorzugte Hintergrundfarbe für das Layout. - Textfarbe: Die bevorzugte Textfarbe, die verwendet werden soll. - Fußzeile: Zusätzliche Informationen oder Text, der in der Fußzeile des Layouts angezeigt werden soll.

Responses

Response Schema: application/json

	object
success	boolean
message	string
error	string

Callbacks

Request samples

Content type

application/json

{

"callback": {
- "url": "https://mycallback.site/",
- "method": "POST",
- "field": "data",
- "headers": {
  - "session_id": "oiwejdf89453urf945jfg"
  },
- "mail": "[email protected]",
- "user": {
  - "firstName": "Franco",
  - "lastName": "Rossi",
  - "gender": "M",
  - "birthCountry": "Italia",
  - "birthDate": "1977-11-06",
  - "birthPlace": "Roma",
  - "taxCode": "RSSMRA02D16A662G"
  },
- "healthCard": {
  - "required": true,
  - "checkExpire": true
  },
- "phoneNumber": {
  - "required": true,
  - "editable": false,
  - "number": "123456789"
  },
- "policy": {
  - "url": "https://www.company.it/privacy-policy/"
  },
- "output": {
  - "imagesAsPdf": false
  },
- "layout": {
  - "title": "Video identificazione",
  - "logo": "https://www.website.it/logo.png",
  - "favicon": "https://www.website.it/favicon.png",
  - "backgroundColor": "#cecece",
  - "textColor": "#000000",
  - "footer": "Company Spa, P.IVA 11111111111"
  }
}

}

Response samples

Content type

application/json

{

"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

}

Callback payload samples

Callback

POST: Zustandsänderungen werden über Callback-APIs gemel

Content type

application/json

{

"data": {
- "callback": {
  - "url": "https://your_domain.it/your_callback.php",
  - "method": "JSON",
  - "headers": null,
  - "session_id": "oiwejdf89453urf945jfg",
  - "data": { }
  },
- "id": "6cae4f77-9122-4ec9-b93b-8c63a301dc79",
- "link": "https://sit-openapi.certid.it/6cae4f77-9122-4ec9-b93b-8c63a301dc79",
- "status": "validation",
- "completed": null,
- "reason": null,
- "owner": "[email protected]"
},
"success": true,
"message": "",
"error": null

}

Live-Videoerkennung

Dieser Dienst ermöglicht es, einen Link zu erhalten, der den Zugang zu einer Plattform für die automatische Videoerkennung ermöglicht. Der Nutzer wird während des gesamten Videoerkennungsverfahrens und der Überprüfung der Datengenauigkeit in Echtzeit von einem Operator unterstützt.

Authorizations:

bearerAuth

Request Body schema: application/json

required	object (Callback)
mail required	string
required	string or object user kann mit den erforderlichen Parametern versehen werden, um eine Datenüberprüfung hinzuzufügen, andernfalls kann es als Null belassen werden.
required	object Mit diesem Parameter kann der Kunde angeben, ob er bereit ist, die Fotos der Gesundheitskarte zu erwerben oder nicht. Wird er auf "true" gesetzt, kann eine zusätzliche Überprüfung des Ablaufs der erworbenen Gesundheitskarte aktiviert werden. Wenn "required" auf "true" gesetzt wird, wird das zweite Feld "checkExpire" obligatorisch.
required	object Mit diesem Parameter kann der Kunde festlegen, ob die Telefonnummer des Benutzers durch einen automatisch vom System gesendeten OTP-Code verifiziert und/oder bestätigt werden soll. Beispiele unten: Verifizierung und die Möglichkeit für den Benutzer, die Telefonnummer zu bearbeiten: "phoneNumber":{ "erforderlich": wahr "editierbar": wahr "number": "3391122334" } Überprüfung ohne die Möglichkeit des Benutzers, die Rufnummer zu bearbeiten: "phoneNumber":{ "erforderlich": true "bearbeitbar": false "number": "3391122334" } Verifizierung mit vom Benutzer eingegebener Telefonnummer (ohne Benutzereingabe): "phoneNumber":{ "erforderlich": true "editierbar": false "number": null } Anfrage ohne Überprüfung der Telefonnummer: "phoneNumber":{ "erforderlich": false "editierbar": false "Nummer": null }
required	object Mit diesem Parameter gibt der Kunde den Link zur Datenschutzrichtlinie an. Dieser Link wird als externer Link auf der Seite für die Zustimmung verwendet.
required	object Mit diesem Parameter gibt der Kunde seine Präferenzen bezüglich des Formats der vom System erfassten Ausweisfotos an. Beispielanforderung mit Ausgabe in einem einzigen PDF: "output": { "imagesAsPdf": true } csharp Code kopieren Beispielanforderung mit Ausgabe in separaten Dateien: "output": { "imagesAsPdf": false }
required	object Über diesen Parameter kann der Kunde verschiedene Präferenzen angeben, die für die Charakterisierung des Weblayouts nützlich sind. Die folgenden Elemente können angegeben werden: Titel: Der Titel, der im Weblayout angezeigt wird. - Logo: Die URL des anzuzeigenden Logo-Bildes. - Favicon: Die URL des anzuzeigenden Favicon-Bildes. - Hintergrundfarbe: Die bevorzugte Hintergrundfarbe für das Layout. - Textfarbe: Die bevorzugte Textfarbe, die verwendet werden soll. - Fußzeile: Zusätzliche Informationen oder Text, der in der Fußzeile des Layouts angezeigt werden soll.

Responses

Response Schema: application/json

	object
success	boolean
message	string
error	string

Callbacks

Request samples

Content type

application/json

{

"callback": {
- "url": "https://mycallback.site/",
- "method": "POST",
- "field": "data",
- "headers": {
  - "session_id": "oiwejdf89453urf945jfg"
  },
- "mail": "[email protected]",
- "user": {
  - "firstName": "Franco",
  - "lastName": "Rossi",
  - "gender": "M",
  - "birthCountry": "Italia",
  - "birthDate": "1977-11-06",
  - "birthPlace": "Roma",
  - "taxCode": "RSSMRA02D16A662G"
  },
- "healthCard": {
  - "required": true,
  - "checkExpire": true
  },
- "phoneNumber": {
  - "required": true,
  - "editable": false,
  - "number": "123456789"
  },
- "policy": {
  - "url": "https://www.company.it/privacy-policy/"
  },
- "output": {
  - "imagesAsPdf": false
  },
- "layout": {
  - "title": "Video identificazione",
  - "logo": "https://www.website.it/logo.png",
  - "favicon": "https://www.website.it/favicon.png",
  - "backgroundColor": "#cecece",
  - "textColor": "#000000",
  - "footer": "Company Spa, P.IVA 11111111111"
  }
}

}

Response samples

Content type

application/json

{

"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

}

Callback payload samples

Callback

POST: Zustandsänderungen werden über Callback-APIs gemel

Content type

application/json

{

"data": {
- "callback": {
  - "url": "https://your_domain.it/your_callback.php",
  - "method": "JSON",
  - "headers": null,
  - "session_id": "oiwejdf89453urf945jfg",
  - "data": { }
  },
- "id": "6cae4f77-9122-4ec9-b93b-8c63a301dc79",
- "link": "https://sit-openapi.certid.it/6cae4f77-9122-4ec9-b93b-8c63a301dc79",
- "status": "validation",
- "completed": null,
- "reason": null,
- "owner": "[email protected]"
},
"success": true,
"message": "",
"error": null

}

Web Service Revision: 2.0.0

Video-Identifikation

Video-Identifikation im automatischen oder Operator-Modus

All das Wissen, das Sie benötigen

Holen Sie sich das Token im entsprechenden Abschnitt, bevor Sie beginnen.

Wählen Sie den Typ der Videoerkennung und erhalten Sie den Link

"user"

"healthCard"

"phoneNumber"

"policy"

"output"

"layout"

"callback"

Überprüfen Sie die Antwort

Warten Sie, bis die Videoerkennung abgeschlossen ist, und erhalten Sie das Ergebnis

IDENTITY VERIFICATION (1.0.0)

IDENTITY VERIFICATION

Liste der von Ihnen angeforderten Nachweise

Authorizations:

Responses

Response Schema: application/json

Request samples

Response samples

Status prüfen

Authorizations:

path Parameters

Responses

Response Schema: application/json

Request samples

Response samples

So fordern Sie die Daten an

Authorizations:

path Parameters

Responses

Response Schema: application/jsonapplication/zipapplication/json

Request samples

Response samples

Automatische Videoerkennung

Authorizations:

Request Body schema: application/json

Responses

Response Schema: application/json

Callbacks

Request samples

Response samples

Callback payload samples

Selfie-Videoerkennung

Authorizations:

Request Body schema: application/json

Responses

Response Schema: application/json

Callbacks

Request samples

Response samples

Callback payload samples

Live-Videoerkennung

Authorizations:

Request Body schema: application/json

Responses

Response Schema: application/json

Callbacks

Request samples

Response samples

Callback payload samples

Response Schema:
application/json