v1

latestOpenAPI 3.1.0Proprietary2026-07-244223105.2 KB

Guidance

Create guidance session

For eligible partners only. Create a reusable frontend session for the guidance experience.

post/v3/guidance/guidance-sessions

Request body

user_uuidstring uuid required

The UUID of the user for whom the guidance session is created

country_codestring required

The ISO 3166-1 alpha-2 country code (2 uppercase 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 nullable

Optional contact email address

contact_phone_numberstring nullable

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

Guidance session created successfully

idstring uuid required

The created guidance session identifier

urlstring required

The frontend URL for the guidance session

passwordstring required

The password the end user must provide to access the guidance session

Example response

{
  "id": "a838cdb0-42a0-42fb-bcf7-2bd5dcdce163",
  "url": "https://guidance.bridgeapi.io/session/a838cdb0-42a0-42fb-bcf7-2bd5dcdce163",
  "password": "Ab3!Cd4@Ef5(Gh6)Ij7K"
}