Cerved API.

Commercial Score
Scheda Tecnica

WebSite : http://developer.cerved.com

URL : https://api.cerved.com/cervedApi

(Aggiornata al 8/4/2022)
Headers

Key Value

accept application/json

apikey ********************************

Path

Tipo Valore Path

POST application/json /v1/score/collection/commercial

Descrizione

Il Collection Score di Cerved è lo strumento che calcola la probabilità di incasso del credito per supportare le decisioni
e aiutare a prioritizzare le azioni da fare.

Parameters

Nome Tipo Descrizione

request undefined dati sui quali calcolare il rischio di recupero

Esempio di richiesta

{
"id_soggetto": 0,
"ricerca_soggetto": {
"tipo_soggetto": "F",
"codice_fiscale": "string"
},
"tipologia_fornitura": "U",
"stato_fornitura": "A",
"indirizzo": {
"tipo": "D",
"stato": "Italia",
"provincia": "Roma",
"cap": 64,
"localita": "string",
"comune": "Roma",
"via": "Piazza del Popolo, 1"
},
"lista_insolvenze": [
{
"dt_sofferenza": "2017-01-30",
"pretesa_creditoria": 1000.01
}
]
}

Schema della richiesta

CommercialCollection Cerved API - 1

 Nome Tipo Descrizione

id_soggetto integer (optional) Identificativo univoco Cerved del Soggetto (persona

fisica o giuridica). id_soggetto è obbligatorio se
ricerca_soggetto non è definito. Qualora entrambi i
precedenti parametri fossero definiti, verrà
considerato solo id_soggetto

ricerca_soggetto RicercaSoggetto alternativo a id_soggetto, consente la ricerca

(optional) contestuale di un soggetto all'interno della base dati

tipologia_fornitura string(required) tipologia di fornitura (U=utilities, N=Non Utilities)

stato_fornitura string (optional) stato della fornitura (A=Attiva, C=Cessata).

Significativo per tipologia_fornitura=U

indirizzo Indirizzo (optional) Se non valorizzato o non valido il calcolo avverrà

utilizzando il miglior indirizzo disponibile in anagrafica

lista_insolvenze array[Insolvenza](require lista di insolvenze relative al soggetto

d)

RicercaSoggetto

Nome Tipo Descrizione

tipo_soggetto string(required) tipo del soggetto da ricercare: F(persona fisica) o

G(persona giuridica)

codice_fiscale string(required) codice fiscale del soggetto da ricercare

Indirizzo

Nome Tipo Descrizione

tipo string(required) tipo di indirizzo (D=Domicilio/residenza, U=Utenza,

F=Fatturazione, C=Corrispondenza)

stato string(required) nome esteso nazione

provincia string(required) nome esteso provincia

cap string(required) CAP

localita string (optional) località

comune string(required) nome esteso del Comune

via string(required) indirizzo completo di dug + via + civico

Insolvenza

Nome Tipo Descrizione

dt_sofferenza string(required) data di ingresso in sofferenza della posizione in

formato AAAA-MM-GG

pretesa_creditoria string(required) importo in euro dell' esposizione residua al momento

dell' ingresso in sofferenza. Il separatore decimale è
"."

Messaggi di risposta

Cerved API - 2
Codice Descrizione

200 Created / Accepted Transaction request - All OK

400 Bad Request - Input Request is invalid or incorrect.

401 Unauthorized - Invalid API Key and Token.

403 Forbidden

404 Not Found - The requested resource does not exist.

412 Precondition Failed

Esempio di risposta

{
"id_soggetto": 0,
"score_credito": "0.80",
"classe_score_credito": "5",
"descrizione_classe_score_credito": "Ottima",
"lista_scores_insolvenze": [
{
"identificativo_posizione": 0,
"collection_score_nonCalcolabile": "true"
}
]
}

Schema della risposta

CollectionScore

Nome Tipo Descrizione

id_soggetto integer(required) Identificativo univoco Cerved del Soggetto (persona

fisica o giuridica)

score_credito number (optional) probabilità di recupero del credito calcolato sulla base
degli insoluti inseriti. Lo score è un valore percentuale
rappresentato come numero decimale compreso tra 0
e1

classe_score_credito string (optional) La probabilità di recupero raggruppata in classi. La

classe può avere valore compreso tra 1 e 5: <br>
Nulla - score_credito da 0% a 5% <br> Scarsa -
score_credito da 5% a 15% <br> Contenuta -
score_credito da 15% a 40% <br> Buona -
score_credito da 40% a 60% <br> Ottima -
score_credito oltre 60%

descrizione_classe_score_credit string (optional) score creditizio in una forma testuale e descrittiva

o <br> Classe 1 - Nulla <br> Classe 2 - Scarsa <br>
Classe 3 - Contenuta <br> Classe 4 - Buona <br>
Classe 5 - Ottima

Cerved API - 3
Nome Tipo Descrizione

lista_scores_insolvenze array[ScoreInsolvenza] una lista contenente eventuali errori. Nel caso si

(optional) verifichino errori nel calcolo dello score, i campi
score_credito, classe_score_credito, e
descrizione_classe_score_credito non verranno
popolati e questa lista conterrà informazioni su quali
insolvenze li hanno causati.

ScoreInsolvenza

Nome Tipo Descrizione

identificativo_posizione integer (optional) identifica l'insolvenza come posizione nella

lista_insolvenze in input

collection_score_nonCalcolabile boolean (optional) indica che non è stato possibile calcolare lo score per
questa insolvenza

Cerved API - 4