Sommaire

- Introduction
- Authentification
- Clé API
- Classification
- Extraction
- Documents acceptés

Authentification


Notre API utilise le Json Web Token “JWT” pour authentifier le client. Les paramètres authentification sont à placer dans le Header de la requête.


Usage

Le token d’authentification doit être placé dans le header de toute requête, formaté de la manière suivante:

Authorization: JWT <access_token>


https://api.eazyrent.fr:9000/api/token/obtain


Paramètres:

email, password : vos identifiants de connexion distribués par EazyRent. 

Output:
{
    "refresh": refresh_token,
    "access": access_token
}

Access token lifetime: 60 mins

Refresh token lifetime: 14 jours


https://api.eazyrent.fr:9000/api/token/refresh/


Paramètres:

 

refresh : le token “refresh”, obtenu via la requête /token/obtain.


Output:
{
    "access": access_token,
    "refresh": refresh_token
}

Access token lifetime: 60 mins

Refresh token lifetime: 14 jours


cf. jwt documentation. https://jwt.io/

Classification

Les paramètres pour la classification sont à placer dans le body de la requête.


https://api.eazyrent.fr:9000/api/file/classify/


Paramètres:

file: un document image ou pdf

formats acceptés: PDF, PNG, JPG, JPEG,  GIF. Documents acceptés: cf section Documents acceptés.



Output:
json {“file_name”: "file_type"}


https://api.eazyrent.fr:9000/api/multipage_pdf/classify/


paramètres:


pdf_file: un fichier pdf contenant les documents à analyser.

format accepté: .pdf ; Les pdf sont séparés page par page puis classifiés et analysés, les documents multipages sont recollés avant l’analyse. Documents acceptés: cf section Documents acceptés.

Output:
json {“file_name1”: "file_type1", “file_name2”: "file_type2", … }

https://api.eazyrent.fr:9000/api/zip/classify/


Paramètres:

zip_file: un fichier zip contenant les documents à classifier.

Formats accepté: .zip ; formats acceptés pour les documents: PDF, PNG, JPG, JPEG,  GIF. Documents acceptés: cf section Documents acceptés.

json {“file_name1”: "file_type1", “file_name2”: "file_type2", … }

Clé API


La clé api doit être placée dans le header de la requête, formaté de la manière suivante:

Authorization: Api-Key <API_KEY>


où <API_KEY> fait référence à la clé API qui vous a été donnée.


Pour obtenir une clé API, merci de nous contacter par email via [email protected]

Documents acceptés

CNI

json{ "prenom":  "", "nom": "", "sexe": "", "date_naissance": "", "lieu_naissance":  "", "adresse": "", "MRZ_CNI": "", "date_validite_CNI": "", "validite_MRZ":"0/1"}

Passeport

json{ "prenom":  "", "nom": "", "sexe": "", "date_naissance": "", "lieu_naissance":  "", "adresse": "", "MRZ_passeport": "", "date_validite_passeport": "", "validite_MRZ": "0/1"}

Permis de conduire

json{ "prenom":  "", "nom": "", "sexe": "", "date_naissance": "", "lieu_naissance":  "", "date_delivrance": "", "MRZ_permis": "", "date_validite_permis": ""}

Kbis

json {"immatriculation_au_RCS": "",
"date_immatriculation": "",
"denomination_ou_raison_sociale": "",
"capital_social": "",
"adresse_siege": "",
"nom_president": "",
"prenom_president": "",
"date_naissance_president": "",
"lieu_naissance_president": "",

Facture 

json{"date": "",
     "numero_facture": "", 
     "montant": "", 
     "nom_entreprise": ""
    }

RIB

json {
    "IBAN": "",
    "BIC": "",
    "code_banque": "",
    "code_guicher": "",
    "numero_compte": "",
    "cle_rib": "",
    "domiciliation": "",
    "titulaire": ""
}

Avis d’imposition:

json {
    "salaires_brut_annuel": "",
    "salaire_brut_global": "",
    "status_familial": "",
    "RFR": "",
    "nb_enfants_charge": "",
    "numero_fiscal": "",
    "reference_avis": "",
    "nom": "",
    "nom_declarant_2": "",
    "nom_de_naissance": "",
    "nom_de_naissance_declarant_2": "",
    "prenom": "",
    "prenom_declarant_2": "",
    "date_naissance_impot.gouv": "",
    "date_naissance_impot.gouv_declarant_2": "",
    "status_familial_impot.gouv": "",
    "adresse": "",
    "date_mise_en_recouvrement": "",
    "date_etablissement": "",
    "nombre_de_parts": "",
    "revenu_brut_global": "",
    "revenu_imposable": "",
    "impot_sur_revenu_net_avant_corrections": "",
    "montant_impot": "",
    "verifications": 
        {"existance_impot.gouv": "0/1",      
        "comparaison_status_familial_impot.gouv": "0/1",
        “comparaison_date_naissance_avis_impot.gouv": "0/1",
        }
    }

Bulletin de salaire

json {   
    "nom_employeur": "",
    "adresse_employeur": "",
    "siret": "",
    "date_debut": "",
    "date_fin": "",
    "nom_employe": "",
    "prenom_employe": "",
    "adresse_employe": "",
    "date_entree": "",
    "anciennete": "",
    "sec_sociale": "",
    "type_contrat": "",
    "salaire_de_base": "",
    "salaire_brut_mensuel": "",
    "salaire_net_imposable_mensuel": "",
    "salaire_net_mensuel": "",
    "cumul_salaire_annuel": "",
    "cumul_charges_salariales_periode": "",
    "cumul_charge_salariales_annuel": "",
    "cumul_charges_patronales_periode": "",
    "cumul_charges_patronales_annuel": "",
    "cumul_heures_periode": "",
    "cumul_heures_annuel": "",
    "cumul_conges_periode": "",
    "cumul_conges_annuel": "",
    "saisie_sur_salaire": "",
    "avis_tiers_detenteur": "",
    "opposition": "",
    "cession_dettes_ordinaires": "",
    "retenue": "",
    "verifications": {"siret_societe.com":""}
}

Extraction

Les paramètres pour l’extraction sont à placer dans le body de la requête.

https://api.eazyrent.fr:9000/api/file/extraction/


Paramètres:

file: un fichier image ou pdf en base 64 contenant les documents à analyser.

Formats acceptés: PDF, PNG, JPG, JPEG,  GIF.  Documents acceptés: cf section Documents acceptés.


Output: 
json {"file_type": {"field1": "value1", "field2": "value2", ... }

https://api.eazyrent.fr:9000/api/multipage_pdf/extraction/


paramètres:


pdf_file: un fichier pdf contenant les documents à analyser.

format accepté: .pdf ; Les pdf sont séparés page par page puis classifiés et analysés, les documents multipages sont recollés avant l’analyse. Documents acceptés: cf section Documents acceptés.


output:

 

json{"file_name1": {“file_type”: "file_type", “field1”: "value1"}, "file_name2": {“file_type”: "file_type", “field1”: "value1"}, ..., "common": {“common_field1”: "value1", ... , “scoring”: "scoring%"}}

où “common” contient des vérifications recoupant les différents documents (exemple: “comparaison_nom_CNI_avis_imposition”: 0 si les noms diffèrent entre l’avis d’imposition et la CNI)


https://api.eazyrent.fr:9000/api/zip/extraction/


Paramètres:

zip_file: un fichier zip contenant les documents à analyser.

Format accepté: .zip ; formats acceptés pour les documents: PDF, PNG, JPG, JPEG,  GIF.  Les documents images de plusieurs pages doivent être concaténés en une seule image. Documents acceptés: cf section Documents acceptés.


Output:
json{"file_name1": {“file_type”: "file_type", “field1”: "value1"}, "file_name2": {“file_type”: "file_type", “field1”: "value1"}, ..., "common": {“common_field1”: "value1", ... , “scoring”: "scoring%"}}


où “common” contient des vérifications recoupant les différents documents (exemple: “comparaison_nom_CNI_avis_imposition”: 0 si les noms diffèrent entre l’avis d’imposition et la CNI)

Introduction


Racine

Le point d’entrée racine de l’API est https://api.eazyrent.fr:9000/api/

Notre API se base sur la librairie Django Rest framework. Les échanges sont synchrones, cf. la documentation: https://www.django-rest-framework.org/

Sécurité


Sauvegarde des données et RGPD

Les données recueillies par l’API sont supprimées 3 mois après leur réception.

" Ces informations et données personnelles sont également conservées à des fins de sécurité, afin de respecter les obligations légales et réglementaires. Elles seront conservées aussi longtemps que nécessaire pour l’exécution des prestations commandées et des garanties éventuellement applicables à l’issue des prestations.

Le responsable du traitement des données est EAZYRENT, Société par Actions Simplifiée au capital de 10 000 euros, dont le siège social est sis 244 route de Seysses – 31100 TOULOUSE, RCS TOULOUSE en cours d’immatriculation, ayant pour adresse mail : [email protected]

L’accès aux données personnelles sera strictement limité aux employés du responsable de traitement, habilités à les traiter en raison de leurs fonctions. Les informations recueillies pourront éventuellement être communiquées à des tiers liés à l’entreprise par contrat pour l’exécution de prestations éventuellement sous-traitées, sans que l’autorisation du Client ne soit nécessaire.

Conformément à la loi n° 78-17 du 6 janvier 1978 relative à l’informatique, aux fichiers et aux libertés, telle que modifiée par la loi n° 2004-801 du 6 août 2004, et par le Règlement Européen n°2016/.679, le Client dispose d’un droit d’accès, de rectification, d’effacement, et de portabilité des données le concernant, ainsi que du droit de s’opposer au traitement pour motif légitime, droits qu’il peut exercer en s’adressant au responsable de traitement à l’adresse postale ou email mentionnée ci-dessus, en joignant un justificatif de son identité valide. En cas de réclamation, le client peut contacter la Commission Nationale de l’Informatique et des Libertés (CNIL). "

Gestion d’erreurs

La gestion d’erreur de l’API utilise les codes d’erreur HTTP standards :

Lorsque c’est possible, l’API répondra en JSON avec le format suivant :

{
  "message": "un message d'erreur"
}


Support

Si vous n’arrivez pas à comprendre une erreur, que vous avez besoin de support et souhaitez contacter l’équipe EazyRent, pensez à fournir les éléments suivants :