v1

latestOpenAPI 3.1.0Proprietary2026-07-244223105.2 KB

Guidance

Collect user consent for guidance

For eligible partners only. Collect user consent for financial guidance services

post/v3/guidance/consents

Request body

user_uuidstring uuid required

The UUID of the user giving consent

country_codestring required

The ISO 3166-1 alpha-2 country code (2 letters)

company_identification_numberstring required

The identification number of the company (SIREN, ...) (9 digits)

language'fr' | 'en'

Optional language used to generate guidance content. Defaults to fr when omitted.

contact_emailstring email

Optional contact email address

contact_phone_numberstring

Optional contact phone number

Example request

{
  "user_uuid": "9113349b-3868-4e6f-8d68-8ea260132e1d",
  "country_code": "FR",
  "company_identification_number": "529196313",
  "language": "fr",
  "contact_email": "contact@example.com",
  "contact_phone_number": "+33612345678"
}

Response

Consent collected successfully