NAV
cURL

Introduction

Bienvenue sur la documentation de l'API Youscore.

Vous pouvez accéder aux différentes routes qui vous permettront de récupérer les données financières établies par Youscore.

Si vous rencontez des difficultés lors de l'utilisation de notre API n'hésitez pas à nous contacter.

Authentification

Pour accéder à l'API Youscore, vous avez besoin de votre identifiant et d'un mot de passe d'application qui devra être présent dans chaque requête.

Le mot de passe d'application est généré manuellement par un administrateur du site Youscore.

Pour effectuer une demande, veuillez envoyer un mail à l'adresse suivante : contact@youscore.eu

Si vous voulez faire un essai sur POSTMAN :

Critères de recherche

Récupérer les critères par pays

curl "https://app.youscore.eu/api/v1/search_criteria?countries=FR" \
  -u "identifiant:app_password"

La commande précédente retourne une structure JSON comme ceci :

{
    "registration_number": {
        "min_lenght": 9,
        "max_lenght": 14,
        "reg_ex": "(\\d{9}|\\d{14})"
    },
    "office_type": [
        "head_office",
        "branch"
    ],
    "status": [
        "active",
        "non_active"
    ],
    "address": {
        "full_address": [],
        "street_name": [],
        "city": [],
        "postal_code": [],
    },
    "vat_number": {
        "min_lenght": 11,
        "max_lenght": 13,
        "reg_ex": "(FR)?[A-Z0-9]{2}\\d{9}"
    },
    "company_name": {
        "min_lenght": 2
    },
    "trade_name": {
        "min_lenght": 2
    },
    "acronym": {
        "min_lenght": 2
    }
}

Ce endpoint retourne les différents critères de recherche d'une société par pays.

HTTP Request

GET https://app.youscore.eu/api/v1/search_criteria

Query Parameters

Parameter Type Description
countries string Liste des pays désirés au format ISO séparés pas une virgule (FR, EN).

Société

Propriété d'une société

Company Summary

Attribut Type Description
business_name string Nom commercial.
registration_number string Identifiant local.
country string Pays.
vat_number string Numéro de TVA.
registration_date string Date d'enregistrement de la société.
legal_form object Type de société. code et description
status string Status économique.
has_procedure string Permet de savoir si la société est en procédure collective. Cette phrase est affichée sur la signalétique.
last_judicial_event array Informations à propos du dernier jugement connu.
activity object Type d'activité. code et description
number_of_branches integer Nombre de filiales.
preferentials object Informations sur les privilèges.
address object Détails de l'adresse.
ys_last_update date Date de dernière mise à jour des données youscore.

Youscore Informations

Attribut Type Description
date date Date de mise à jour de la note (format ISO 8601).
new_note_cause string Raison pour laquelle une nouvelle note a été définie. new_account ou preferential
note string Note déterminée par youscore.
credit_limit integer Encours conseillé par youscore.
payment_behavior string Probabilité de comportement de paiement. normal, correct, to_monitor, to_monitor_plus
turnover integer Chiffre d'affaires.
export_sales integer Dont export.
net_result integer Résultat net.
shareholders_equity integer Capitaux propres.
monthly_purchases integer Achats mensuels.
operation_result integer Résultat d'exploitation.
creditor_days integer Délai client en jours.
debitor_days integer Délai fournisseur en jours d'achats.
cash_in_sales_days integer Trésorerie en jours de vente.
commercial_margin_rate string Taux de marge commerciale.
gross_operating_margin string Taux de marge brute.

Rechercher une société

curl "https://app.youscore.eu/api/v1/company/" \
  -u "identifiant:app_password"

La commande précédente retourne un tableau JSON comme ceci :

{
    "total_size": X,
    "result": [
        {
            "country": "FR",
            "registration_number": "",
            "vat_number": [
                ""
            ],
            "company_name": "",
            "trading_name": [
                ""
            ],
            "status": "",
            "date_latest_accounts": "",
            "activity_code": "",
            "office_type": "",
            "address": {
                "full_address": "",
                "street": "",
                "city": "",
                "province": "",
                "postal_code": ""
        }
    ]
},

Ce endpoint permet d'effectuer une recherche de société en fonction des critères définis dans la requête.

En effectuant une recherche vous allez récupérer un tableau de sociétés.

À partir de là, vous allez pouvoir récupérer le numéro de TVA ou l'identifiant local afin d'obtenir le rapport précis.

HTTP Request

GET https://app.youscore.eu/api/v1/company

Query Parameters

Les paramètres disponibles sont ceux récupérés à partir du endpoint search_criteria.

Parameter Default Description
countries Liste du pays désiré au format ISO.
page 1 Page de départ.
per_page 25 Nombre de sociétés retournées dans une page.

Rapport d'une société

curl "https://app.youscore.eu/api/v1/company/<country>/<registration_number>" \
  -u "identifiant:app_password"

La commande précédente retourune une structure JSON comme ceci :

{
    "company_summary": {
        "business_name": "",
        "registration_number": "",
        "vat_number": "",
        "registration_date": "",
        "legal_form": {
            "code": "",
            "description": ""
        },
        "status": "",
        "has_procedure": ,
        "last_judicial_event": {
            "date": "",
            "type": "",
            "code": ""
        },
        "activity": {
            "code": "",
            "description": ""
        },
        "number_of_branches": "",
        "preferentials": {
            "monitoring_start_date": "",
            "active_preferentials": ,
            "active_due_amount": ,
        },
        "address": {
            "street": "",
            "city": "",
            "postal_code": "",
            "phone_number": ""
        }
    },
    "youscore_informations": {
        "current": {
            "date": "",
            "new_note_cause": "",
            "note": ,
            "credit_limit": ,
            "payment_behavior": "",
            "turnover": ,
            "export_sales": ,
            "net_result": ,
            "shareholders_equity": ,
            "monthly_purchases": ,
            "operation_result": ,
            "creditor_days": ,
            "debitor_days": ,
            "cash_in_sales_days": ,
            "commercial_margin_rate": ,
            "gross_operating_margin":
        },
        "previous": {
            "date": "",
            "new_note_cause": "",
            "note": ,
            "credit_limit": ,
            "payment_behavior": "",
            "turnover": ,
            "export_sales": ,
            "net_result": ,
            "shareholders_equity": ,
            "monthly_purchases": ,
            "operation_result": ,
            "creditor_days": ,
            "debitor_days": ,
            "cash_in_sales_days": ,
            "commercial_margin_rate": ,
            "gross_operating_margin":
        }
    }
}

Ce endpoint permet de récupérer les informations financières d'une société.

En utilisant l'identifiant local

HTTP Request

GET https://app.youscore.eu/api/v1/company/<COUNTRY>/<ID>

URL Parameters

Parameter Description
Country Liste du pays désiré au format ISO.
ID Identifiant local de la société recherchée.

En utilisant le numéro de TVA intracommunautaire

HTTP Request

GET https://app.youscore.eu/api/v1/company/<TVA>

URL Parameters

Parameter Description
TVA Numéro de TVA intracommunautaire.

Erreurs

L'API Youscore utilise les codes d'erreur suivants :

Code erreur Titre Signification
400 Bad Request Requête invalide.
401 Unauthorized Problème d'authentification.
401 Credit Required Le contrat Youscore n'est pas à jour.
403 Forbidden Vous n'avez pas les droits nécessaires.
404 Not Found La route spécifiée n'existe pas.
429 Too Many Requests Trop de requêtes dans une délai donné.
500 Internal Server Error Nous avons un problème interne avec le serveur.
503 Service Unavailable Nous sommes temporairement en maintenance.
cURL