v1

latestOpenAPI 3.1.0Proprietary2026-07-244223105.2 KB

Guidance

Get guidance for a user

For eligible partners only. Retrieve financial guidance recommendations based on user's transaction analysis. The guidance message is returned in the language selected when the guidance consent was created.

get/v3/guidance/health/{user_uuid}

Response

Guidance health retrieved successfully

messagestring required

The guidance message containing multiple prioritized financial strategies as markdown. Each strategy is a markdown section (## heading) followed by analysis and actionable recommendations. The content language matches the language selected when the guidance consent was created.

Example response

{
  "message": "## Optimiser votre trésorerie\n\nVotre solde moyen de 39 500 € est stable mais votre trésorerie nette montre des variations importantes. Nous recommandons de constituer une réserve de sécurité équivalente à 3 mois de charges fixes pour absorber les fluctuations saisonnières.\n\n## Renégocier vos frais bancaires\n\nAvec 45 opérations de commissions et frais bancaires sur la période, représentant un montant significatif, une renégociation de vos conditions tarifaires pourrait générer des économies récurrentes."
}