API Reference
Dashboard Bridge

Create guidance session

post
https://api.bridgeapi.io/v3/guidance/guidance-sessions

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

Body Params
uuid
required

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

string
required
^[A-Z]{2}$

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

string
required
^\d{9}$

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

string
enum

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

Allowed:
string | null

Optional contact email address

string | null

Optional contact phone number

Headers
string
enum
required
Defaults to 2025-01-15

The Bridge API version

Allowed:
Responses

400

Invalid request body

401

User not found

403

IP whitelisting is too broad and must be restricted to specific IP addresses or /32 CIDR ranges

Updated about 2 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago

Did this page help you?