Guide de l'API CREDITEO

1. URL

L’API est accessible sur https://api10.crediteo.co/.

2. Prérequis serveur

2.1. HTTPS

Il faut que votre site internet soit en HTTPS afin de sécuriser (crypter) les transactions de données.

2.2. CORS

Il faut que votre site internet soit en accord avec les règles du cross-origin resource sharing (CORS) afin de pouvoir accéder aux ressources de l’API en toute sécurité.

Cela permettra également à l’API de vérifier l’origine de la demande et de s’assurer que ce n’est pas une autre personne qui essaie d'insérer des données dans votre compte.

Comment mettre en place le CORS ?
Documentation officiel MDN CORS.

3. Authentification

Pour s’authentifier à l’API, il vous faudra le token fourni par un commercial de la société CREDITEO.

Il faudra créer un header dans votre requête XHR nommé “X-CREDITEO-USER-AUTH-TOKEN” ayant comme valeur le token fourni par CREDITEO.

4. Erreurs

Toutes les erreurs sont retournées avec un code, un message adapté et un lien vers ce guide.

4.1. Code 428

{"error":"CORS not enabled.", "apiguide":"https://form.crediteo.co/#prerequis", "code":428}

Cela signifie que la requête que vous avez effectuée n’est pas en accord avec les règles du cross-origin resource sharing (CORS) (cf paragraphe 2.1).

4.2. Code 404

{"error":"Request not found.", "apiguide":"https://form.crediteo.co/#erreurs", "code":404}

Cela signifie que l’url sur lequel vous venez de faire votre requête n’est pas correct.

4.3. Code 409

{"error":"Incomplete form.", "apiguide":"https://form.crediteo.co/#erreurs", "code":409}

Cela signifie que les données de votre formulaire ne sont pas correctement saisies.

4.4. Code 404

{"error":"API KEY not found.", "apiguide":"https://form.crediteo.co/#auth", "code":404}

Cela signifie que votre token d’identification est incorrect, il faut alors contacter le SAV de CREDITEO en indiquant votre domaine et votre token afin que le SAV procède à une vérification et vous renvoie un token valide.

4.5. Code 409

{"error":"Too many arguments.", "apiguide":"https://form.crediteo.co/#erreurs", "code":409}

Cela signifie que vous avez envoyé trop d'arguments, pour savoir ce que vous devez envoyer référez-vous au paragraphe concernant la route choisie.

4.6. Code 409

{"error":"Invalid form.", "apiguide":"https://form.crediteo.co/#erreurs", "code":409}

Cela signifie que vous avez envoyé des données invalides, pour savoir ce que vous devez envoyer référez-vous au paragraphe concernant la route choisie.

4.7. Code 409

{"error":"Required fields are missing for a credit.", "apiguide":"https://form.crediteo.co/#erreurs", "code":409}

Cela signifie que vous n'avez pas envoyé les données nécessaires pour la création d'un crédit.

4.8. Code 409

{"error":"A property already paid can't have a credit.", "apiguide":"https://form.crediteo.co/#erreurs", "code":409}

Cela signifie que vous avez renseigné un bien payé avec un crédit lié à ce bien.

5. Test de bon fonctionnement

GET https://api10.crediteo.co

Création d’une requête de méthode GET vers https://api10.crediteo.co/ avec le header d’authentification.

Si la requête vous retourne un code 404 avec le message :

{"error":"Request not found.", "apiguide":"https://form.crediteo.co/", "code":404}

c’est que vous êtes bien configuré pour utiliser l’API de CREDITEO.

6. Création d'un dossier prospect de contact

POST https://api10.crediteo.co/prospect

6.1. Route de création

Création d’une requête de méthode POST vers https://api10.crediteo.co/prospect avec le header d’authentification, et un header Content-Type de type "application/json". Votre requête doit contenir les informations du formulaire en paramètres au format json.

Flux d'entrée

Nom	Type	Description
nom	string	Nom du prospect.
prenom	string	Prénom du prospect.
email	string	Email du prospect.
tel	string	Numéro de téléphone du prospect.

Exemple :

{
    "nom": "DURAND",
    "prenom": "Jean",
    "email": "jean.durand@email.fr",
    "tel": "0658957412"
}

Flux de sortie

Nom	Type	Description
dossier	object	Dossier du prospect créé. Contient la référence et l'identifiant du dossier.

Si la requête retourne une erreur, nous vous invitons à regarder le paragraphe 4 qui explique chaque type d’erreur afin de la résoudre.

S’il n’y a pas d’erreur, alors la requête vous retournera un objet du type :

{
    "dossier": {
        "ref": "...", // Référence du dossier
        "id": "..." // Identifiant du dossier
    }
}

ref étant la référence du dossier créé et id l’identifiant du dossier créé. Vous pourriez ensuite créer un bouton du côté de votre site web redirigeant sur le dossier en question (ex: https://app.crediteo.co/dossiers/clients/fiche/3).

6.2. Tutoriel

6.2.1. Création de notre formulaire

Nous allons créer un formulaire contenant les 4 champs nécessaires pour la création d'un prospect dans Créditéo.

Un champ nom ayant comme id "nom"
Un champ prénom ayant comme id "prenom"
Un champ email ayant comme id "email"
Un champ tel ayant comme id "tel"

Exemple du champ nom :

<label for="nom">Nom</label>
<input type="text" id="nom">

Et un bouton permettant d'envoyer les informations.

<button type="button" id="send">Valider</button>

<body>
    <div>
        <div>
            <h3>Cr&eacute;ation d'un prospect</h3>
            <form>
                <div>
                    <label for="nom">Nom</label>
                    <input type="text" id="nom">
                </div>
                <div>
                    <label for="prenom">Pr&eacute;nom</label>
                    <input type="text" id="prenom">
                </div>
                <div>
                    <label for="email">Email</label>
                    <input type="email" id="email">
                </div>
                <div>
                    <label for="tel">T&eacute;l&eacute;phone</label>
                    <input type="tel" id="tel">
                </div>

                <button type="button" id="send">Valider</button>
            </form>
        </div>
    </div>
</body>

6.2.2. Connexion de notre formulaire à l'API de CREDITEO

Nous allons créer une requête XHR permettant d'envoyer les informations de notre formulaire sur l'API Créditéo.

Tout d'abord nous allons récupérer les informations saisies dans le formulaire.

// On récupère la saisie de l'utilisateur pour le champ "nom"
// Dans le formulaire, nous avions donné l'id "nom" à notre champ
$('#nom').val()
// $('#nom') permet de récupérer l'élément html
// La méthode val permet de récupérer la valeur saisie par l'utilisateur

Après avoir récupéré les champs du formulaire, nous allons envoyer les informations à l'API en effectuant une requête XHR.

Enfin, il ne nous reste plus qu'à faire l'action clic sur le bouton valider.

$(document).ready(function() { // On attend que le chargement de la page ait bien fini
    $('#send').on('click', function() { // On affecte notre fonction à l'événement clic du bouton
        // On utilise la fonction $.post de jquery.
        // A savoir que nous pouvons également utiliser la méthode $.ajax de jquery
        // il faudra juste insérer "method: 'POST'" dans l'objet
        $.post({ // On effectue une requête POST
            url: 'https://api10.crediteo.co/prospect', // url de l'API
            data : { // Champs du formulaire que l'on met en paramètres de la requête
                "nom" : $('#nom').val(),
                "prenom" : $('#prenom').val(),
                "email" : $('#email').val(),
                "tel" : $('#tel').val(),
            },
            beforeSend : function (xhr) { // On utilise la méthode beforeSend pour placer nos headers
                xhr.setRequestHeader("Content-type", "application/x-www-form-urlencoded"),
                xhr.setRequestHeader("X-CREDITEO-USER-AUTH-TOKEN", "APIKEY") // Saisir votre token à la place de APIKEY
            }
        });
    });
});

7. Création d'un dossier prospect complet

POST https://api10.crediteo.co/prospectcomplet

Cette route permet de créer un dossier prospect reprenant l'ensemble des onglets de Créditéo.

Votre entête HTML doit contenir les informations nécessaires pour vous authentifier et le champ Content-Type renseigné avec "application/json".

Les données nécessaires sont à envoyer au format json via un POST sur la route https://api10.crediteo.co/prospectcomplet.

Flux d'entrée

Objet à envoyer

L'objet à envoyer contient lui-même plusieurs objets et tableaux d'objets.

Pour que l'envoi réussisse il faut nécessairement renseigner un emprunteur avec son nom, prénom, email et téléphone.

Nom	Type	Description	Longueur maximale	Obligatoire
emprunteurs	array	Tableau contenant des objets de type "emprunteur". Il doit obligatoirement y avoir un emprunteur renseigné avec nom, prénom, téléphone et email.	2	Oui
dossier	dossier	Contient les éléments décrivant le dossier en lui-même.	-	Non
projet	projet	Contient tous les éléments décrivant un projet.	-	Non
enfants	array	Tableau contenant des objets de type "enfant".	3	Non
biens	array	Tableau contenant des objets de type "bien".	3	Non
creditsconso	array	Tableau contenant des objets de type "credit". Ce sont les crédits à la consommation.	2	Non
autresrevenus	float	Montant des autres revenus.	-	Non
autrescharges	float	Montant des autres charges.	-	Non
situationbancaire	situationbancaire	Contient tous les éléments de la banque principale.	-	Non
souhaitsclient	souhaitsclient	Contient les éléments des souhaits client.	-	Non
simulation	simulation	Contient les éléments de départ d'une simulation.	-	Non

{
  "emprunteurs":[
    {
      "titre": "Monsieur",
      "nom": "Dupont",
      "prenom": "Jean",
      "datenaissance": "06/05/1977",
      "villenaissance": "Nancy",
      "situationfamiliale": "Union libre",
      "nationalite": "Française",
      "paysresidence": "France",
      "lienparenteemprunteurprincipal": "Aucun",
      "situationimmo": "Locataire",
      "situationimmodepuis": "04/11/2012",
      "adresse": "6 avenue du général Leclerc",
      "complementadresse": "",
      "codepostal": "54000",
      "ville": "Nancy",
      "pays": "France",
      "email": "jean.dupont@me.com",
      "telephone": "0606060606",
      "telephonefixe": "0383010101",
      "telephonebureau": "0383010102",
      "accordrecueildonnees": true,
      "categorie": "Salarié(e) Cadre",
      "intitule": "Chef de projet",
      "contrat": "CDI",
      "salairemensuel": 3000.00,
      "payesur": 12,
      "dateembauche": "03/07/2013",
      "periodeessaiterminee": true,
      "revenufiscalrefn1": 36000.00,
      "revenufiscalrefn2": 35000.00,
      "impotrevenu": 2000.00,
      "nomemployeur": "Société",
      "adressetravail": "26 rue des ponts",
      "complementadressetravail": "",
      "codepostaltravail": "54000",
      "villetravail": "Nancy",
      "paystravail": "France"
    },
    {
      "titre": "Madame",
      "nom": "Pierre",
      "prenom": "Marie",
      "datenaissance": "06/12/1979",
      "villenaissance": "Nancy",
      "situationfamiliale": "Union libre",
      "nationalite": "Française",
      "paysresidence": "France",
      "lienparenteemprunteurprincipal": "Conjointe",
      "situationimmo": "Locataire",
      "situationimmodepuis": "04/11/2012",
      "adresse": "6 avenue du général Leclerc",
      "complementadresse": "",
      "codepostal": "54000",
      "ville": "Nancy",
      "pays": "France",
      "email": "marie.pierre@me.com",
      "telephone": "0606060607"
    }
  ],
  "dossier": {
    "reference": "DP1233548783214"
  },
  "projet": {
    "etatprojet": "Bien trouvé",
    "natureprojet": "Acquisition",
    "destination": "Résidence principale",
    "etatbien": "Ancien",
    "typebien": "Maison",
    "proprietebien": "Pleine propriété",
    "nomvendeur": "Monsieur Francis Berenger",
    "agebien": 15,
    "dpe": "C",
    "nbpersonnes": 4,
    "libelledescriptif": "",
    "listeannexes": "",
    "adressebien": "95 avenue de la libération",
    "complementadresse": "",
    "numeroetage": "0",
    "codepostal": "54000",
    "ville": "Nancy",
    "referencecadastrale": "",
    "autresprecisionsadressebien": "",
    "nbpieces": "F5",
    "surfacehabitable": 100.00,
    "surfaceterrain": 300.00,
    "surfaceterrainmoinsdedeuxans": 0.00,
    "surfaceannexes": 0.00,
    "surfacehabitablecreee": 20.00,
    "surfacelocauxpro": 0.00,
    "autresprecisionssuperficie": "",
    "signaturescompromis": "30/05/2019",
    "conditionsuspensivepret": "",
    "debuttravaux": "",
    "signatureacte": "15/06/2019",
    "livraisonprevisionnelle": ""
  },
  "enfants": [
    {
      "nom": "Dupont",
      "prenom": "Louis",
      "datenaissance": "23/08/2014"
    },
    {
      "nom": "Dupont",
      "prenom": "Nina",
      "datenaissance": "17/10/2018"
    }
  ],
  "biens": [
    {
      "sciproprietaire": "",
      "descriptif": "Studio F2",
      "anneeachat": 2010,
      "prixachat": 70000.00,
      "valeuractuelle": 75000.00,
      "type": "Résidence principale",
      "adresse": "33 rue des pierres",
      "codepostal": "57000",
      "ville": "Metz",
      "pays": "France",
      "bienpaye": false,
      "biendejahypotheque": false,
      "bienenvente": false,
      "credit": {
        "organismepreteur": "",
        "montantinitial": 72500.00,
        "tauxinterets": 1.20,
        "datedebut": "01/01/2010",
        "duree": 150,
        "mensualite": 520.73,
        "datecapitalrestantdu": "12/04/2019",
        "capitalrestantdu": 19907.81,
        "rachatpret": false
      }
    }
  ],
  "creditsconso": [
    {
      "nomcredit": "Crédit voiture",
      "organismepreteur": "",
      "montantinitial": 5000.00,
      "tauxinterets": 0.20,
      "datedebut": "06/06/2018",
      "duree": 12,
      "mensualite": 417.12,
      "datecapitalrestantdu": "12/04/2019",
      "capitalrestantdu": 834.03,
      "rachatpret": false
    }
  ],
  "autresrevenus": 500.00,
  "autrescharges": 150.00,
  "situationbancaire": {
    "numerocompte": "",
    "typecompte": "Compte joint",
    "nombanque": "CIC",
    "anneeclient": 5,
    "moisclient": 6,
    "bic": "",
    "iban": ""
  },
  "souhaitsclient": {
    "duree": 200,
    "mensualite": 750.00,
    "typetaux": "Fixe"
  },
  "simulation": {
    "coutprojethorsfrais": 147000.00,
    "fraisgarantie": 950.00,
    "fraisdossier":  1000.00,
    "fraiscourtage": 1200.00,
    "fraisagence":  0.00,
    "fraisnotaire":  0.00
  }
}

Description des types

Objet de type "emprunteur"

Cet objet contient toutes les informations relatives à un emprunteur et à sa situation professionnelle. Si un emprunteur est renseigné il faut renseigner toutes les propriétés obligatoires de l'emprunteur.

Nom	Type	Description	Obligatoire
nom	string	Nom de l'emprunteur.	Oui
prenom	string	Prénom de l'emprunteur.	Oui
email	string	Adresse email de l'emprunteur, attention le format doit correspondre à une adresse email valide.	Oui
telephone	string	Numéro de téléphone portable de l'emprunteur.	Oui
titre	string	Titre de l'emprunteur.	Non
datenaissance	string	Date de naissance de l'emprunteur, au format "dd/mm/yyyy".	Non
villenaissance	string	Ville de naissance de l'emprunteur.	Non
situationfamiliale	string	Situation familiale de l'emprunteur. Peut prendre une des valeurs suivantes : "Célibataire", "Marié(e)", "Union libre", "Concubinage", "Veuf/Veuve", "Pacsé(e)", "Divorcé(e)", "En instance de séparation".	Non
nationalite	string	Nationalité de l'emprunteur.	Non
paysresidence	string	Pays de résidence de l'emprunteur.	Non
lienparenteemprunteurprincipal	string	Lien de parenté avec l’emprunteur principal. S’il s’agit de l’emprunteur principal mettre "Aucun". Peut prendre une des valeurs suivantes : "Aucun", "Père", "Mère", "Fils", "Fille", "Grand-Père", "Grand-Mère", "Mari", "Femme", "Conjoint", "Conjointe", "Frère", "Soeur", "Belle-fille", "Belle-mère", "Belle-soeur", "Beau-fils", "Beau-père", "Beau-frère", "Cousin", "Cousine", "Oncle", "Tante".	Non
situationimmo	string	Situation immobilière de l’emprunteur. Peut prendre une des valeurs suivantes : "Locataire", "Hébergé(e) à titre gratuit", "Propriétaire".	Non
situationimmodepuis	string	Date de début de la situation immobilière de l'emprunteur, au format "dd/mm/yyyy".	Non
adresse	string	Adresse de l'emprunteur.	Non
complementadresse	string	Complément d'adresse de l'emprunteur.	Non
codepostal	string	Code postal de l'emprunteur.	Non
ville	string	Ville de l'emprunteur.	Non
pays	string	Pays de l'emprunteur.	Non
telephonefixe	string	Numéro de téléphone fixe de l'emprunteur.	Non
telephonebureau	string	Numéro de téléphone du bureau de l'emprunteur.	Non
accordrecueildonnees	boolean	Indique si l'emprunteur a donné son accord pour le recueil de données personnelles.	Non
categorie	string	Catégorie de la situation professionnelle de l'emprunteur. Peut prendre les valeurs suivantes : "Artisan", "Fonctionnaire Contractuel(le)", "Fonctionnaire Stagiaire", "Fonctionnaire Titulaire", "Intermittent", "Intérimaire", "Profession libérale", "Retraité(e)", "Salarié(e) Cadre", "Salarié(e) Gérant", "Salarié(e) non-cadre", "Sans profession", "Travailleur Non Salarié", "Vacataire".	Non
intitule	string	Intitulé de la situation professionnelle de l'emprunteur.	Non
contrat	string	Type de contrat de l'emprunteur. Peut prendre les valeurs suivantes : "CDI", "CDD", "Contrat d’intérim".	Non
salairemensuel	float	Salaire mensuel de l'emprunteur.	Non
payesur	int	Nombre de mois sur lequel est payé l'emprunteur.	Non
dateembauche	string	Date d'embauche de l'emprunteur, au format "dd/mm/yyyy".	Non
periodeessaiterminee	boolean	Indique si la période d'essai est terminée.	Non
revenufiscalrefn1	float	Revenu fiscal de référence de l'emprunteur pour l'année n-1.	Non
revenufiscalrefn2	float	Revenu fiscal de référence de l'emprunteur pour l'année n-2.	Non
impotrevenu	float	Montant de l'impôt sur le revenu.	Non
nomemployeur	string	Nom de l'employeur de l'emprunteur.	Non
adressetravail	string	Adresse du lieu de travail de l'emprunteur.	Non
complementadressetravail	string	Complément d'adresse du lieu de travail de l'emprunteur.	Non
codepostaltravail	string	Code postal du lieu de travail de l'emprunteur.	Non
villetravail	string	Ville du lieu de travail de l'emprunteur.	Non
paystravail	string	Pays du lieu de travail de l'emprunteur.	Non

Objet de type "dossier"

Cet objet contient les informations relatives à un dossier.

Nom	Type	Description	Obligatoire
reference	string	Référence du dossier. Générée automatiquement si non renseignée.	Non

Objet de type "projet"

Cet objet contient toutes les informations relatives à un projet. Si un projet est renseigné il faut renseigner toutes les informations obligatoires.

Nom	Type	Description	Obligatoire
natureprojet	string	Nature du projet. Peut prendre les valeurs suivantes : "Achat de SCPI", "Acquisition", "Acquisition + travaux", "Acquisition en VEFA", "Construction", "Crédit professionnel", "Prêt perso", "Rachat de prêt", "Rachat de soulte", "Renégociation de crédits", "Terrain", "Terrain + construction", "Travaux seuls".	Oui
typebien	string	Type du bien à acquérir. Peut prendre les valeurs suivantes : "Maison", "Immeuble", "Appartement", "Terrain seul", "Garage", "Hangar", "Local commercial".	Oui
proprietebien	string	Propriété du bien à acquérir. Peut prendre les valeurs suivantes : "Achat parts", "Pleine propriété", "Usufruit", "Nue propriété".	Non
etatprojet	string	État du projet. Peut prendre les valeurs suivantes : "En recherche de bien", "Bien trouvé", "Offre d'achat effectuée", "Compromis signé".	Non
destination	string	Destination du projet. Peut prendre les valeurs suivantes : "Résidence principale", "Résidence locative", "Résidence secondaire", "Résidence mixte", "Local commercial".	Non
etatbien	string	État du bien à acquérir. Peut prendre les valeurs suivantes : "Neuf", "Ancien".	Non
nomvendeur	string	Nom du vendeur du bien.	Non
agebien	int	Âge du bien en années.	Non
dpe	char	Diagnostic de performance énergétique. Peut prendre les valeurs suivantes : "A", "B", "C", "D", "E", "F", "G".	Non
nbpersonnes	int	Nombre de personnes occupant le logement.	Non
libelledescriptif	string	Libellé descriptif.	Non
listeannexes	string	Liste des annexes.	Non
adressebien	string	Adresse du bien.	Non
complementadresse	string	Complément d'adresse du bien.	Non
numeroetage	string	Numéro d'étage ou de lot.	Non
codepostal	string	Code postal de la ville où est situé le bien.	Non
ville	string	Ville où est situé le bien.	Non
referencecadastrale	string	Référence cadastrale du bien.	Non
autresprecisionsadressebien	string	Autres précisions sur l'adresse du bien.	Non
nbpieces	string	Nombre de pièces du bien.	Non
surfacehabitable	float	Surface habitable, en mètres carrés.	Non
surfaceterrain	float	Surface du terrain, en mètres carrés.	Non
surfaceterrainmoinsdedeuxans	float	Surface du terrain acquis depuis moins de deux ans, en mètres carrés.	Non
surfaceannexes	float	Surface des annexes, en mètres carrés.	Non
surfacehabitablecreee	float	Surface habitable créée par des travaux, en mètres carrés.	Non
surfacelocauxpro	float	Surface des locaux professionnels, en mètres carrés.	Non
autresprecisionssuperficie	string	Autres précisions sur la superficie.	Non
signaturescompromis	string	Date de signatures du compromis, au format "dd/mm/yyyy".	Non
conditionsuspensivepret	string	Date de condition suspensive de prêt, au format "dd/mm/yyyy".	Non
debuttravaux	string	Date de début des travaux, au format "dd/mm/yyyy".	Non
signatureacte	string	Date de signature de l'acte, au format "dd/mm/yyyy".	Non
livraisonprevisionnelle	string	Date de livraison prévisionnelle, au format "dd/mm/yyyy".	Non

Objet de type "enfant"

Cet objet contient toutes les informations relatives à un enfant. Si un enfant est renseigné il faut renseigner toutes les informations obligatoires.

Nom	Type	Description	Obligatoire
nom	string	Nom de l'enfant.	Oui
prenom	string	Prénom de l'enfant.	Oui
datenaissance	string	Date de naissance de l'enfant, au format "dd/mm/yyyy".	Oui

Objet de type "bien"

Cet objet contient toutes les informations relatives à un bien. Si un bien est renseigné il faut renseigner toutes les informations obligatoires.

Nom	Type	Description	Obligatoire
valeuractuelle	float	Valeur actuelle du bien.	Oui
adresse	string	Adresse du bien.	Oui
codepostal	string	Code postal de la ville où est situé le bien.	Oui
ville	string	Ville où est situé le bien.	Oui
pays	string	Pays où est situé le bien.	Oui
bienpaye	boolean	Indique si le bien est payé ou non.	Oui
sciproprietaire	string	SCI propriétaire.	Non
descriptif	string	Descriptif du bien.	Non
anneeachat	int	Année d'achat du bien.	Non
prixachat	float	Prix d'achat du bien.	Non
type	string	Type du bien. Peut prendre les valeurs suivantes : "Résidence principale", "Résidence secondaire", "Locatif", "Terrain".	Non
biendejahypotheque	boolean	Indique si le bien est déjà hypothéqué.	Non
bienenvente	boolean	Indique si le bien est en vente.	Non
credit	credit	Renseigne le crédit lié au bien s'il y en a un. Attention si le bien est payé il ne peut pas y avoir de crédit associé.	Non

Objet de type "credit"

Cet objet contient toutes les informations relatives à un crédit. Si un crédit est renseigné il faut renseigner toutes les informations obligatoires.

Nom	Type	Description	Obligatoire
montantinitial	float	Montant initial du prêt.	Oui
datedebut	string	Date de début du prêt, au format "dd/mm/yyyy".	Oui
mensualite	float	Mensualité du prêt.	Oui
rachatpret	boolean	Indique si le prêt est racheté, peut être vrai SEULEMENT dans le cadre d'un rachat de prêt.	Oui
nomcredit	string	Nom du crédit.	Non
organismepreteur	string	Nom de l'organisme prêteur.	Non
tauxinterets	float	Taux d'intérêts du prêt.	Non
duree	int	Durée en mois du prêt.	Non
datecapitalrestantdu	string	Date de capital restant dû, au format "dd/mm/yyyy".	Non
capitalrestantdu	float	Capital restant dû.	Non

Objet de type "situationbancaire"

Cet objet contient toutes les informations relatives à une situation bancaire.

Nom	Type	Description	Obligatoire
numerocompte	string	Numéro de compte.	Non
typecompte	string	Type de compte. Peut prendre les valeurs suivantes : "Compte personnel", "Compte professionnel", "Compte joint", "Compte impôts", "Compte pour les frais".	Non
nombanque	string	Nom de la banque.	Non
anneeclient	int	Nombre d'années d'ancienneté.	Non
moisclient	int	Nombre de mois d'ancienneté, inférieur à 12.	Non
bic	string	Bank Identifier Code, de longueur inférieure ou égale à 11 caractères.	Non
iban	string	International Bank Account Number, de longueur inférieure ou égale à 34 caractères.	Non

Objet de type "souhaitsclient"

Cet objet contient les informations relatives aux souhaits client.

Nom	Type	Description	Obligatoire
duree	int	Durée souhaitée du prêt.	Non
mensualite	float	Mensualité souhaitée du prêt.	Non
typetaux	string	Type de taux souhaité. Peut prendre les valeurs suivantes : "Fixe", "Variable".	Non

Objet de type "simulation"

Cet objet contient les informations de départ d'une simulation.

Nom	Type	Description	Obligatoire
coutprojethorsfrais	float	Coût du projet hors frais.	Non
fraisgarantie	float	Frais de garantie.	Non
fraisdossier	float	Frais de dossier.	Non
fraiscourtage	float	Frais de courtage.	Non
fraisagence	float	Frais d'agence.	Non
fraisnotaire	float	Frais de notaire.	Non

Flux de sortie

Nom	Type	Description
dossier	object	Dossier du prospect créé. Contient la référence et l'identifiant du dossier.

Si les informations envoyées sont valides, le dossier sera créé et vous recevrez un objet du type :

{
    "dossier": {
        "ref": "...", // Référence du dossier
        "id": "..." // Identifiant du dossier
    }
}

ref étant la référence du dossier créé et id son identifiant.

Si vous recevez une erreur, référez-vous à l'intitulé de l'erreur et au paragraphe concernant les erreurs.

8. Liste de dossiers

GET https://api10.crediteo.co/dossiers?pageIndex={pageIndex}&nbItems={nbItems}&orderBy={orderBy}

Permet de récupérer la liste des dossiers appartenant au courtier (identifié via sa clé d'API) dans l'ordre décroissant de leur date de création.

Cette liste est paginée au nombre d'élément de votre choix.

Les données nécessaires sont à transmettre dans l'URL d'appel.

Paramètres

Nom	Type	Description	Obligatoire
pageIndex	int	Numéro de la page souhaitée (de 1 à n).	Non
nbItems	int	Nombre souhaité d'éléments par page. Si cette information n'est pas envoyée, le retour contiendra l'ensemble des dossiers.	Non
orderBy	string	Propriété sur laquelle ordonner les dossiers (ordre décroissant). Peut prendre une des valeurs suivantes : "datecreation", "datedernieremodification". Si cette information n'est pas envoyée, la liste des dossiers sera ordonnée par rapport à la date de création des dossiers.	Non

Exemple :

https://api10.crediteo.co/dossiers?pageIndex=2&nbItems=15&orderBy=datedernieremodification

Flux de sortie

Objet reçu

L'objet reçu est un tableau d'objets de type "dossier".

Description des types

Objet de type "dossier"

Cet objet contient les informations relatives à un dossier.

Nom	Type	Description
iddossier	string	Identifiant unique du dossier.
reference	string	Référence du dossier.
client	boolean	Indique si le dossier est un dossier client ou prospect.
emprunteur	string	NOM et Prénom de l'emprunteur principal.
natureprojet	string	Nature du projet.
datecreation	string	Date de la création du dossier.
dateconditionsuspensive	string	Date de la condition suspensive de prêt.
datesignature	string	Date prévisionnelle de la signature de l'acte.
avancement	int	Pourcentage d'avancement du dossier.
etape	string	Étape actuelle du dossier.
email	string	Adresse email de l'emprunteur principal.
datedernieremodification	string	Date de la dernière modification du dossier, au format "dd/mm/yyyy HH:MM" (22/12/2019 13:37).

Si les informations envoyées sont valides, vous recevrez un tableau du type :

[
  {
    "iddossier": "...",
    "reference": "...",
    "client": true,
    "emprunteur": "...",
    "natureprojet": "...",
    "datecreation": "...",
    "dateconditionsuspensive": "...",
    "datesignature": "...",
    "avancement": 55,
    "etape": "...",
    "email": "...",
    "datedernieremodification": "..."
  },
  {
    "iddossier": "...",
    "reference": "...",
    "client": false,
    "emprunteur": "...",
    "natureprojet": "...",
    "datecreation": "...",
    "dateconditionsuspensive": "...",
    "datesignature": "...",
    "avancement": null,
    "etape": "...",
    "email": "...",
    "datedernieremodification":  "..."
  }
]

9. Récupérer un dossier spécifique

GET https://api10.crediteo.co/dossiers/{iddossier}

Permet de récupérer un dossier spécifique appartenant au courtier (identifié via sa clé d'API).

Les données nécessaires sont à transmettre dans l'URL d'appel.

Paramètres

Nom	Type	Description
iddossier	string	Identifiant unique du dossier.

Exemple :

https://api10.crediteo.co/dossiers/1245-9684

Flux de sortie

Objet reçu

L'objet reçu contient lui-même plusieurs objets et tableaux d'objets.

Nom	Type	Description
emprunteurs	array	Tableau contenant des objets de type "emprunteur".
situationsprofessionnelles	array	Tableau contenant des objets de type "situationprofessionnelle".
dossier	dossier	Contient les éléments décrivant le dossier en lui-même.
projet	projet	Contient tous les éléments décrivant un projet.
enfants	array	Tableau contenant des objets de type "enfant".
biens	array	Tableau contenant des objets de type "bien".
creditsconso	array	Tableau contenant des objets de type "credit". Ce sont les crédits à la consommation.
autresrevenus	array	Tableau contenant des objets de type "revenu".
autrescharges	array	Tableau contenant des objets de type "charge".
situationsbancaires	array	Tableau contenant des objets de type "situationbancaire".
souhaitsclient	souhaitsclient	Contient les éléments des souhaits client.
simulation	array	Tableau contenant des objets de type "simulation".

Si les informations envoyées sont valides, le dossier sera récupéré et vous recevrez un objet du type :

{
  "emprunteurs": [
    {
      "idemprunteur": "1234-5678",
      "titre": "Monsieur",
      "nom": "Dupont",
      "prenom": "Jean",
      "datenaissance": "06/05/1977",
      "villenaissance": "Nancy",
      "situationfamiliale": "Union libre",
      "nationalite": "Française",
      "paysresidence": "France",
      "lienparenteemprunteurprincipal": "Aucun",
      "situationimmo": "Locataire",
      "situationimmodepuis": "04/11/2012",
      "adresse": "6 avenue du général Leclerc",
      "complementadresse": "",
      "codepostal": "54000",
      "ville": "Nancy",
      "pays": "France",
      "email": "jean.dupont@me.com",
      "telephone": "0606060606",
      "telephonefixe": "0383010101",
      "telephonebureau": "0383010102",
      "accordrecueildonnees": true,
      "numero": 0
    },
    {
      "idemprunteur": "2345-6789",
      "titre": "Madame",
      "nom": "Pierre",
      "prenom": "Marie",
      "datenaissance": "06/12/1979",
      "villenaissance": "Nancy",
      "situationfamiliale": "Union libre",
      "nationalite": "Française",
      "paysresidence": "France",
      "lienparenteemprunteurprincipal": "Conjointe",
      "situationimmo": "Locataire",
      "situationimmodepuis": "04/11/2012",
      "adresse": "6 avenue du général Leclerc",
      "complementadresse": "",
      "codepostal": "54000",
      "ville": "Nancy",
      "pays": "France",
      "email": "marie.pierre@me.com",
      "telephone": "0606060607",
      "accordrecueildonnees": false,
      "numero": 1
    }
  ],
  "situationsprofessionnelles": [
    {
      "idsituationprofessionnelle": "6549-1284",
      "numeroemprunteur": 0,
      "categorie": "Salarié(e) Cadre",
      "intitule": "Chef de projet",
      "contrat": "CDI",
      "salairemensuel": 3000.00,
      "payesur": 12,
      "dateembauche": "03/07/2013",
      "periodeessaiterminee": true,
      "revenufiscalrefn1": 36000.00,
      "revenufiscalrefn2": 35000.00,
      "impotrevenu": 2000.00,
      "nomemployeur": "Société",
      "adresse": "26 rue des ponts",
      "complementadresse": "",
      "codepostal": "54000",
      "ville": "Nancy",
      "pays": "France"
    }
  ],
  "dossier": {
    "iddossier": "23156-54875",
    "reference": "DP1233548783214",
    "datedernieremodification": "27/09/2019 15:27"
  },
  "projet": {
    "etatprojet": "Bien trouvé",
    "natureprojet": "Acquisition",
    "destination": "Résidence principale",
    "etatbien": "Ancien",
    "typebien": "Maison",
    "proprietebien": "Pleine propriété",
    "nomvendeur": "Monsieur Francis Berenger",
    "agebien": 15,
    "dpe": "C",
    "nbpersonnes": 4,
    "libelledescriptif": "",
    "listeannexes": "",
    "adressebien": "95 avenue de la libération",
    "complementadresse": "",
    "numeroetage": "0",
    "codepostal": "54000",
    "ville": "Nancy",
    "referencecadastrale": "",
    "autresprecisionsadressebien": "",
    "nbpieces": "F5",
    "surfacehabitable": 100.00,
    "surfaceterrain": 300.00,
    "surfaceterrainmoinsdedeuxans": 0.00,
    "surfaceannexes": 0.00,
    "surfacehabitablecreee": 20.00,
    "surfacelocauxpro": 0.00,
    "autresprecisionssuperficie": "",
    "signaturescompromis": "30/05/2019",
    "conditionsuspensivepret": "",
    "debuttravaux": "",
    "signatureacte": "15/06/2019",
    "livraisonprevisionnelle": ""
  },
  "enfants": [
    {
      "idenfant": "8974-6584",
      "nom": "Dupont",
      "prenom": "Louis",
      "datenaissance": "23/08/2014"
    },
    {
      "idenfant": "6418-8496",
      "nom": "Dupont",
      "prenom": "Nina",
      "datenaissance": "17/10/2018"
    }
  ],
  "biens": [
    {
      "idbien": "65848-31245",
      "numeroemprunteur1": 0,
      "numeroemprunteur2": null,
      "sciproprietaire": "",
      "descriptif": "Studio F2",
      "anneeachat": 2010,
      "prixachat": 70000.00,
      "valeuractuelle": 75000.00,
      "type": "Résidence principale",
      "adresse": "33 rue des pierres",
      "codepostal": "57000",
      "ville": "Metz",
      "pays": "France",
      "bienpaye": false,
      "biendejahypotheque": false,
      "bienenvente": false,
      "credits": [
        {
          "idcredit": "1894-4197",
          "numeroemprunteur1": 0,
          "numeroemprunteur2": null,
          "organismepreteur": "",
          "montantinitial": 72500.00,
          "tauxinterets": 1.20,
          "datedebut": "01/01/2010",
          "duree": 150,
          "mensualite": 520.73,
          "datecapitalrestantdu": "12/04/2019",
          "capitalrestantdu": 19907.81,
          "rachatpret": false
        }
      ]
    }
  ],
  "creditsconso": [
    {
      "idcredit": "8723-4985",
      "numeroemprunteur1": 0,
      "numeroemprunteur2": null,
      "nomcredit": "Crédit voiture",
      "organismepreteur": "",
      "montantinitial": 5000.00,
      "tauxinterets": 0.20,
      "datedebut": "06/06/2018",
      "duree": 12,
      "mensualite": 417.12,
      "datecapitalrestantdu": "12/04/2019",
      "capitalrestantdu": 834.03,
      "rachatpret": false
    }
  ],
  "autresrevenus": [
    {
      "idrevenu": "2894-7826",
      "numeroemprunteur": 0,
      "libelle": "Allocations familiales",
      "montant": 121.49,
      "commentaire": "",
      "avantprojet": true,
      "apresprojet": true
    }
  ],
  "autrescharges": [
    {
      "idcharge": "2894-7826",
      "numeroemprunteur": 0,
      "libelle": "Loyer actuel",
      "montant": 450.00,
      "avantprojet": true,
      "apresprojet": false
    }
  ],
  "situationsbancaires": [
    {
      "idsituation": "71489-87324",
      "numeroemprunteur1": 0,
      "numeroemprunteur2": null,
      "numerocompte": "",
      "typecompte": "Compte joint",
      "nombanque": "CIC",
      "anneeclient": 5,
      "moisclient": 6,
      "bic": "",
      "iban": ""
    }
  ],
  "souhaitsclient": {
    "duree": 200,
    "mensualite": 750.00,
    "typetaux": "Fixe"
  },
  "simulations": [
    {
      "idsimulation": "891274-123675",
      "coutprojethorsfrais": 147000.00,
      "fraisgarantie": 950.00,
      "fraisdossier": 1000.00,
      "fraiscourtage": 1200.00,
      "fraisagence": 0.00,
      "fraisnotaire": 0.00
    }
  ]
}

Description des types

Objet de type "emprunteur"

Cet objet contient toutes les informations relatives à un emprunteur et à sa situation professionnelle.

Nom	Type	Description
idemprunteur	string	Identifiant unique de l'emprunteur.
nom	string	Nom de l'emprunteur.
prenom	string	Prénom de l'emprunteur.
email	string	Adresse email de l'emprunteur, attention le format doit correspondre à une adresse email valide.
telephone	string	Numéro de téléphone portable de l'emprunteur.
titre	string	Titre de l'emprunteur.
datenaissance	string	Date de naissance de l'emprunteur, au format "dd/mm/yyyy".
villenaissance	string	Ville de naissance de l'emprunteur.
situationfamiliale	string	Situation familiale de l'emprunteur. Peut prendre une des valeurs suivantes : "Célibataire", "Marié(e)", "Union libre", "Concubinage", "Veuf/Veuve", "Pacsé(e)", "Divorcé(e)", "En instance de séparation".
nationalite	string	Nationalité de l'emprunteur.
paysresidence	string	Pays de résidence de l'emprunteur.
lienparenteemprunteurprincipal	string	Lien de parenté avec l’emprunteur principal. Peut prendre une des valeurs suivantes : "Aucun", "Père", "Mère", "Fils", "Fille", "Grand-Père", "Grand-Mère", "Mari", "Femme", "Conjoint", "Conjointe", "Frère", "Soeur", "Belle-fille", "Belle-mère", "Belle-soeur", "Beau-fils", "Beau-père", "Beau-frère", "Cousin", "Cousine", "Oncle", "Tante".
situationimmo	string	Situation immobilière de l’emprunteur. Peut prendre une des valeurs suivantes : "Locataire", "Hébergé(e) à titre gratuit", "Propriétaire".
situationimmodepuis	string	Date de début de la situation immobilière de l'emprunteur, au format "dd/mm/yyyy".
adresse	string	Adresse de l'emprunteur.
complementadresse	string	Complément d'adresse de l'emprunteur.
codepostal	string	Code postal de l'emprunteur.
ville	string	Ville de l'emprunteur.
pays	string	Pays de l'emprunteur.
telephonefixe	string	Numéro de téléphone fixe de l'emprunteur.
telephonebureau	string	Numéro de téléphone du bureau de l'emprunteur.
accordrecueildonnees	boolean	Indique si l'emprunteur a donné son accord pour le recueil de données personnelles.
numero	int	Numero indiquant l'ordre des emprunteurs. Sert aussi pour les liens entre les entités.

Objet de type "situationprofessionnelle"

Cet objet contient les informations relatives aux situations professionnelles.

Nom	Type	Description
idsituationprofessionnelle	string	Identifiant unique de la situation professionnelle.
numeroemprunteur	int	Numéro de l'emprunteur auquel est liée la situation professionnelle.
categorie	string	Catégorie de la situation professionnelle de l'emprunteur. Peut prendre les valeurs suivantes : "Artisan", "Fonctionnaire Contractuel(le)", "Fonctionnaire Stagiaire", "Fonctionnaire Titulaire", "Intermittent", "Intérimaire", "Retraité(e)", "Salarié(e) Cadre", "Salarié(e) Gérant", "Salarié(e) non-cadre", "Sans profession", "Travailleur Non Salarié", "Vacataire".
intitule	string	Intitulé de la situation professionnelle de l'emprunteur.
contrat	string	Type de contrat de l'emprunteur. Peut prendre les valeurs suivantes : "CDI", "CDD", "Contrat d’intérim".
salairemensuel	float	Salaire mensuel de l'emprunteur.
payesur	int	Nombre de mois sur lequel est payé l'emprunteur.
dateembauche	string	Date d'embauche de l'emprunteur, au format "dd/mm/yyyy".
periodeessaiterminee	boolean	Indique si la période d'essai est terminée.
revenufiscalrefn1	float	Revenu fiscal de référence de l'emprunteur pour l'année n-1.
revenufiscalrefn2	float	Revenu fiscal de référence de l'emprunteur pour l'année n-2.
impotrevenu	float	Montant de l'impôt sur le revenu.
nomemployeur	string	Nom de l'employeur de l'emprunteur.
adresse	string	Adresse du lieu de travail de l'emprunteur.
complementadresse	string	Complément d'adresse du lieu de travail de l'emprunteur.
codepostal	string	Code postal du lieu de travail de l'emprunteur.
ville	string	Ville du lieu de travail de l'emprunteur.
pays	string	Pays du lieu de travail de l'emprunteur.

Objet de type "dossier"

Cet objet contient les informations relatives à un dossier.

Nom	Type	Description
iddossier	string	Identifiant unique du dossier.
reference	string	Référence du dossier.
datedernieremodification	string	Date de la dernière modification du dossier, au format "dd/mm/yyyy HH:MM" (22/12/2019 13:37).

Objet de type "projet"

Cet objet contient toutes les informations relatives à un projet.

Nom	Type	Description
natureprojet	string	Nature du projet. Peut prendre les valeurs suivantes : "Achat de SCPI", "Acquisition", "Acquisition + travaux", "Acquisition en VEFA", "Construction", "Crédit professionnel", "Prêt perso", "Rachat de prêt", "Rachat de soulte", "Renégociation de crédits", "Terrain", "Terrain + construction", "Travaux seuls".
typebien	string	Type du bien à acquérir. Peut prendre les valeurs suivantes : "Maison", "Immeuble", "Appartement", "Terrain seul", "Garage", "Hangar", "Local commercial".
proprietebien	string	Propriété du bien à acquérir. Peut prendre les valeurs suivantes : "Achat parts", "Pleine propriété", "Usufruit", "Nue propriété".
etatprojet	string	État du projet. Peut prendre les valeurs suivantes : "En recherche de bien", "Bien trouvé", "Offre d'achat effectuée", "Compromis signé".
destination	string	Destination du projet. Peut prendre les valeurs suivantes : "Résidence principale", "Résidence locative", "Résidence secondaire", "Résidence mixte", "Local commercial".
etatbien	string	État du bien à acquérir. Peut prendre les valeurs suivantes : "Neuf", "Ancien".
nomvendeur	string	Nom du vendeur du bien.
agebien	int	Âge du bien en années.
dpe	char	Diagnostic de performance énergétique. Peut prendre les valeurs suivantes : "A", "B", "C", "D", "E", "F", "G".
nbpersonnes	int	Nombre de personnes occupant le logement.
libelledescriptif	string	Libellé descriptif.
listeannexes	string	Liste des annexes.
adressebien	string	Adresse du bien.
complementadresse	string	Complément d'adresse du bien.
numeroetage	string	Numéro d'étage ou de lot.
codepostal	string	Code postal de la ville où est situé le bien.
ville	string	Ville où est situé le bien.
referencecadastrale	string	Référence cadastrale du bien.
autresprecisionsadressebien	string	Autres précisions sur l'adresse du bien.
nbpieces	string	Nombre de pièces du bien.
surfacehabitable	float	Surface habitable, en mètres carrés.
surfaceterrain	float	Surface du terrain, en mètres carrés.
surfaceterrainmoinsdedeuxans	float	Surface du terrain acquis depuis moins de deux ans, en mètres carrés.
surfaceannexes	float	Surface des annexes, en mètres carrés.
surfacehabitablecreee	float	Surface habitable créée par des travaux, en mètres carrés.
surfacelocauxpro	float	Surface des locaux professionnels, en mètres carrés.
autresprecisionssuperficie	string	Autres précisions sur la superficie.
signaturescompromis	string	Date de signatures du compromis, au format "dd/mm/yyyy".
conditionsuspensivepret	string	Date de condition suspensive de prêt, au format "dd/mm/yyyy".
debuttravaux	string	Date de début des travaux, au format "dd/mm/yyyy".
signatureacte	string	Date de signature de l'acte, au format "dd/mm/yyyy".
livraisonprevisionnelle	string	Date de livraison prévisionnelle, au format "dd/mm/yyyy".

Objet de type "enfant"

Cet objet contient toutes les informations relatives à un enfant.

Nom	Type	Description
idenfant	string	Identifiant unique de l'enfant.
nom	string	Nom de l'enfant.
prenom	string	Prénom de l'enfant.
datenaissance	string	Date de naissance de l'enfant, au format "dd/mm/yyyy".

Objet de type "bien"

Cet objet contient toutes les informations relatives à un bien.

Nom	Type	Description
idbien	string	Identifiant unique du bien.
numeroemprunteur1	int	Numéro du propriétaire.
numeroemprunteur2	int	Numéro du second propriétaire.
valeuractuelle	float	Valeur actuelle du bien.
adresse	string	Adresse du bien.
codepostal	string	Code postal de la ville où est situé le bien.
ville	string	Ville où est situé le bien.
pays	string	Pays où est situé le bien.
bienpaye	boolean	Indique si le bien est payé ou non.
sciproprietaire	string	SCI propriétaire.
descriptif	string	Descriptif du bien.
anneeachat	int	Année d'achat du bien.
prixachat	float	Prix d'achat du bien.
type	string	Type du bien. Peut prendre les valeurs suivantes : "Résidence principale", "Résidence secondaire", "Locatif".
biendejahypotheque	boolean	Indique si le bien est déjà hypothéqué.
bienenvente	boolean	Indique si le bien est en vente.
credit	array	Tableau contenant des objets de type "credit". Ce sont les crédits liés au bien immobilier.

Objet de type "credit"

Cet objet contient toutes les informations relatives à un crédit.

Nom	Type	Description
idcredit	string	Identifiant unique du prêt.
numeroemprunteur1	int	Numéro de l'emprunteur lié.
numeroemprunteur2	int	Numéro du second emprunteur lié.
montantinitial	float	Montant initial du prêt.
datedebut	string	Date de début du prêt, au format "dd/mm/yyyy".
mensualite	float	Mensualité du prêt.
rachatpret	boolean	Indique si le prêt est racheté, peut être vrai SEULEMENT dans le cadre d'un rachat de prêt.
nomcredit	string	Nom du crédit.
organismepreteur	string	Nom de l'organisme prêteur.
tauxinterets	float	Taux d'intérêts du prêt.
duree	int	Durée en mois du prêt.
datecapitalrestantdu	string	Date de capital restant dû, au format "dd/mm/yyyy".
capitalrestantdu	float	Capital restant dû.

Objet de type "revenu"

Cet objet contient toutes les informations relatives à un revenu.

Nom	Type	Description
idrevenu	string	Identifiant unique du revenu.
numeroemprunteur	int	Numéro de l'emprunteur lié au revenu.
libelle	string	Nom du revenu.
montant	float	Montant du revenu.
commentaire	string	Commentaire du revenu.
avantprojet	boolean	Infique si le revenu existe avant le projet.
apresprojet	boolean	Infique si le revenu existe après le projet.

Objet de type "charge"

Cet objet contient toutes les informations relatives à une charge.

Nom	Type	Description
idcharge	string	Identifiant unique de la charge.
numeroemprunteur	int	Numéro de l'emprunteur lié à la charge.
libelle	string	Nom de la charge.
montant	float	Montant à la charge.
avantprojet	boolean	Infique si la charge existe avant le projet.
apresprojet	boolean	Infique si la charge existe après le projet.

Objet de type "situationbancaire"

Cet objet contient toutes les informations relatives à une situation bancaire.

Nom	Type	Description
idsituation	string	Identifiant unique de la situation bancaire.
numeroemprunteur1	int	Numéro de l'emprunteur lié à la situation bancaire.
numeroemprunteur2	int	Numéro du second emprunteur lié à la situation bancaire.
numerocompte	string	Numéro de compte.
typecompte	string	Type de compte. Peut prendre les valeurs suivantes : "Compte personnel", "Compte professionnel", "Compte joint", "Compte impôts", "Compte pour les frais".
nombanque	string	Nom de la banque.
anneeclient	int	Nombre d'années d'ancienneté.
moisclient	int	Nombre de mois d'ancienneté.
bic	string	Bank Identifier Code.
iban	string	International Bank Account Number.

Objet de type "souhaitsclient"

Cet objet contient les informations relatives aux souhaits client.

Nom	Type	Description
duree	int	Durée souhaitée du prêt.
mensualite	float	Mensualité souhaitée du prêt.
typetaux	string	Type de taux souhaité. Peut prendre les valeurs suivantes : "Fixe", "Variable".

Objet de type "simulation"

Cet objet contient les informations de départ d'une simulation.

Nom	Type	Description
idsimulation	string	Identifiant unique de la simulation.
coutprojethorsfrais	float	Coût du projet hors frais.
fraisgarantie	float	Frais de garantie.
fraisdossier	float	Frais de dossier.
fraiscourtage	float	Frais de courtage.
fraisagence	float	Frais d'agence.
fraisnotaire	float	Frais de notaire.

10. Modifier un dossier spécifique

PUT https://api10.crediteo.co/dossiers/{iddossier}

Permet de modifier un dossier spécifique appartenant au courtier (identifié via sa clé d'API).

Les données nécessaires sont à transmettre en 2 parties : dans l'URL d'appel et en corps de requête.

Paramètres

Nom	Type	Description	Obligatoire
iddossier	string	Identifiant unique du dossier.	Oui

Exemple :

https://api10.crediteo.co/dossiers/1245-9684

Flux d'entrée

Objet à envoyer

L'objet à envoyer contient lui-même plusieurs objets et tableaux d'objets.

Pour que l'envoi réussisse il faut nécessairement renseigner un emprunteur avec son nom, prénom, email et téléphone.

Nom	Type	Description	Longueur maximale	Obligatoire
emprunteurs	array	Tableau contenant des objets de type "emprunteur".	12	Oui
situationsprofessionnelles	array	Tableau contenant des objets de type "situationprofessionnelle".	-	Non
dossier	dossier	Contient les éléments décrivant le dossier en lui-même.	-	Oui
projet	projet	Contient tous les éléments décrivant un projet.	-	Non
enfants	array	Tableau contenant des objets de type "enfant".	-	Non
biens	array	Tableau contenant des objets de type "bien".	-	Non
creditsconso	array	Tableau contenant des objets de type "credit". Ce sont les crédits à la consommation.	-	Non
autresrevenus	array	Tableau contenant des objets de type "revenu".	-	Non
autrescharges	array	Tableau contenant des objets de type "charge".	-	Non
situationsbancaires	array	Tableau contenant des objets de type "situationbancaire".	-	Non
souhaitsclient	souhaitsclient	Contient les éléments des souhaits client.	-	Non
simulation	array	Tableau contenant des objets de type "simulation".	-	Non

{
  "emprunteurs": [
    {
      "idemprunteur": "1234-5678",
      "titre": "Monsieur",
      "nom": "Dupont",
      "prenom": "Jean",
      "datenaissance": "06/05/1977",
      "villenaissance": "Nancy",
      "situationfamiliale": "Union libre",
      "nationalite": "Française",
      "paysresidence": "France",
      "lienparenteemprunteurprincipal": "Aucun",
      "situationimmo": "Locataire",
      "situationimmodepuis": "04/11/2012",
      "adresse": "6 avenue du général Leclerc",
      "complementadresse": "",
      "codepostal": "54000",
      "ville": "Nancy",
      "pays": "France",
      "email": "jean.dupont@me.com",
      "telephone": "0606060606",
      "telephonefixe": "0383010101",
      "telephonebureau": "0383010102",
      "accordrecueildonnees": true,
      "numero": 0
    },
    {
      "idemprunteur": "2345-6789",
      "titre": "Madame",
      "nom": "Pierre",
      "prenom": "Marie",
      "datenaissance": "06/12/1979",
      "villenaissance": "Nancy",
      "situationfamiliale": "Union libre",
      "nationalite": "Française",
      "paysresidence": "France",
      "lienparenteemprunteurprincipal": "Conjointe",
      "situationimmo": "Locataire",
      "situationimmodepuis": "04/11/2012",
      "adresse": "6 avenue du général Leclerc",
      "complementadresse": "",
      "codepostal": "54000",
      "ville": "Nancy",
      "pays": "France",
      "email": "marie.pierre@me.com",
      "telephone": "0606060607"
      "accordrecueildonnees": false,
      "numero": 1
    }
  ],
  "situationsprofessionnelles": [
    {
      "idsituationprofessionnelle": "6549-1284",
      "numeroemprunteur": 0,
      "categorie": "Salarié(e) Cadre",
      "intitule": "Chef de projet",
      "contrat": "CDI",
      "salairemensuel": 3000.00,
      "payesur": 12,
      "dateembauche": "03/07/2013",
      "periodeessaiterminee": true,
      "revenufiscalrefn1": 36000.00,
      "revenufiscalrefn2": 35000.00,
      "impotrevenu": 2000.00,
      "nomemployeur": "Société",
      "adresse": "26 rue des ponts",
      "complementadresse": "",
      "codepostal": "54000",
      "ville": "Nancy",
      "pays": "France"
    }
  ],
  "dossier": {
    "iddossier": "23156-54875",
    "reference": "DP1233548783214",
    "datedernieremodification": "27/09/2019 15:27"
  },
  "projet": {
    "etatprojet": "Bien trouvé",
    "natureprojet": "Acquisition",
    "destination": "Résidence principale",
    "etatbien": "Ancien",
    "typebien": "Maison",
    "proprietebien": "Pleine propriété",
    "nomvendeur": "Monsieur Francis Berenger",
    "agebien": 15,
    "dpe": "C",
    "nbpersonnes": 4,
    "libelledescriptif": "",
    "listeannexes": "",
    "adressebien": "95 avenue de la libération",
    "complementadresse": "",
    "numeroetage": "0",
    "codepostal": "54000",
    "ville": "Nancy",
    "referencecadastrale": "",
    "autresprecisionsadressebien": "",
    "nbpieces": "F5",
    "surfacehabitable": 100.00,
    "surfaceterrain": 300.00,
    "surfaceterrainmoinsdedeuxans": 0.00,
    "surfaceannexes": 0.00,
    "surfacehabitablecreee": 20.00,
    "surfacelocauxpro": 0.00,
    "autresprecisionssuperficie": "",
    "signaturescompromis": "30/05/2019",
    "conditionsuspensivepret": "",
    "debuttravaux": "",
    "signatureacte": "15/06/2019",
    "livraisonprevisionnelle": ""
  },
  "enfants": [
    {
      "idenfant": "8974-6584",
      "nom": "Dupont",
      "prenom": "Louis",
      "datenaissance": "23/08/2014"
    },
    {
      "idenfant": "6418-8496",
      "nom": "Dupont",
      "prenom": "Nina",
      "datenaissance": "17/10/2018"
    }
  ],
  "biens": [
    {
      "idbien": "65848-31245",
      "numeroemprunteur1": 0,
      "numeroemprunteur2": null,
      "sciproprietaire": "",
      "descriptif": "Studio F2",
      "anneeachat": 2010,
      "prixachat": 70000.00,
      "valeuractuelle": 75000.00,
      "type": "Résidence principale",
      "adresse": "33 rue des pierres",
      "codepostal": "57000",
      "ville": "Metz",
      "pays": "France",
      "bienpaye": false,
      "biendejahypotheque": false,
      "bienenvente": false,
      "credits": [
        {
          "idcredit": "1894-4197",
          "numeroemprunteur1": 0,
          "numeroemprunteur2": null,
          "organismepreteur": "",
          "montantinitial": 72500.00,
          "tauxinterets": 1.20,
          "datedebut": "01/01/2010",
          "duree": 150,
          "mensualite": 520.73,
          "datecapitalrestantdu": "12/04/2019",
          "capitalrestantdu": 19907.81,
          "rachatpret": false
        }
      ]
    }
  ],
  "creditsconso": [
    {
      "idcredit": "8723-4985",
      "numeroemprunteur1": 0,
      "numeroemprunteur2": null,
      "nomcredit": "Crédit voiture",
      "organismepreteur": "",
      "montantinitial": 5000.00,
      "tauxinterets": 0.20,
      "datedebut": "06/06/2018",
      "duree": 12,
      "mensualite": 417.12,
      "datecapitalrestantdu": "12/04/2019",
      "capitalrestantdu": 834.03,
      "rachatpret": false
    }
  ],
  "autresrevenus": [
    {
      "idrevenu": "2894-7826",
      "numeroemprunteur": 0,
      "libelle": "Allocations familiales",
      "montant": 121.49,
      "commentaire": "",
      "avantprojet": true,
      "apresprojet": true
    }
  ],
  "autrescharges": [
    {
      "idcharge": "2894-7826",
      "numeroemprunteur": 0,
      "libelle": "Loyer actuel",
      "montant": 450.00,
      "avantprojet": true,
      "apresprojet": false
    }
  ],
  "situationsbancaires": [
    {
      "idsituation": "71489-87324",
      "numeroemprunteur1": 0,
      "numeroemprunteur2": null,
      "numerocompte": "",
      "typecompte": "Compte joint",
      "nombanque": "CIC",
      "anneeclient": 5,
      "moisclient": 6,
      "bic": "",
      "iban": ""
    }
  ],
  "souhaitsclient": {
    "duree": 200,
    "mensualite": 750.00,
    "typetaux": "Fixe"
  },
  "simulations": [
    {
      "idsimulation": "891274-123675",
      "coutprojethorsfrais": 147000.00,
      "fraisgarantie": 950.00,
      "fraisdossier": 1000.00,
      "fraiscourtage": 1200.00,
      "fraisagence": 0.00,
      "fraisnotaire": 0.00
    }
  ]
}

Description des types

Objet de type "emprunteur"

Nom	Type	Description	Obligatoire
idemprunteur	string	Identifiant unique de l'emprunteur. Initialiser à null pour tout nouvel emprunteur.	Oui
nom	string	Nom de l'emprunteur.	Oui
prenom	string	Prénom de l'emprunteur.	Oui
email	string	Adresse email de l'emprunteur, attention le format doit correspondre à une adresse email valide.	Oui
telephone	string	Numéro de téléphone portable de l'emprunteur.	Oui
numero	int	Numero indiquant l'ordre des emprunteurs. Sert aussi pour les liens entre les entités.	Oui
titre	string	Titre de l'emprunteur.	Non
datenaissance	string	Date de naissance de l'emprunteur, au format "dd/mm/yyyy".	Non
villenaissance	string	Ville de naissance de l'emprunteur.	Non
situationfamiliale	string	Situation familiale de l'emprunteur. Peut prendre une des valeurs suivantes : "Célibataire", "Marié(e)", "Union libre", "Concubinage", "Veuf/Veuve", "Pacsé(e)", "Divorcé(e)", "En instance de séparation".	Non
nationalite	string	Nationalité de l'emprunteur.	Non
paysresidence	string	Pays de résidence de l'emprunteur.	Non
lienparenteemprunteurprincipal	string	Lien de parenté avec l’emprunteur principal. S’il s’agit de l’emprunteur principal mettre "Aucun". Peut prendre une des valeurs suivantes : "Aucun", "Père", "Mère", "Fils", "Fille", "Grand-Père", "Grand-Mère", "Mari", "Femme", "Conjoint", "Conjointe", "Frère", "Soeur", "Belle-fille", "Belle-mère", "Belle-soeur", "Beau-fils", "Beau-père", "Beau-frère", "Cousin", "Cousine", "Oncle", "Tante".	Non
situationimmo	string	Situation immobilière de l’emprunteur. Peut prendre une des valeurs suivantes : "Locataire", "Hébergé(e) à titre gratuit", "Propriétaire".	Non
situationimmodepuis	string	Date de début de la situation immobilière de l'emprunteur, au format "dd/mm/yyyy".	Non
adresse	string	Adresse de l'emprunteur.	Non
complementadresse	string	Complément d'adresse de l'emprunteur.	Non
codepostal	string	Code postal de l'emprunteur.	Non
ville	string	Ville de l'emprunteur.	Non
pays	string	Pays de l'emprunteur.	Non
telephonefixe	string	Numéro de téléphone fixe de l'emprunteur.	Non
telephonebureau	string	Numéro de téléphone du bureau de l'emprunteur.	Non
accordrecueildonnees	boolean	Indique si l'emprunteur a donné son accord pour le recueil de données personnelles.	Non
supprimer	boolean	Indique si l'emprunteur doit être supprimé.	Non

Objet de type "situationprofessionnelle"

Cet objet contient les informations relatives aux situations professionnelles.

Nom	Type	Description	Obligatoire
idsituationprofessionnelle	string	Identifiant unique de la situation professionnelle. Initialiser à null pour toute nouvelle situation professionnelle.	Oui
numeroemprunteur	int	Numéro de l'emprunteur auquel est liée la situation professionnelle.	Oui
categorie	string	Catégorie de la situation professionnelle de l'emprunteur. Peut prendre les valeurs suivantes : "Artisan", "Fonctionnaire Contractuel(le)", "Fonctionnaire Stagiaire", "Fonctionnaire Titulaire", "Intermittent", "Intérimaire", "Retraité(e)", "Salarié(e) Cadre", "Salarié(e) Gérant", "Salarié(e) non-cadre", "Sans profession", "Travailleur Non Salarié", "Vacataire".	Oui
intitule	string	Intitulé de la situation professionnelle de l'emprunteur.	Oui
contrat	string	Type de contrat de l'emprunteur. Peut prendre les valeurs suivantes : "CDI", "CDD", "Contrat d’intérim".	Non
salairemensuel	float	Salaire mensuel de l'emprunteur.	Non
payesur	int	Nombre de mois sur lequel est payé l'emprunteur.	Non
dateembauche	string	Date d'embauche de l'emprunteur, au format "dd/mm/yyyy".	Non
periodeessaiterminee	boolean	Indique si la période d'essai est terminée.	Non
revenufiscalrefn1	float	Revenu fiscal de référence de l'emprunteur pour l'année n-1.	Non
revenufiscalrefn2	float	Revenu fiscal de référence de l'emprunteur pour l'année n-2.	Non
impotrevenu	float	Montant de l'impôt sur le revenu.	Non
nomemployeur	string	Nom de l'employeur de l'emprunteur.	Non
adresse	string	Adresse du lieu de travail de l'emprunteur.	Non
complementadresse	string	Complément d'adresse du lieu de travail de l'emprunteur.	Non
codepostal	string	Code postal du lieu de travail de l'emprunteur.	Non
ville	string	Ville du lieu de travail de l'emprunteur.	Non
pays	string	Pays du lieu de travail de l'emprunteur.	Non
supprimer	boolean	Indique si la situation professionnelle doit être supprimée.	Non

Objet de type "dossier"

Cet objet contient les informations relatives à un dossier.

Nom	Type	Description	Obligatoire
iddossier	string	Identifiant unique du dossier.	Oui
reference	string	Référence du dossier.	Oui
datedernieremodification	string	Date de la dernière modification du dossier, au format "dd/mm/yyyy HH:MM" (22/12/2019 13:37). Si elle n'est pas renseignée, la date et l'heure d'appel de cette route seront utilisées.	Non

Objet de type "projet"

Cet objet contient toutes les informations relatives à un projet. Si un projet est renseigné il faut renseigner toutes les informations obligatoires.

Nom	Type	Description	Obligatoire
natureprojet	string	Nature du projet. Peut prendre les valeurs suivantes : "Achat de SCPI", "Acquisition", "Acquisition + travaux", "Acquisition en VEFA", "Construction", "Crédit professionnel", "Prêt perso", "Rachat de prêt", "Rachat de soulte", "Renégociation de crédits", "Terrain", "Terrain + construction", "Travaux seuls".	Oui
typebien	string	Type du bien à acquérir. Peut prendre les valeurs suivantes : "Maison", "Immeuble", "Appartement", "Terrain seul", "Garage", "Hangar", "Local commercial".	Oui
proprietebien	string	Propriété du bien à acquérir. Peut prendre les valeurs suivantes : "Achat parts", "Pleine propriété", "Usufruit", "Nue propriété".	Non
etatprojet	string	État du projet. Peut prendre les valeurs suivantes : "En recherche de bien", "Bien trouvé", "Offre d'achat effectuée", "Compromis signé".	Non
destination	string	Destination du projet. Peut prendre les valeurs suivantes : "Résidence principale", "Résidence locative", "Résidence secondaire", "Résidence mixte", "Local commercial".	Non
etatbien	string	État du bien à acquérir. Peut prendre les valeurs suivantes : "Neuf", "Ancien".	Non
nomvendeur	string	Nom du vendeur du bien.	Non
agebien	int	Âge du bien en années.	Non
dpe	char	Diagnostic de performance énergétique. Peut prendre les valeurs suivantes : "A", "B", "C", "D", "E", "F", "G".	Non
nbpersonnes	int	Nombre de personnes occupant le logement.	Non
libelledescriptif	string	Libellé descriptif.	Non
listeannexes	string	Liste des annexes.	Non
adressebien	string	Adresse du bien.	Non
complementadresse	string	Complément d'adresse du bien.	Non
numeroetage	string	Numéro d'étage ou de lot.	Non
codepostal	string	Code postal de la ville où est situé le bien.	Non
ville	string	Ville où est situé le bien.	Non
referencecadastrale	string	Référence cadastrale du bien.	Non
autresprecisionsadressebien	string	Autres précisions sur l'adresse du bien.	Non
nbpieces	string	Nombre de pièces du bien.	Non
surfacehabitable	float	Surface habitable, en mètres carrés.	Non
surfaceterrain	float	Surface du terrain, en mètres carrés.	Non
surfaceterrainmoinsdedeuxans	float	Surface du terrain acquis depuis moins de deux ans, en mètres carrés.	Non
surfaceannexes	float	Surface des annexes, en mètres carrés.	Non
surfacehabitablecreee	float	Surface habitable créée par des travaux, en mètres carrés.	Non
surfacelocauxpro	float	Surface des locaux professionnels, en mètres carrés.	Non
autresprecisionssuperficie	string	Autres précisions sur la superficie.	Non
signaturescompromis	string	Date de signatures du compromis, au format "dd/mm/yyyy".	Non
conditionsuspensivepret	string	Date de condition suspensive de prêt, au format "dd/mm/yyyy".	Non
debuttravaux	string	Date de début des travaux, au format "dd/mm/yyyy".	Non
signatureacte	string	Date de signature de l'acte, au format "dd/mm/yyyy".	Non
livraisonprevisionnelle	string	Date de livraison prévisionnelle, au format "dd/mm/yyyy".	Non

Objet de type "enfant"

Cet objet contient toutes les informations relatives à un enfant. Si un enfant est renseigné il faut renseigner toutes les informations obligatoires.

Nom	Type	Description	Obligatoire
idenfant	string	Identifiant unique de l'enfant. Initialiser à null pour tout nouvel enfant.	Oui
nom	string	Nom de l'enfant.	Oui
prenom	string	Prénom de l'enfant.	Oui
datenaissance	string	Date de naissance de l'enfant, au format "dd/mm/yyyy".	Oui
supprimer	boolean	Indique si l'enfant doit être supprimé.	Non

Objet de type "bien"

Cet objet contient toutes les informations relatives à un bien. Si un bien est renseigné il faut renseigner toutes les informations obligatoires.

Nom	Type	Description	Obligatoire
idbien	string	Identifiant unique du bien. Initialiser à null pour tout nouveau bien.	Oui
numeroemprunteur1	int	Numéro du propriétaire.	Oui
numeroemprunteur2	int	Numéro du second propriétaire.	Non
valeuractuelle	float	Valeur actuelle du bien.	Oui
adresse	string	Adresse du bien.	Oui
codepostal	string	Code postal de la ville où est situé le bien.	Oui
ville	string	Ville où est situé le bien.	Oui
pays	string	Pays où est situé le bien.	Oui
bienpaye	boolean	Indique si le bien est payé ou non.	Oui
sciproprietaire	string	SCI propriétaire.	Non
descriptif	string	Descriptif du bien.	Non
anneeachat	int	Année d'achat du bien.	Non
prixachat	float	Prix d'achat du bien.	Non
type	string	Type du bien. Peut prendre les valeurs suivantes : "Résidence principale", "Résidence secondaire", "Locatif".	Non
biendejahypotheque	boolean	Indique si le bien est déjà hypothéqué.	Non
bienenvente	boolean	Indique si le bien est en vente.	Non
credit	credit	Renseigne le crédit lié au bien s'il y en a un. Attention si le bien est payé il ne peut pas y avoir de crédit associé.	Non
supprimer	boolean	Indique si le bien doit être supprimé.	Non

Objet de type "credit"

Cet objet contient toutes les informations relatives à un crédit. Si un crédit est renseigné il faut renseigner toutes les informations obligatoires.

Nom	Type	Description	Obligatoire
idcredit	string	Identifiant unique du prêt. Initialiser à null pour tout nouveau prêt.	Oui
numeroemprunteur1	int	Numéro de l'emprunteur lié.	Oui
numeroemprunteur2	int	Numéro du second emprunteur lié.	Non
montantinitial	float	Montant initial du prêt.	Oui
datedebut	string	Date de début du prêt, au format "dd/mm/yyyy".	Oui
mensualite	float	Mensualité du prêt.	Oui
rachatpret	boolean	Indique si le prêt est racheté, peut être vrai SEULEMENT dans le cadre d'un rachat de prêt.	Oui
nomcredit	string	Nom du crédit.	Non
organismepreteur	string	Nom de l'organisme prêteur.	Non
tauxinterets	float	Taux d'intérêts du prêt.	Non
duree	int	Durée en mois du prêt.	Non
datecapitalrestantdu	string	Date de capital restant dû, au format "dd/mm/yyyy".	Non
capitalrestantdu	float	Capital restant dû.	Non
supprimer	boolean	Indique si le crédit doit être supprimé.	Non

Objet de type "revenu"

Cet objet contient toutes les informations relatives à un revenu.

Nom	Type	Description	Obligatoire
idrevenu	string	Identifiant unique du revenu. Initialiser à null pour tout nouveau revenu.	Oui
numeroemprunteur	int	Numéro de l'emprunteur lié au revenu.	Oui
montant	float	Montant du revenu.	Oui
libelle	string	Nom du revenu.	Non
commentaire	string	Commentaire du revenu.	Non
avantprojet	boolean	Infique si le revenu existe avant le projet.	Non
apresprojet	boolean	Infique si le revenu existe après le projet.	Non
supprimer	boolean	Indique si le revenu doit être supprimé.	Non

Objet de type "charge"

Cet objet contient toutes les informations relatives à une charge.

Nom	Type	Description	Obligatoire
idcharge	string	Identifiant unique de la charge. Initialiser à null pour toute nouvelle charge.	Oui
numeroemprunteur	int	Numéro de l'emprunteur lié à la charge.	Oui
montant	float	Montant de la charge.	Oui
libelle	string	Nom de la charge.	Non
avantprojet	boolean	Infique si la charge existe avant le projet.	Non
apresprojet	boolean	Infique si la charge existe après le projet.	Non
supprimer	boolean	Indique si la charge doit être supprimée.	Non

Objet de type "situationbancaire"

Cet objet contient toutes les informations relatives à une situation bancaire.

Nom	Type	Description	Obligatoire
idsituation	string	Identifiant unique de la situation bancaire. Initialiser à null pour toute nouvelle situation bancaire.	Oui
numeroemprunteur1	int	Numéro de l'emprunteur lié à la situation bancaire.	Oui
numeroemprunteur2	int	Numéro du second emprunteur lié à la situation bancaire.	Non
numerocompte	string	Numéro de compte.	Non
typecompte	string	Type de compte. Peut prendre les valeurs suivantes : "Compte personnel", "Compte professionnel", "Compte joint", "Compte impôts", "Compte pour les frais".	Non
nombanque	string	Nom de la banque.	Non
anneeclient	int	Nombre d'années d'ancienneté.	Non
moisclient	int	Nombre de mois d'ancienneté, inférieur à 12.	Non
bic	string	Bank Identifier Code, de longueur inférieure ou égale à 11 caractères.	Non
iban	string	International Bank Account Number, de longueur inférieure ou égale à 34 caractères.	Non
supprimer	boolean	Indique si la situation bancaire doit être supprimée.	Non

Objet de type "souhaitsclient"

Cet objet contient les informations relatives aux souhaits client.

Nom	Type	Description	Obligatoire
duree	int	Durée souhaitée du prêt.	Non
mensualite	float	Mensualité souhaitée du prêt.	Non
typetaux	string	Type de taux souhaité. Peut prendre les valeurs suivantes : "Fixe", "Variable".	Non

Objet de type "simulation"

Cet objet contient les informations de départ d'une simulation.

Nom	Type	Description	Obligatoire
idsimulation	string	Identifiant unique de la simulation. Initialiser à null pour toute nouvelle simulation.	Oui
coutprojethorsfrais	float	Coût du projet hors frais.	Non
fraisgarantie	float	Frais de garantie.	Non
fraisdossier	float	Frais de dossier.	Non
fraiscourtage	float	Frais de courtage.	Non
fraisagence	float	Frais d'agence.	Non
fraisnotaire	float	Frais de notaire.	Non
supprimer	boolean	Indique si la simulation doit être supprimée.	Non

Flux de sortie

Nom	Type	Description
dossier	object	Dossier du prospect créé. Contient la référence et l'identifiant du dossier.

Si les informations envoyées sont valides, le dossier sera modifié et vous recevrez un objet du type :

{
    "dossier": {
        "reference": "...", // Référence du dossier
        "iddossier": "..." // Identifiant du dossier
    }
}

reference étant la référence du dossier créé et iddossier son identifiant.

Si vous recevez une erreur, référez-vous à l'intitulé de l'erreur et au paragraphe concernant les erreurs.

11. Calculatrice d’emprunt

POST https://api10.crediteo.co/calculatriceemprunt

Pour calculer les informations relatives à un emprunt il vous faut : son montant, son taux, sa durée et sa date de début (au format dd/mm/yyyy).

Comme pour la création d’un prospect votre entête HTML doit contenir les informations nécessaires pour vous authentifier et le champ Content-Type renseigné avec "application/json".

Les données nécessaires sont à envoyer au format json via un POST sur la route https://api10.crediteo.co/calculatriceemprunt.

Flux d'entrée

Nom	Type	Description
montant	float	Montant du prêt.
duree	int	Durée du prêt en mois.
taux	float	Taux d'intérêts du prêt.
datedebut	string	Date de début du prêt au format "dd/mm/yyyy".

Exemple :

{
    "montant": 150000,
    "duree": 180,
    "taux": 1.35,
    "datedebut": "01/01/2019"
}

Flux de sortie

Nom	Type	Description
mensualite	float	Mensualité du prêt.
totalpaiements	float	Total des paiements.
totalinterets	float	Total des intérêts.
datefin	string	Date de fin du prêt au format "dd/mm/yyyy".

Si le formulaire est correctement rempli vous devriez recevoir une réponse contenant : la mensualité, la date de fin, le total des paiements et le total des intérêts.

Exemple :

{
    "mensualite": 921.02111011349,
    "totalpaiements": 165783.79982043,
    "totalinterets": 15783.799820433,
    "datefin": "01/01/2034"
}

Si votre requête vous retourne une erreur référez-vous au paragraphe concernant les erreurs.

12. Calculatrice PTZ

POST https://api10.crediteo.co/calculatriceptz

La calculatrice PTZ permet de connaître l'éligibilité d'un projet au PTZ et le cas échéant son montant.

Pour cela il vous faudra envoyer plusieurs informations à la route POST https://api10.crediteo.co/calculatriceptz en vous authentifiant correctement.

Flux d'entrée

Nom	Type	Description
primoaccedant	string	Indique si l'emprunteur est un primo accédant.
carteinvalidite	string	Indique si l'emprunteur est titulaire d'une carte d'invalidité.
pensioninvalidite	string	Indique si l'emprunteur perçoit une pension d'invalidité.
allocationhandicape	string	Indique si l'emprunteur perçoit une allocation pour un handicap.
catastrophenaturelle	string	Indique si l'emprunteur est victime d'une catastrophe naturelle.
logementhlm	string	Indique si l'emprunteur veut acquérir un logement HLM.
revenufiscalreference	float	Revenu fiscal de référence de l'emprunteur (doit être supérieur à 0).
codepostal	string	Code postal du lieu où l'emprunteur envisage d'acheter.
ville	string	Facultatif. Ville où l'emprunteur envisage d'acheter.
etatbien	string	État du bien à acquérir. Peut prendre les valeurs "Neuf" ou "Ancien".
natureprojet	string	Nature du projet. Peut prendre les valeurs : "Acquisition", "Acquisition + travaux", "Acquisition en VEFA", "Construction", "Terrain + construction".
couttravaux	float	Coût des travaux envisagés.
couttotalprojet	float	Coût total du projet.
nboccupants	int	Nombre de personnes censées occuper le logement (doit être supérieur à 0).

Exemple :

{
    "primoaccedant": "true",
    "carteinvalidite": "false",
    "pensioninvalidite": "false",
    "allocationhandicape": "false",
    "catastrophenaturelle": "false",
    "logementhlm": "false",
    "revenufiscalreference": 20000.00,
    "codepostal": "75000",
    "ville": "",
    "etatbien": "Neuf",
    "natureprojet": "Acquisition",
    "couttravaux": 50000.00,
    "couttotalprojet": 200000.00,
    "nboccupants": 3
}

Flux de sortie

Si votre formulaire est correctement rempli et que votre projet est éligible vous recevrez une réponse contenant le montant maximum, le différé, la durée, la mensualité et le montant des autres prêts.

Nom	Type	Description
montantmaximum	float	Montant maximum empruntable en PTZ pour le projet.
differe	int	Différé total du PTZ en mois.
duree	int	Durée totale du PTZ en mois.
mensualite	float	Mensualité du PTZ.
montantautrescredits	float	Montant des autres crédits à effectuer pour financer le projet.

Exemple :

{
    "montantmaximum": 80000,
    "differe": 180,
    "duree": 120,
    "mensualite": 666.6666666666666,
    "montantautrescredits": 120000
}

Si vous avez correctement rempli le formulaire mais que le projet n'est pas éligible vous recevrez une réponse contenant le message "Projet non éligible".

Exemple :

{
    "message": "Projet non éligible"
}

Si vous recevez une erreur référez-vous au paragraphe concernant les erreurs.

13. Calculatrice de capacité d'emprunt

POST https://api10.crediteo.co/calculatricecapaciteemprunt

La calculatrice de capacité d'emprunt vous permet de connaître votre capacité d'emprunt et la valeur du bien à acquérir.

Pour cela il vous faudra envoyer plusieurs informations à la route POST https://api10.crediteo.co/calculatricecapaciteemprunt en vous authentifiant correctement. Attention il faut renseigner soit le champ "mensualite" soit le champ "endettement" mais pas les deux en même temps.

Flux d'entrée

Nom	Type	Description
revenumensuel	float	Revenu mensuel de l'emprunteur (doit être supérieur à 0).
taux	float	Taux d'intérêts souhaité (doit être supérieur ou égal à 0).
endettement	float	Taux d'endettement souhaité (doit être supérieur à 0). Ne peut excéder 50%. Attention il vous faut renseigner soit ce champ soit le champ "mensualite" mais pas les deux en même temps.
mensualite	float	Mensualité souhaitée (doit être supérieur à 0). Ne peut excéder 50% du revenu mensuel. Attention il vous faut renseigner soit ce champ soit le champ "endettement" mais pas les deux en même temps.
duree	int	Durée souhaitée du prêt en mois (doit être supérieur à 0). Ne peut excéder 540 mois.

Exemple :

{
    "revenumensuel": 2000.00,
    "taux": 1.80,
    "endettement": 33,
    "duree": 300
}

Flux de sortie

Si votre formulaire est correctement rempli vous recevrez la capacité d'emprunt, la valeur du bien à acquérir et le taux d'endettement (si vous avez renseigné la mensualité) ou la mensualité (si vous avez renseigné le taux d'endettement).

Nom	Type	Description
capacite	float	Capacité maximale d'emprunt.
valeurbien	float	Valeur du bien à acquérir.
endettement	float	Taux d'endettement.
mensualite	float	Mensualité.

Exemple :

{
    "capacite": 159349.00413884307,
    "valeurbien": 143414.10372495875,
    "mensualite": 660
}

Si vous recevez une erreur référez-vous au paragraphe concernant les erreurs.

14. Calculatrice de rachat de prêt

POST https://api10.crediteo.co/calculatricerachatpret

La calculatrice de rachat de prêt vous permet d'évaluer votre gain en trésorerie et en coût de crédit dans le cadre d'un rachat de prêt.

Pour cela il vous faudra envoyer plusieurs informations à la route POST https://api10.crediteo.co/calculatricerachatpret en vous authentifiant correctement.

Flux d'entrée

Nom	Type	Description
montantancien	float	Montant initial du prêt à racheter (doit être supérieur à 0).
datedebutancien	string	Date de début du prêt à racheter au format "dd/mm/yyyy".
dureeancien	int	Durée initiale du prêt à racheter en mois (doit être supérieure ou égale à 1 et inférieure ou égale à 540).
tauxhaancien	float	Taux hors assurance du prêt à racheter (doit être supérieur ou égal à 0).
typeassuranceancien	string	Type d'assurance du prêt à racheter. Peut prendre les valeurs "CI" (Capital Initial) ou "CRD" (Capital Restant Dû).
tauxassuranceancien	float	Taux d'assurance du prêt à racheter (doit être supérieur ou égal à 0).
daterachat	string	Date de rachat du prêt au format "dd/mm/yyyy" (doit être supérieure ou égale à la date courante).
fraisnouvellegarantie	float	Facultatif. Frais de la garantie sur le nouveau prêt (doit être supérieur ou égal à 0).
fraisdossier	float	Facultatif. Frais de dossier du nouveau prêt (doit être supérieur ou égal à 0).
fraiscourtage	float	Facultatif. Frais de courtage du nouveau prêt (doit être supérieur ou égal à 0).
dureenouveau	int	Durée du nouveau prêt en mois (doit être supérieure ou égale à 1 et inférieure ou égale à 540).
tauxnominalnouveau	float	Taux nominal du nouveau prêt (doit être supérieur ou égal à 0).
tauxassurancenouveau	float	Taux d'assurance du nouveau prêt (doit être supérieur ou égal à 0).

À noter que le prêt en cours ne doit pas être fini.

Exemple :

{
    "montantancien": 150000,
    "datedebutancien": "01/01/2014",
    "dureeancien": 200,
    "tauxhaancien": 1.30,
    "typeassuranceancien": "CI",
    "tauxassuranceancien": 0.125,
    "daterachat": "11/04/2022",
    "fraisnouvellegarantie": 200,
    "fraisdossier": 100,
    "fraiscourtage": 300,
    "dureenouveau": 70,
    "tauxnominalnouveau": 1.25,
    "tauxassurancenouveau": 0.1
}

Flux de sortie

Si votre formulaire est correctement rempli vous recevrez le gain de tésorerie, le gain en coût de crédit et pour l'ancien prêt, le nouveau prêt et la différence entre les deux vous recevrez le nombre de mensualités, la mensualité hors assurance, la mensualité assurance comprise et le coût restant du crédit.

Nom	Type	Description
gaintresorerie	float	Gain en trésorerie du rachat de prêt.
gaincoutcredit	float	Gain en coût de crédit du rachat de prêt.
resultats	array	Tableau des résultats. C'est un tableau de tableaux où la première case correspond à l'ancien prêt, la deuxième au nouveau prêt et la troisième à la différence entre les deux. Le premier tableau correspond au nombre de mensualités. Le deuxième tableau correspond à la mensualité hors assurance. Le troisième tableau correspond à la mensualité assurance comprise. Le quatrième tableau correspond au coût restant du crédit.

Exemple :

{
    "gaintresorerie": 1523.99,
    "gaincoutcredit": 2579.09,
    "resultats": [
        [89, 70, 19],
        [834.59, 1053.29, -218.7],
        [850.21, 1059.21, -209],
        [5653.4, 3074.31, 2579.09]
    ]
}

Si vous recevez une erreur référez-vous au paragraphe concernant les erreurs.

15. Calcul des frais de notaire

POST https://api10.crediteo.co/fraisnotaire

Cette route vous permet de calculer les frais de notaire d'un projet, en indiquant l'état du bien, la nature du projet et le prix du projet.

Pour cela il vous faudra envoyer plusieurs informations à la route POST https://api10.crediteo.co/fraisnotaire en vous authentifiant correctement.

Flux d'entrée

Nom	Type	Description
etatbien	string	État du bien. Peut prendre les valeurs : "Neuf", "Ancien".
natureprojet	string	Nature du projet. Peut prendre les valeurs : "Achat de SCPI", "Acquisition", "Acquisition + travaux", "Acquisition en VEFA", "Construction", "Crédit professionnel", "Prêt perso", "Rachat de prêt", "Rachat de soulte", "Renégociation de crédits", "Terrain", "Terrain + construction", "Travaux seuls".
prix	float	Prix du projet. Pour une "Acquisition", une "Acquisition + travaux" ou un "Rachat de soulte", renseigner le prix d'achat. Pour une "Acquisition en VEFA", renseigner le prix de construction. Pour un "Terrain" ou un "Terrain + construction", renseigner le prix du terrain.
prixmobilier	float	Facultatif. Prix du mobilier inclus dans le prix, pris en compte uniquement dans le cadre d'une "Acquisition" ou d'une "Acquisition + travaux".

Exemple :

{
    "etatbien" : "Neuf",
    "natureprojet" : "Acquisition",
    "prix" : 160000.00,
    "prixmobilier" : 10000.00
}

Flux de sortie

Si votre formulaire est correctement rempli vous recevrez les frais de notaire.

Nom	Type	Description
fraisnotaire	float	Frais de notaire.

Exemple :

{
    "fraisnotaire" : 4534.19
}

Si vous recevez une erreur référez-vous au paragraphe concernant les erreurs.

16. Générateur URL iFrame

Choisissez l'iframe souhaitée :

Utiliser le logo manuscrit

Utiliser la charte graphique de mon entreprise

Insérez votre clé API ci-dessous :

Générer l'URL

17. Routes de peuplement de sélecteur

GET https://api10.crediteo.co/selecteurs/{nomselecteur}?debut={debut}

Ces routes vous permettent d'obtenir les options de peuplement d'un sélecteur.

Pour cela il vous faudra appeler la route GET https://api10.crediteo.co/selecteurs/{nomselecteur} en remplaçant "{nomselecteur}" par le nom du sélecteur de votre choix en vous authentifiant correctement.

Option

Il est également possible d'ajouter un paramètre "debut" à la route avec comme valeur le début d'une chaîne de caractères afin de filtrer les valeurs de sortie du sélecteur.

Exemple :

La route GET https://api10.crediteo.co/selecteurs/pays?debut=f retournera uniquement les pays commençant par la lettre "F".

Sortie :

{
    "options": [
        "Fédération de Russie",
        "Fidji",
        "Finlande",
        "France"
    ]
}

Flux de sortie

Toutes ces routes retournent un objet contenant la propriété "options" qui est elle même un tableau de chaînes de caractères contenant les différentes options pour le sélecteur. L'objet de retour peut, dans certains cas, avoir une propriété "selected" qui contient une chaîne de caractères correspond à la valeur par défaut du sélecteur.

Nom	Type	Description
options	array	Tableau de chaînes de caractères contenant les différentes options pour le sélecteur.
selected	string	Optionnel. Contient une chaîne de caractères correspond à la valeur par défaut du sélecteur.

GET https://api10.crediteo.co/selecteurs/typebienprojet

Sortie :

{
    "options": [
        "Maison",
        "Immeuble",
        "Appartement",
        "Terrain seul",
        "Garage",
        "Hangar",
        "Local commercial"
    ],
    "selected": "Maison"
}

GET https://api10.crediteo.co/selecteurs/typebien

Sortie :

{
    "options": [
        "Résidence principale",
        "Locatif",
        "Résidence secondaire",
        "Terrain"
    ]
}

GET https://api10.crediteo.co/selecteurs/civilite

Sortie :

{
    "options": [
        "Monsieur",
        "Madame",
        "Mademoiselle"
    ],
    "selected": "Monsieur"
}

GET https://api10.crediteo.co/selecteurs/situationfamiliale

Sortie :

{
    "options": [
        "Célibataire",
        "Marié(e)",
        "Union libre",
        "Concubinage",
        "Veuf/Veuve",
        "Divorcé(e)",
        "Pacsé(e)",
        "En instance de séparation"
    ],
    "selected": "Célibataire"
}

GET https://api10.crediteo.co/selecteurs/lienparente

Sortie :

{
    "options": [
        "Aucun",
        "Père",
        "Mère",
        "Fils",
        "Fille",
        "Grand-Père",
        "Grand-Mère",
        "Mari",
        "Femme",
        "Conjoint",
        "Conjointe",
        "Frère",
        "Soeur",
        "Belle-fille",
        "Belle-mère",
        "Belle-soeur",
        "Beau-fils",
        "Beau-père",
        "Beau-frère",
        "Cousin",
        "Cousine",
        "Oncle",
        "Tante"
    ],
    "selected": "Aucun"
}

GET https://api10.crediteo.co/selecteurs/situationimmo

Sortie :

{
    "options": [
        "Hébergé(e) à titre gratuit",
        "Locataire",
        "Propriétaire"
    ]
}

GET https://api10.crediteo.co/selecteurs/etatbien

Sortie :

{
    "options": [
        "Neuf",
        "Ancien"
    ],
    "selected": "Neuf"
}

GET https://api10.crediteo.co/selecteurs/dpe

Sortie :

{
    "options": [
        "A",
        "B",
        "C",
        "D",
        "E",
        "F",
        "G"
    ],
    "selected": "A"
}

GET https://api10.crediteo.co/selecteurs/natureprojet

Sortie :

{
    "options": [
        "Achat de SCPI",
        "Acquisition",
        "Acquisition + travaux",
        "Acquisition en VEFA",
        "Construction",
        "Crédit professionnel",
        "Prêt perso",
        "Rachat de prêt",
        "Rachat de soulte",
        "Renégociation de crédits",
        "Terrain",
        "Terrain + construction",
        "Travaux seuls"
    ],
    "selected": "Achat de SCPI"
}

GET https://api10.crediteo.co/selecteurs/proprietebien

Sortie :

{
    "options": [
        "Achat parts",
        "Pleine propriété",
        "Usufruit",
        "Nue propriété"
    ],
    "selected": "Pleine propriété"
}

GET https://api10.crediteo.co/selecteurs/etatprojet

Sortie :

{
    "options": [
        "En recherche de bien",
        "Bien trouvé",
        "Offre d'achat effectuée",
        "Compromis signé"
    ],
    "selected": "En recherche de bien"
}

GET https://api10.crediteo.co/selecteurs/destinationprojet

Sortie :

{
    "options": [
        "Résidence principale",
        "Résidence locative",
        "Résidence secondaire",
        "Résidence mixte",
        "Local commercial"
    ],
    "selected": "Résidence principale"
}

GET https://api10.crediteo.co/selecteurs/nbpieces

Sortie :

{
    "options": [
        "T1",
        "T2",
        "T3",
        "T4",
        "T5",
        "T6"
    ],
    "selected": "T1"
}

GET https://api10.crediteo.co/selecteurs/typecompte

Sortie :

{
    "options": [
        "Compte personnel",
        "Compte professionnel",
        "Compte joint",
        "Compte impôts",
        "Compte pour les frais"
    ],
    "selected": "Compte personnel"
}

GET https://api10.crediteo.co/selecteurs/typetaux

Sortie :

{
    "options": [
        "Fixe",
        "Variable"
    ],
    "selected": "Fixe"
}

GET https://api10.crediteo.co/selecteurs/typecontrat

Sortie :

{
    "options": [
        "CDI",
        "CDD",
        "Contrat d'intérim"
    ]
}

GET https://api10.crediteo.co/selecteurs/categorieprofessionnelle

Sortie :

{
    "options": [
        "Artisan",
        "Fonctionnaire Contractuel(le)",
        "Fonctionnaire Stagiaire",
        "Fonctionnaire Titulaire",
        "Intermittent",
        "Intérimaire",
        "Profession libérale",
        "Retraité(e)",
        "Salarié(e) Cadre",
        "Salarié(e) Gérant",
        "Salarié(e) non-cadre",
        "Sans profession",
        "Travailleur Non Salarié",
        "Vacataire"
    ]
}

GET https://api10.crediteo.co/selecteurs/pays

Sortie :

{
    "options": [
        "Afghanistan",
        "Afrique du Sud",
        "Albanie",
        "...",
        "France",
        "...",
        "Yémen",
        "Zambie",
        "Zimbabwe"
    ]
}

GET https://api10.crediteo.co/selecteurs/nationalites

Sortie :

{
    "options": [
        "Afghane",
        "Albanaise",
        "Algérienne",
        "...",
        "Française",
        "...",
        "Yéménite",
        "Zambienne",
        "Zimbabwéenne"
    ]
}

Si vous recevez une erreur référez-vous au paragraphe concernant les erreurs.

18. Contact

Vous rencontrez des problèmes lors de votre intégration ? Vous trouvez qu'il manque des informations ?

Contactez-nous