Processo di richiesta
Per utilizzare l’API, è necessario prima andare alla pagina corrispondente dell’API di verifica delle foto del documento d’identità per richiedere il servizio corrispondente. Una volta entrati nella pagina, cliccare sul pulsante “Acquire”, come mostrato nell’immagine:
Se non si è ancora effettuato il login o la registrazione, si verrà automaticamente reindirizzati alla pagina di login per registrarsi e accedere. Dopo aver effettuato il login o la registrazione, si verrà riportati automaticamente alla pagina corrente.
Alla prima richiesta, verrà offerto un credito gratuito, che consente di utilizzare l’API senza costi.
Utilizzo di base
Per prima cosa, è importante comprendere il modo di utilizzo di base, che consiste nell’inserire il link dell’immagine del documento d’identità per ottenere il risultato di verifica elaborato. È necessario semplicemente passare un campoimage_url, e possiamo quindi compilare il contenuto corrispondente nell’interfaccia, come mostrato nell’immagine:

accept: il formato della risposta desiderata, qui impostato suapplication/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, supportacopy_warn,border_check_warn,reshoot_warn,detect_ps_warn,temp_id_warn,quality(soglia 0-100).

sim, similarità, intervallo di valori [0.00, 100.00]. Si raccomanda di considerare come la stessa persona una similarità maggiore o uguale a 70, e si può regolare la soglia in base allo scenario specifico (la percentuale di errore per una soglia di 70 è di uno su mille, per una soglia di 80 è di uno su diecimila).result, codice di errore aziendale, in caso di successo restituisce Success, per errori fare riferimento alla sezione FailedOperation della lista dei codici di errore qui sotto.description, risultato della verifica del nome e del numero di documento.name, informazioni sul nome nel documento d’identità, se non è stata caricata l’immagine del documento d’identità sarà vuoto.sex, informazioni sul sesso nel documento d’identità, se non è stata caricata l’immagine del documento d’identità sarà vuoto.nation, informazioni sulla nazionalità nel documento d’identità, se non è stata caricata l’immagine del documento d’identità sarà vuoto.birth, informazioni sulla data di nascita nel documento d’identità, se non è stata caricata l’immagine del documento d’identità sarà vuoto.address, informazioni sull’indirizzo di residenza nel documento d’identità, se non è stata caricata l’immagine del documento d’identità sarà vuoto.id_num, informazioni sul numero del documento d’identità nel documento d’identità, se non è stata caricata l’immagine del documento d’identità sarà vuoto.portrait, codice base64 della foto del documento d’identità, se il ritaglio fallisce verrà utilizzata l’intera immagine del documento d’identità 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 avrà 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.
Gestione degli errori
Quando si chiama l’API, se si verifica un errore, l’API restituirà il codice di errore e le informazioni corrispondenti. Ad esempio: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.

