Documentazione per l'integrazione dell'API di verifica della foto del documento d'identità

​

Processo di richiesta

📘 Documentazione completa: API di verifica della foto del documento d’identità →

​

Utilizzo di base

• accept: il formato di risposta desiderato, qui impostato su application/json, ovvero formato JSON.
• authorization: la chiave per chiamare l’API, che può essere selezionata direttamente dopo la richiesta.

• image_url: il link dell’immagine del documento d’identità da elaborare.
• config: opzioni di configurazione facoltative, campo booleano, di default tutte impostate su false, supporta copy_warn, border_check_warn, reshoot_warn, detect_ps_warn, temp_id_warn, quality (soglia 0-100).

{
  "sim": 99.76,
  "result": "Success",
  "description": "Successo",
  "name": "Nome sul documento d'identità",
  "sex": "Sesso sul documento d'identità",
  "nation": "Nazionalità sul documento d'identità",
  "birth": "Data di nascita sul documento d'identità",
  "address": "Indirizzo di residenza sul documento d'identità",
  "id_num": "Numero del documento d'identità",
  "portrait": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBA.....DEhE2lbPMcOtG3f/DLT/yX8if7Kxn/AD7h85wdttPifRf1e6//2Q==",
  "warnings": "",
  "quality": 0,
  "encryption": null
}

• sim, similarità, intervallo di valori [0.00, 100.00]. Si raccomanda di considerare una similarità maggiore o uguale a 70 per determinare che si tratta della stessa persona; è possibile regolare la soglia in base allo scenario specifico (la percentuale di falsi positivi per una soglia di 70 è di uno su mille, per una soglia di 80 è di uno su diecimila).
• result, codice di errore del servizio, in caso di successo restituisce “Success”, in caso di errore fare riferimento alla sezione “FailedOperation” nell’elenco dei codici di errore sottostante.
• description, qui il risultato della verifica del nome e del numero del documento d’identità.
• name, informazioni sul nome nel documento d’identità, se non è stata caricata l’immagine del documento d’identità è vuoto.
• sex, informazioni sul sesso nel documento d’identità, se non è stata caricata l’immagine del documento d’identità è vuoto.
• nation, informazioni sulla nazionalità nel documento d’identità, se non è stata caricata l’immagine del documento d’identità è vuoto.
• birth, informazioni sulla data di nascita nel documento d’identità, se non è stata caricata l’immagine del documento d’identità è vuoto.
• address, informazioni sull’indirizzo di residenza nel documento d’identità, se non è stata caricata l’immagine del documento d’identità è vuoto.
• id_num, informazioni sul numero del documento d’identità, se non è stata caricata l’immagine del documento d’identità è vuoto.
• portrait, codice base64 della foto del documento d’identità; se il ritaglio fallisce, verrà utilizzata l’intera immagine del documento per il confronto e restituirà vuoto.
• warnings, informazioni di avviso; quando sono state configurate informazioni di avviso in Config, il confronto dell’immagine verrà interrotto, e il risultato restituirà un errore (FailedOperation.OcrWarningOccurred) con queste informazioni di avviso.
• quality, punteggio di qualità dell’immagine; quando è stata configurata l’avvertenza di sfocatura dell’immagine in Config, questo parametro ha significato, intervallo di valori (0-100), attualmente la soglia predefinita è 50, al di sotto di 50 verrà attivata l’avvertenza di sfocatura.
• encryption, informazioni di crittografia dei dati sensibili.

curl -X POST 'https://api.acedata.cloud/identity/idcard/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'

import requests

url = "https://api.acedata.cloud/identity/idcard/check-1e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "image_url": {image_url}
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​

Gestione degli errori

• 400 token_mismatched: Richiesta non valida, probabilmente a causa di parametri mancanti o non validi.
• 400 api_not_implemented: Richiesta non valida, probabilmente a causa di parametri mancanti o non validi.
• 401 invalid_token: Non autorizzato, token di autorizzazione non valido o mancante.
• 429 too_many_requests: Troppe richieste, hai superato il limite di frequenza.
• 500 api_error: Errore interno del server, qualcosa è andato storto sul server.

​

Esempio di risposta di errore

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​

Conclusione