API Reference

Questa guida ti fornirà tutto ciò di cui hai bisogno per iniziare a utilizzare le API di MioCodiceFiscale.it per calcolare il codice fiscale, per verificarne la validità e altro ancora.

Nota: Tutte i servizi delle API di MioCodiceFiscale.it devono essere chiamati con il metodo GET.

Calculate

Con il servizio calculate delle API di MioCodiceFiscale.it è possibile calcolare il codice fiscale partendo dai dati anagrafici di una persona.

Esempio:

http://api.miocodicefiscale.it/calculate?lname={cognome}&fname={nome}&gender={sesso}&city={luogo-di-nascita}&state={codice-provincia}&abolished={comune-soppresso}&day={giorno-di-nascita}&month={mese-di-nascita}&year={anno-di-nascita}&omocodia_level={livello-omocodia}&access_token={tua-chiave-API}

Campi:

I campi su indicati sono tutti obbligatori ad eccezione di **state**, il quale viene ricavato in automatico dal nome della città (*city*), **abolished** utile solo per i comuni che nel tempo hanno cambiato codice catastale, e **omocodia_level**.
Campo	Descrizione	Valori consentiti
lname Stringa di testo	Il cognome della persona	Nessun vincolo
fname Stringa di testo	Il nome della persona	Nessun vincolo
gender Stringa di testo	Il sesso della persona	Sesso maschile: M Sesso femminile: F
city Stringa di testo	La città di nascita della persona o per i nati all'estero lo stato di nascita	Elenco dei comuni e degli stati. Accettata solo la lingua italiana. Città con la presenza di lettere accentate possono essere inviate sia con l'accento sia senza. Es. compatibili: Aglie, Agliè ed Aglié. Se presenti spazi, possono essere inviate sia con il carattere spazio " " che con il codice "%20"
state Stringa di testo opzionale	La sigla indicante la provincia di nascita della persona	Elenco delle sigle delle province italiane. Per i nati all'estero la sigla accettata è: EE
abolished Boolean opzionale	Valore utile per indicare quei comuni soppressi che mantengono la stessa denominazione ma Codice Catastale differente	Comune soppresso: true Comune non soppresso: false
day Stringa numerica	Il giorno di nascita della persona	Valore numerico da 1 a 31. Lo 0 per i numeri da 1 a 9 può essere omesso.
month Stringa numerica	Il mese di nascita della persona	Valore numerico da 1 a 12. Lo 0 per i numeri da 1 a 9 può essere omesso.
year Stringa numerica	L'anno di nascita della persona	Accettato sia valore numerico indicato con 4 cifre es.: 1982, sia valore numerico di 2 cifre es.: 82, 01, ecc.
omocodia_level Stringa numerica opzionale	Il livello massimo di omocodia da utilizzare per ottenere nuovi Codici Fiscali	Stringa numerica tra 1 e 128 Il livello 1 è rappresentato dal codice fiscale rappresentato in data.cf Se omesso, il servizio restituisce tutte le 128 possibili combinazioni.
access_token Stringa di testo	La tua chiave API	Nessun vincolo

Risposta:

Se tutto è stato impostato correttamente e la richiesta è andata a buon fine, la risposta sarà simile alla seguente:

{
    "status": true,
    "message": "Codice fiscale calcolato correttamente",
    "data":
    {
        "cf": "RSSMRA82R05F205T",
        "all_cf": {
            0: "RSSMRA82R05F205T", //Livello 1
            1: "RSSMRA82R05F20RT", //Livello 2
            2: "RSSMRA82R05F2L5T", //Livello 3
            ...
            127: "RSSMRAUNRLRFNLRT", //Livello 128 
        }
    }
}

Campo	Descrizione	Valori della risposta
status	Indica l’esito del calcolo	Boolean Codice fiscale calcolato: true Codice fiscale non calcolato: false
message	Indica il messaggio di risposta della chiamata. In caso di errore, indica la causa di tale stato.	Stringa di testo
data	Indica i dati in risposta dalla chiamata API	Array
data.cf	Il codice fiscale generato	Stringa di testo
data.all_cf	Elenco dei possibili Codifici Fiscali ottenuti per evitare omocodie	Array di stringhe di testo

Reverse

Con il servizio reverse delle API di MioCodiceFiscale.it è possibile verificare che il codice fiscale di una persona sia corretto, inoltre è possibile estrarre i dati anagrafici dal codice fiscale.

Esempio:

http://api.miocodicefiscale.it/reverse?cf={codice-fiscale}&access_token={tua-chiave-API}

Campi:

I campi su indicati sono tutti obbligatori.
Campo	Descrizione	Valori consentiti
cf Stringa di testo	Il codice fiscale da verificare o da cui estrarre i dati anagrafici	Stringa alfanumerica di lunghezza di 16 caratteri
access_token Stringa di testo	La tua chiave API	Nessun vincolo

Risposta:

Se tutto è stato impostato correttamente e la richiesta è andata a buon fine, la risposta sarà simile alla seguente:

{
    "status": true,
    "message": "Codice fiscale valido",
    "data": 
    {
        "lname": "RSS",
        "fname": "MRA",
        "gender": "M",
        "city": "Milano",
        "city_ext": "Milano",
        "state": "MI",
        "day": "05",
        "month": "10",
        "year": "82",
        "omocodia": "false",
        "abolished": "false",
    }
}

Campo	Descrizione	Valori della risposta
status	Indica l’esito del calcolo	Boolean Codice fiscale valido: true Codice fiscale non valido: false
message	Indica il messaggio di risposta della chiamata. In caso di errore, indica la causa di tale stato.	Stringa di testo
data	Indica i dati in risposta dalla chiamata API	Array
data.lname	3 lettere che indicano il cognome della persona	Stringa di testo
data.fname	3 lettere che indicano il nome della persona	Stringa di testo
data.gender	Il sesso della persona	Stringa di testo Sesso maschile: M Sesso femminile: F
data.city	La città di nascita della persona o per i nati all'estero lo stato di nascita	Stringa di testo
data.city_ext	La città di nascita della persona o per i nati all'estero lo stato di nascita in lingua alternativa	Stringa di testo
data.state	La sigla indicante la provincia di nascita della persona o per i nati all'estero la sigla EE	Stringa di testo composta da 2 caratteri
data.day	Il giorno di nascita della persona	Stringa numerica composta da 2 caratteri Valori da 01 a 31
data.month	Il mese di nascita della persona	Stringa numerica composta da 2 caratteri Valori 01 a 12
data.year	L'anno di nascita della persona	Stringa numerica composta da 2 caratteri Valori da 00 a 99
data.omocodia	Indica se il codice fiscale presenta caratteri di sostituzione per evitare le omocodie	Boolean Codice fiscale omocode: true Codice fiscale non omocode: false
data.abolished	Indica se il comune calcolato dal Codice Comunale Catastale risulta soppresso	Boolean Codice Comunale Catastale soppresso: true Codice Comunale Catastale non soppresso: false

Reverse: Comune Soppresso

Nel caso in cui il Comune calcolato dal Codice Comunale Catastale risulta soppresso, la risposta sarà simile alla seguente:

{
    "status": true,
    "message": "Codice fiscale valido",
    "data": 
    {
        [...]
        "city": "Vigatto",
        [...]
        "abolished": "true",
        "annexed_to": "Parma",
        "annexed_state": "PR",
        "annexed_code": "G337",
        "original_code": "L870",
    }
}

Campo	Descrizione	Valori della risposta
data.abolished	Indica se il comune calcolato dal Codice Comunale Catastale risulta soppresso	Boolean Codice Comunale Catastale soppresso: true Codice Comunale Catastale non soppresso: false
data.annexed_to	Se il comune calcolato dal Codice Comunale Catastale risulta soppresso, indica il nome della nuova città in cui è stato annesso	Stringa di testo
data.annexed_state	Se il comune calcolato dal Codice Comunale Catastale risulta soppresso, indica la sigla della provincia associata alla città in cui è stato annesso	Stringa di testo composta da 2 caratteri
data.annexed_code	Se il comune calcolato dal Codice Comunale Catastale risulta soppresso, indica il Codice Comunale Castale della nuova città in cui è stato annesso	Stringa di testo
data.original_code	Se il comune calcolato dal Codice Comunale Catastale risulta soppresso, indica il Codice Comunale Castale originale	Stringa di testo

Reverse: Identificazione dell'errore

Il servizio reverse delle API di MioCodiceFiscale.it individua l'errore nel codice fiscale inviato e nel caso in cui si tratti di una singola parte di esso, la mette in evidenza.

Di seguito viene riportata la risposta ottenuta nel caso in cui il codice realativo all'identificazione della città di nascita sia errato.

Risposta:

{
    "status": false,
    "message": "I dati inseriti relativi al comune di nascita sono errati.",
    "data": 
    {
        "cf_error": "GLSGPP82R05***C98R***R"
    }
}

Campo	Descrizione	Valori della risposta
data.cf_error	Indica la parte di codice fiscale errata	Stringa di testo La parte errata viene racchiusa da degli asterischi: *parte-errata*

Compare

Con il servizio compare delle API di MioCodiceFiscale.it è possibile verificare la corrispondenza tra dati anagrafici di una persona e il codice fiscale.

Esempio:

http://api.miocodicefiscale.it/compare?cf={codice-fiscale}&lname={cognome}&fname={nome}&gender={sesso}&city={luogo-di-nascita}&state={codice-provincia}&day={giorno-di-nascita}&month={mese-di-nascita}&year={anno-di-nascita}&access_token={tua-chiave-API}

Campi:

Il campo cf è obbligatorio. Dei campi anagrafici su indicati è necessario che ce ne sia almeno uno per poter effettuare un confronto.
Campo	Descrizione	Valori consentiti
cf Stringa di testo	Il codice fiscale con cui effettuare il confronto	Stringa alfanumerica di lunghezza di 16 caratteri
lname Stringa di testo	Il cognome della persona	Nessun vincolo
fname Stringa di testo	Il nome della persona	Nessun vincolo
gender Stringa di testo	Il sesso della persona	Sesso maschile: M Sesso femminile: F
city Stringa di testo	La città di nascita della persona o per i nati all'estero lo stato di nascita	Elenco dei comuni e degli stati. Accettata solo la lingua italiana. Città con la presenza di lettere accentate possono essere inviate sia con l'accento sia senza. Es. compatibili: Aglie, Agliè ed Aglié. Se presenti spazi, possono essere inviate sia con il carattere spazio " " che con il codice "%20"
state Stringa di testo	La sigla indicante la provincia di nascita della persona	Elenco delle sigle delle province italiane. Per i nati all'estero la sigla accettata è: EE
day Stringa numerica	Il giorno di nascita della persona	Valore numerico da 1 a 31. Lo 0 per i numeri da 1 a 9 può essere omesso.
month Stringa numerica	Il mese di nascita della persona	Valore numerico da 1 a 12. Lo 0 per i numeri da 1 a 9 può essere omesso.
year Stringa numerica	L'anno di nascita della persona	Accettato sia valore numerico indicato con 4 cifre es.: 1982, sia valore numerico di 2 cifre es.: 82, 01, ecc.
access_token Stringa di testo	La tua chiave API	Nessun vincolo

Risposta:

Se tutto è stato impostato correttamente e la richiesta è andata a buon fine, la risposta sarà simile alla seguente:

{
    "status": true,
    "message": "I dati anagrafici corrispondono al codice fiscale",
    "data":
    {
        "lname": true,
        "fname": true,
        "gender": true,
        "city": true,
        "city_ext": true,
        "state": true,
        "day": true,
        "month": true,
        "year": true
    }
}

Campo	Descrizione	Valori della risposta
status	Indica l’esito del confronto	Boolean Confronto avvenuto con successo: true Confronto non avvenuto con successo: false
message	Indica il messaggio di risposta della chiamata. In caso di errore, indica la causa di tale stato.	Stringa di testo
data.lname	Se richiesto il confronto con il cognome, ne indica lo stato	Boolean Confronto avvenuto con successo: true Confronto non avvenuto con successo: false
data.fname	Se richiesto il confronto con il nome, ne indica lo stato	Boolean Confronto avvenuto con successo: true Confronto non avvenuto con successo: false
data.gender	Se richiesto il confronto con il sesso, ne indica lo stato	Boolean Confronto avvenuto con successo: true Confronto non avvenuto con successo: false
data.city	Se richiesto il confronto con il comune di nascita, ne indica lo stato	Boolean Confronto avvenuto con successo: true Confronto non avvenuto con successo: false
data.state	Se richiesto il confronto con la provincia di nascita, ne indica lo stato	Boolean Confronto avvenuto con successo: true Confronto non avvenuto con successo: false
data.day	Se richiesto il confronto con il giorno di nascita, ne indica lo stato	Boolean Confronto avvenuto con successo: true Confronto non avvenuto con successo: false
data.month	Se richiesto il confronto con il mese di nascita, ne indica lo stato	Boolean Confronto avvenuto con successo: true Confronto non avvenuto con successo: false
data.year	Se richiesto il confronto con l'anno di nascita, ne indica lo stato	Boolean Confronto avvenuto con successo: true Confronto non avvenuto con successo: false

Omocodia

Con il servizio omocodia delle API di MioCodiceFiscale.it è possibile ottenere il codice fiscale modificato per omocodia.

Possono verificarsi casi, seppur rari, in cui il codice fiscale di due persone diverse calcolato con l'algoritmo standard sia identico. Questi sono i casi di omocodia.

Grazie a questo servizio è possibile ottenere l'elenco di tutti i codici fiscali generabili per ovviare ai casi di omocodia.

Esempio:

http://api.miocodicefiscale.it/omocodia?cf={codice-fiscale}&level={livello-omocodia}&access_token={tua-chiave-API}

Campi:

I campi su indicati sono tutti obbligatori.
Campo	Descrizione	Valori consentiti
cf Stringa di testo	Il codice fiscale da cui generare le sostituzioni per evitare casi di omocodia	Stringa alfanumerica di lunghezza di 16 caratteri
level Stringa numerica	Il livello massimo di omocodia da utilizzare per ottenere nuovi Codici Fiscali	Stringa numerica tra 1 e 128
access_token Stringa di testo	La tua chiave API	Nessun vincolo

Risposta:

Se tutto è stato impostato correttamente e la richiesta è andata a buon fine, la risposta sarà simile alla seguente:

{
    "status": true,
    "message": "Codici fiscali calcolati correttamente",
    "data": 
    {
        0:	"GLSGPP82R05C983M", //Livello 1
        1:	"GLSGPP82R05C98PM", //Livello 2
        2:	"GLSGPP82R05C9U3M", //Livello 3
        3:	"GLSGPP82R05C9UPM", //Livello 4
        4:	"GLSGPP82R05CV83M", //Livello 5
        5:	"GLSGPP82R05CV8PM", //Livello 6
        ...
        127:	"GLSGPPUNRLRCVUPM" //Livello 128
    }
}

Campo	Descrizione	Valori della risposta
status	Indica l’esito del calcolo	Boolean Codice fiscale valido: true Codice fiscale non valido: false
message	Indica il messaggio di risposta della chiamata. In caso di errore, indica la causa di tale stato.	Stringa di testo
data	Indica i dati in risposta dalla chiamata API	Array
data.Array()	Elenco dei possibili Codifici Fiscali ottenuti per evitare omocodie	Array di stringhe di testo

Ping

Con il servizio ping delle API di MioCodiceFiscale.it è possibile verificare che tutto sia impostato correttamente e che la Chiave API sia funzionante.

Esempio:

http://api.miocodicefiscale.it/ping?access_token={tua-chiave-API}

Campi:

I campi su indicati sono tutti obbligatori.
Campo	Descrizione	Valori consentiti
access_token Stringa di testo	La tua chiave API	Nessun vincolo

Risposta:

Se tutto è stato impostato correttamente e la richiesta di ping è andata a buon fine, la risposta sarà simile alla seguente:

{
    "status": true,
    "message": "Le chiamate API funzionano correttamente!"
}

Campo	Descrizione	Valori della risposta
status	Indica la validità della chiamata all’endepoint PING	Boolean Chiamata valida: true Chiamata non valida: false
message	Indica il messaggio di risposta della chiamata. In caso di errore, indica la causa di tale stato.	Stringa di testo

Profile

Con il servizio profile delle API di MioCodiceFiscale.it è possibile visualizzare i dati dell'account associato alla Chiave API.

Esempio:

http://api.miocodicefiscale.it/profile?access_token={tua-chiave-API}

Campi:

I campi su indicati sono tutti obbligatori.
Campo	Descrizione	Valori consentiti
access_token Stringa di testo	La tua chiave API	Nessun vincolo

Risposta:

Se tutto è stato impostato correttamente e la richiesta è andata a buon fine, la risposta sarà simile alla seguente:

{
    "status": true,
    "message": "Chiamata eseguita correttamente"
    "data": 
    {
        "site_url": "https://www.example.com",
        "email": "email@example.com",
        "register_date": "2022-05-06 09:06:04",
        "status": "1",
        "max_call": "1000",
        "plan": "free",
        "expiration_date": null,
        "services_calls":
        {
            "reverse": "150",
            "calculate": "6",
            "profile": "1"
        },
        "total_calls": "157",
        "services_calls_today":
        {
            "reverse": "15",
            "calculate": "5",
        }
        "total_calls_today": "20",
        "last_call": "2022-11-30 15:36:58"	
    }
}

Campo	Descrizione	Valori della risposta
status	Indica la validità della chiamata	Boolean Chiamata valida: true Chiamata non valida: false
message	Indica il messaggio di risposta della chiamata. In caso di errore, indica la causa di tale stato.	Stringa di testo
data	Indica i dati in risposta dalla chiamata API	Array
data.site_url	Il sito internet associato all'account	Stringa di testo
data.email	L'indirizzo email associato all'account	Stringa di testo
data.register_date	La data di registrazione dell'account	Data
data.status	Indica se l'account risulta attivo	Boolean Account attivo: 1 Account non attivo: 0
data.max_call	Indica il limite sul numero di chiamate che è possibile effettuare con il singolo account per ogni singolo giorno.	Stringa numerica indicante il limite sul numero di chiamate
data.plan	Indica il piano attivo per il singolo account.	Stringa [free, base, pro, enterprise]
data.expiration_date	Indica la data di scadenza del piano attivo.	Data o null se il piano non ha una scadenza.
data.services_calls	Indica il numero totale di chiamate divese per servizio, effettuate dal singolo account a partire dalla data di registrazione.	Array
data.total_calls	Indica il numero totale di chiamate effettuate dal singolo account a partire dalla data di registrazione.	Stringa numerica
data.services_calls_today	Indica il numero totale di chiamate divese per servizio, effettuate dal singolo account nel giorno della richiesta.	Array
data.total_calls_today	Indica il numero totale di chiamate effettuate dal singolo account nel giorno della richiesta.	Stringa numerica
data.last_call	Indica la data in cui è stata effettuata l'utlima chiamata.	Data

Limite giornaliero raggiunto

Se viene raggiunto il limite giornaliero di chiamate consentite per ciascun account, verrà restituita la seguente risposta:

{
    "status": false,
    "message": "Oggi hai effettuato oltre 1000 richieste, che è superiore al limite consentito per il tuo piano. Per continuare a utilizzare il prodotto senza interruzioni, contatta l'amministratore di sistema.",
    "error": "daily_limit_reached"
}

Campo	Descrizione	Valori della risposta
status	Indica la validità della chiamata	Boolean Chiamata valida: true Chiamata non valida: false
message	Indica il messaggio di risposta della chiamata. In caso di errore, indica la causa di tale stato.	Stringa di testo
error	Indica il tipo di errore	Stinga di testo

Sostieni questo progetto

Sei giunto sul nostro sito numerose volte e lo consideri utile? Aiutaci a tenerlo attivo. Versando un piccolo contributo puoi contribuire alle spese di hosting e di traffico. Ogni contributo, anche minimo, è benaccetto. Dona tramite PayPal o tramite Stripe (carta di credito), la tua collaborazione è preziosa! Grazie.

PAGACI UN CAFFÈ

PAYPAL CREDIT CARD