POST API: Vehicle Declaration
Description
This API allows you to execute an incoming flow for a specific client and a given translator. The accountId and translatorCode parameters are dynamic and must be provided in the URL.
URL
Full URL
https://api.dev.e4cars.io/api/v1/4pl/{accountId}/incoming-flows/vehicle/{translatorCode}?token={TOKEN}&dry_run=true
Full URL
https://api.dev.e4cars.io/api/v1/4pl/incoming-flows/vehicle/STD_IN_VEHICLE_ACCOUNT?token=18498cae876943a9aa2c72971645b75xxxx ...
METHOD
- /POST
PATH parameters
- accountId (string, required): unique identifier of the E4Cars client account.
- translatorCode (string, required): code of the translator executing the incoming flow. The default standard translator is
STD_IN_VEHICLE_ACCOUNT.
QUERY parameters
- token (string, required): API key for authentication for the call. (see authentication section)
- dry_run (string, optional, default=false): Allows you to run the translator for testing. Only the translation will be launched, the result will not be processed.
- true: Only translation will run, no processing
- false: Translation and processing of the translated flow will run.
REQUEST parameters
-
body (JSON Object, required): It contains a JSON object that will be transformed into the IncomingVehiclePivot structure, E4Cars' internal format.
The object in body can also be an ad hoc object corresponding to the caller's or an existing API's needs.
In this case, you should contact the E4Cars integration teams (integration@e4cars.com) so they can create an ad hoc translator to transform the body into IncomingVehiclePivot.
Standard flow translator case: translatorCode=STD_IN_VEHICLE_ACCOUNT
If you decide to use the standard flow translator (STD_IN_VEHICLE_ACCOUNT), you must adhere to the standard incoming manifest schema IncomingVehiclePivot below.
IncomingVehiclePivot schema
IncomingVehiclePivot.ts
export interface IncomingVehiclePivot {
kind: string;
issuing_date: string;
issuer: {
origin_software: string
};
vehicle_account: {
vin : string;
license_plate? : string
customer_references : CustomerReference[]
incoming_vehicle: {
make : string;
model : string;
shape : string;
color : string;
engine : string;
gearbox : string;
energy_type : string;
seats : number;
description : string;
features: string;
vehicle_attributes : {
length : string;
width : string;
height : string;
weight : string;
first_registration : string;
mileage : {
value : string
}
}
};
incoming_seller: MemberRole;
incoming_buyer:MemberRole;
origin: {
incoming_member_role: MemberRole
};
destination: {
incoming_member_role: MemberRole
};
logistics_status: string;
group : {
code : string
}
};
account : {
code : string
}
}
export interface CustomerReference {
key: string;
value: string;
}
export interface MemberRole {
name: string;
check_private: string;
place_name: string;
zip: string;
city: string;
country_code: string;
platform: {
code: string
};
contact: {
name: string;
phone: string;
email: string
};
instructions: string
}
add features attibute
vehicle_account: {
...
incoming_vehicle: {
make : string;
model : string;
shape : string;
color : string;
engine : string;
gearbox : string;
energy_type : string;
seats : number;
description : string;
+ features: string;
vehicle_attributes : {
length : string;
width : string;
height : string;
weight : string;
first_registration : string;
mileage : {
value : string
}
}
};
...
Example of IncomingVehiclePivot Body
JSON
{
"kind": "vehicle_declaration",
"issuing_date": "2024-10-17T14:01:38",
"issuer": {
"origin_software": "DMS_CUST1"
},
"vehicle_account": {
"vin" : "NMN291NZXHRZ91MSK",
"license_plate" : "FU-80-EH",
"customer_references" : [
{
"key" : "customer_identification",
"value" : "ref-cust-vin-NMN291NZXHRZ91MSK"
},
{
"key" : "order",
"value" : "KJ948-EE409"
}
],
"incoming_vehicle": {
"make" : "Peugeot",
"model" : "E-3008",
"shape" : "CUV",
"color" : "Pourpre Sanglant",
"engine" : "80ch",
"gearbox" : "AUTOMATIQUE",
"energy_type" : "ELECTRIQUE",
"seats" : "5",
"description" : "E-3008",
"vehicle_attributes" : {
"length" : "2500",
"width" : "2000",
"height" : "1800",
"weight" : "1250",
"first_registration" : "2023-07-14",
"mileage" : {
"value" : "2000"
}
}
},
"incoming_seller": {
"check_private": false,
"name": "RENAULT BOULOGNE - RRG",
"place_name": "577 Av. du Général Leclerc, 92100 Boulogne-Billancourt",
"zip": "92100",
"city": "Boulogne-Billancourt",
"country_code": "FR",
"platform": {
"code": "RRG1"
},
"contact": {
"name": "Michel Durand",
"phone": "O1 46 23 43 22",
"email": "michel.durand@rrg.com"
},
"instructions": "Driver need token at pickup : 239-MM345-UH1"
},
"incoming_buyer":{
"check_private": "true",
"name": "Monique Marchal",
"place_name": "27 rue du puit, 75019 Paris",
"zip": "75019",
"city": "Paris",
"country_code": "FR",
"contact": {
"name": "Monique Marchal",
"phone": "07 07 07 07 07",
"email": "monique@marchal.fr"
},
"instructions": "Pas aux heures de repas"
},
"origin": {
"incoming_member_role": {
"check_private": "false",
"name": "RENAULT BOULOGNE - RRG",
"place_name": "577 Av. du Général Leclerc, 92100 Boulogne-Billancourt",
"zip": "92100",
"city": "Boulogne-Billancourt",
"country_code": "FR",
"platform": {
"code": "RRG1"
},
"contact": {
"name": "Michel Durand",
"phone": "O1 46 23 43 22",
"email": "michel.durand@rrg.com"
},
"instructions": "Driver need token at pickup : 239-MM345-UH1"
}
},
"destination": {
"incoming_member_role": {
"check_private": "true",
"name": "Monique Marchal",
"place_name": "27 rue du puit, 75019 Paris",
"zip": "75019",
"city": "Paris",
"country_code": "FR",
"contact": {
"name": "Monique Marchal",
"phone": "07 07 07 07 07",
"email": "monique@marchal.fr"
},
"instructions": "Pas aux heures de repas"
}
},
"crm_dms_status" : "sold",
"group" : {
"code" : "FLT"
}
},
"account" : {
"code" : "NMN"
}
}
E4Cars Custom Incoming Flow Translator
The object in body can be an ad hoc object corresponding to the needs of an existing API.
In this case, as with E4Cars' outgoing flows, you should contact the E4Cars integration teams (integration@e4cars.com) to send them the body you wish to send for creating a vehicle.
They will create a custom translator that will be used when transmitting vehicle creation orders, converting an IncomingVehiclePivot from the ad hoc information.
Example of URL
Full URL
https://api.dev.e4cars.io/api/v1/4pl/incoming-flows/vehicle/STD_IN_VEHICLE_ACCOUNT?token=18498cae876943a9aa2c72971645b75xxxx ...
| NAME | NATURE | TYPE | PLACE | VALUE |
|---|---|---|---|---|
ACCOUNT_ID |
CONSTANT | string | Path param | Default value |
ID_TRANSLATOR |
CONSTANT | String | Path param | Default value |
TOKEN |
CONSTANT | string | Query param | Default value |
dry_run |
CONSTANT | string | Query param | Default false |
"vehicle_account.group.code" |
CONSTANT | JSON object | Body | Default value |
"kind" |
CONSTANT | JSON object | Body | "vehicle_declaration" |
"account.code" |
CONSTANT | JSON object | Body | ACCOUNT_ID |
| NAME | NATURE | TYPE | PLACE | VALUE |
|---|---|---|---|---|
"vehicle_account.incoming_vehicle.shape" |
VARIABLE | String | Body | Dynamic |
Below is the list of accepted values for vehicle.shape:
| Name | Value |
|---|---|
| CABRIOLET | CABRIOLET |
| COUPE | COUPE |
| CUV | CUV |
| HATCHBACK | HATCHBACK |
| MICRO | MICRO |
| MINIVAN | MINIVAN |
| PICKUP | PICKUP |
| ROADSTER | ROADSTER |
| SEDAN | SEDAN |
| SUPERCAR | SUPERCAR |
| SUV | SUV |
Date value
All date (IN or OUT) are Locale
Below is the list of all accepted date formats:
- YYYY-MM-DDTHH24:MI:SS
- YYYY-MM-DDTHH24:MI:SSZ
- YYYY-MM-DDTHH24:MI
- YYYY-MM-DDTHH24:MI:SS.ms
- YYYY-MM-DDTHH24:MI:SS.msZ
The POST request requires a body in JSON format containing the necessary information to execute the incoming flow. Here is an example of the body structure:
Example of JSON Body
JSON
{
"kind": "vehicle_declaration",
"issuing_date": "2024-10-17T14:01:38",
"issuer": {
"origin_software": "DMS_CUST1"
},
"vehicle_account": {
"vin" : "NMN291NZXHRZ91MSK",
"license_plate" : "FU-80-EH",
"customer_references" : [
{
"key" : "customer_identification",
"value" : "ref-cust-vin-NMN291NZXHRZ91MSK"
},
{
"key" : "order",
"value" : "KJ948-EE409"
}
],
"incoming_vehicle": {
"make" : "Peugeot",
"model" : "E-3008",
"shape" : "CUV",
"color" : "Pourpre Sanglant",
"engine" : "80ch",
"gearbox" : "AUTOMATIQUE",
"energy_type" : "ELECTRIQUE",
"seats" : "5",
"description" : "E-3008",
"vehicle_attributes" : {
"length" : "2500",
"width" : "2000",
"height" : "1800",
"weight" : "1250",
"first_registration" : "2023-07-14",
"mileage" : {
"value" : "2000"
}
}
},
"incoming_seller": {
"check_private": false,
"name": "RENAULT BOULOGNE - RRG",
"place_name": "577 Av. du Général Leclerc, 92100 Boulogne-Billancourt",
"zip": "92100",
"city": "Boulogne-Billancourt",
"country_code": "FR",
"platform": {
"code": "RRG1"
},
"contact": {
"name": "Michel Durand",
"phone": "O1 46 23 43 22",
"email": "michel.durand@rrg.com"
},
"instructions": "Driver need token at pickup : 239-MM345-UH1"
},
"incoming_buyer":{
"check_private": "true",
"name": "Monique Marchal",
"place_name": "27 rue du puit, 75019 Paris",
"zip": "75019",
"city": "Paris",
"country_code": "FR",
"contact": {
"name": "Monique Marchal",
"phone": "07 07 07 07 07",
"email": "monique@marchal.fr"
},
"instructions": "Pas aux heures de repas"
},
"origin": {
"incoming_member_role": {
"check_private": "false",
"name": "RENAULT BOULOGNE - RRG",
"place_name": "577 Av. du Général Leclerc, 92100 Boulogne-Billancourt",
"zip": "92100",
"city": "Boulogne-Billancourt",
"country_code": "FR",
"platform": {
"code": "RRG1"
},
"contact": {
"name": "Michel Durand",
"phone": "O1 46 23 43 22",
"email": "michel.durand@rrg.com"
},
"instructions": "Driver need token at pickup : 239-MM345-UH1"
}
},
"destination": {
"incoming_member_role": {
"check_private": "true",
"name": "Monique Marchal",
"place_name": "27 rue du puit, 75019 Paris",
"zip": "75019",
"city": "Paris",
"country_code": "FR",
"contact": {
"name": "Monique Marchal",
"phone": "07 07 07 07 07",
"email": "monique@marchal.fr"
},
"instructions": "Pas aux heures de repas"
}
},
"crm_dms_status" : "sold",
"group" : {
"code" : "FLT"
}
},
"account" : {
"code" : "NMN"
}
}
| Code | Description | Example Response |
|---|---|---|
| 200 | Success, the flow was executed correctly. | { "status": "success", "message": "Incoming flow executed successfully." } |
| 401 | Unauthorized, missing or invalid authentication. | { "status": "error", "message": "Unauthorized. Please authenticate." } |
| 403 | Forbidden, insufficient permissions. | { "status": "error", "message": "Forbidden. You do not have the necessary permissions to execute this flow." } |
| 400 | Bad request, invalid body or parameters. | { "status": "error", "message": "Invalid request. Ensure all parameters are correctly provided." } |
POST API: Receive vehicle on yard
Description
This API allows you to execute an incoming flow for a specific client and a given translator . The accountId and translatorCode (STD_IN_ENTER_VEHICLE_YARD) parameters are dynamic and must be provided in the URL.
URL
Full URL
https://api.dev.e4cars.io/api/v1/4pl/{accountId}/incoming-flows/orders/{translatorCode}?token={TOKEN}&dry_run=true
Full URL
https://api.dev.e4cars.io/api/v1/4pl/incoming-flows/orders/STD_IN_ENTER_VEHICLE_YARD?token=18498cae876943a9aa2c72971645b75xxxx ...
METHOD
- /POST
PATH parameters
- accountId (string, required): unique identifier of the E4Cars client account.
- translatorCode (string, required): code of the translator executing the incoming flow. The default standard translator is
STD_IN_ENTER_VEHICLE_YARD.
QUERY parameters
- token (string, required): API key for authentication for the call. (see authentication section)
- dry_run (string, optional, default=false): Allows you to run the translator for testing. Only the translation will be launched, the result will not be processed.
- true: Only translation will run, no processing
- false: Translation and processing of the translated flow will run.
REQUEST parameters
-
body (JSON Object, required): It contains a JSON object that will be transformed into the IncomingOrderPivot structure, E4Cars' internal format.
The object in body can also be an ad hoc object corresponding to the caller's or an existing API's needs.
In this case, you should contact the E4Cars integration teams (integration@e4cars.com) so they can create an ad hoc translator to transform the body into IncomingOrderPivot.
Standard flow translator case: translatorCode=STD_IN_ENTER_VEHICLE_YARD
If you decide to use the standard flow translator (STD_IN_ENTER_VEHICLE_YARD), you must adhere to the standard incoming manifest schema IncomingOrderPivot below.
IncomingOrderPivot schema
IncomingOrderPivot.ts
export interface IncomingOrderPivot {
customer_incoming_order_no?: string;
kind: string;
issuing_date: string;
issuer: {
origin_software: string;
};
vehicle_account: {
vin: string;
license_plate?: string;
dms_reference?: string;
incoming_vehicle?: {
make: string;
model: string;
shape?: string;
color?: string;
engine?: string;
gearbox?: string;
energy_type?: string;
seats?: string;
description?: string;
vehicle_attributes?: {
length?: string;
width?: string;
height?: string;
weight?: string;
mileage?: {
value: string;
};
first_registration?: string;
};
};
incoming_seller?: {
name?: string;
zip: string;
city: string;
country_code: string;
place_name?: string;
display_place_name?: string;
timezone?: string;
geo_point?: {
type: string;
coordinates: [number, number];
};
check_private: string;
instructions?: string;
contact?: {
name?: string;
email?: string;
phone?: string;
language?: string;
};
};
incoming_buyer?: {
name?: string;
zip: string;
city: string;
country_code: string;
place_name?: string;
display_place_name?: string;
timezone?: string;
geo_point?: {
type: string;
coordinates: [number, number];
};
check_private: string;
instructions?: string;
contact?: {
name?: string;
email?: string;
phone?: string;
language?: string;
};
};
pickup?: {
incoming_member_role?: {
name?: string;
zip: string;
city: string;
country_code: string;
place_name?: string;
display_place_name?: string;
timezone?: string;
geo_point?: {
type: string;
coordinates: [number, number];
};
check_private: string;
instructions?: string;
contact?: {
name?: string;
email?: string;
phone?: string;
language?: string;
};
};
};
delivery?: {
incoming_member_role?: {
name?: string;
zip: string;
city: string;
country_code: string;
place_name?: string;
display_place_name?: string;
timezone?: string;
geo_point?: {
type: string;
coordinates: [number, number];
};
check_private: string;
instructions?: string;
contact?: {
name?: string;
email?: string;
phone?: string;
language?: string;
};
};
};
crm_dms_status?: string;
group?: {
code: string;
};
};
account?: {
code: string;
};
}
Example of IncomingOrderPivot Body
JSON
{
"customer_incoming_order_no": "VOL-2345-RTG-3089487",
"kind": "vehicle_enter_platform",
"issuing_date": "2025-03-19T13:01:02",
"issuer": {
"origin_software": "VOL-DMS"
},
"account": {
"code": "VOL"
},
"allocation": {
"pickup": {
"incoming_member_role": {
"name": "CEVA ETUPES",
"zip": "25460",
"city": "Étupes",
"country_code": "FR",
"place_name": "1375 Avenue Oehmichen, 25460 Étupes, France",
"contact": {
"name": "Nicolas Melisson",
"email": "ni.co@las.mel",
"phone": "+33 6 01 02 03 04",
"language": "fr"
},
"platform": {
"code": "CEV_ETUPES"
},
"check_private": false
},
"target_date": {
"date": "2025-03-26T23:00:00",
"utc_date": "2025-03-26T22:00:00"
}
},
"delivery": {
"incoming_member_role": {
"name": "CEVA ETUPES",
"zip": "25460",
"city": "Étupes",
"country_code": "FR",
"place_name": "1375 Avenue Oehmichen, 25460 Étupes, France",
"timezone": "Europe/Paris",
"platform": {
"code": "CEV_ETUPES"
},
"check_private": false
},
"target_date": {
"date": "2025-03-27T00:00:00",
"utc_date": "2025-03-26T23:00:00"
}
},
"vehicles": [
{
"vin": "NMN085J9M95FUBPCN",
"license_plate": "DCH-56-NGL",
"customer_references": [
{
"key": "dms_reference",
"value": "DMS12J68JU1"
},
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
}
],
"incoming_vehicle": {
"make": "FERRARI",
"model": "F8 SPYDER",
"shape": "COUPE"
},
"incoming_seller": {
"name": "AUTO1 France",
"zip": "92320",
"city": "Châtillon",
"country_code": "FR",
"timezone": "Europe/Paris",
"contact": {
"name": "John Doe",
"email": "auto1.testnmn@e4cars.com",
"phone": "+330101010101",
"language": "fr"
}
},
"incoming_buyer": {
"name": "Renault - Cordes-sur-Ciel",
"zip": "81000",
"city": "Albi",
"country_code": "FR",
"place_name": "81000 Albi, France",
"timezone": "Europe/Paris"
},
"origin": {
"incoming_member_role": {
"zip": "77171",
"city": "Sourdun",
"country_code": "FR",
"place_name": "77171 Sourdun, France",
"timezone": "Europe/Paris",
"contact": {
"name": "John Doe",
"email": "origin.testnmn@e4cars.com",
"phone": "+330101010101",
"language": "fr"
}
}
},
"destination": {
"incoming_member_role": {
"name": "Debard Automobiles Albi",
"zip": "81000",
"city": "Albi",
"country_code": "FR",
"place_name": "81000 Albi, France",
"timezone": "Europe/Paris",
"contact": {
"name": "John Doe",
"email": "debard.testnmn@e4cars.com",
"phone": "+330101010101",
"language": "fr"
}
}
},
"logistics_status": "ordered",
"group": {
"code": "FLT"
}
}
]
}
}
E4Cars Custom Incoming Flow Translator
The object in body can be an ad hoc object corresponding to the needs of an existing API.
In this case, as with E4Cars' outgoing flows, you should contact the E4Cars integration teams (integration@e4cars.com) to send them the body you wish to send for creating a vehicle.
They will create a custom translator that will be used when transmitting vehicle creation orders, converting an IncomingOrderPivot from the ad hoc information.
Example of URL
Full URL
https://api.dev.e4cars.io/api/v1/4pl/incoming-flows/orders/STD_IN_ENTER_VEHICLE_YARD?token=18498cae876943a9aa2c72971645b75xxxx ...
| NAME | NATURE | TYPE | PLACE | VALUE |
|---|---|---|---|---|
ACCOUNT_ID |
CONSTANT | string | Path param | Default value |
ID_TRANSLATOR |
CONSTANT | String | Path param | Default value |
TOKEN |
CONSTANT | string | Query param | Default value |
dry_run |
CONSTANT | string | Query param | Default false |
"vehicle_account.group.code" |
CONSTANT | JSON object | Body | Default value |
"kind" |
CONSTANT | JSON object | Body | "vehicle_enter_platform" |
"account.code" |
CONSTANT | JSON object | Body | ACCOUNT_ID |
| NAME | NATURE | TYPE | PLACE | VALUE |
|---|---|---|---|---|
"vehicle_account.incoming_vehicle.shape" |
VARIABLE | String | Body | Dynamic |
Below is the list of accepted values for vehicle.shape:
| Name | Value |
|---|---|
| CABRIOLET | CABRIOLET |
| COUPE | COUPE |
| CUV | CUV |
| HATCHBACK | HATCHBACK |
| MICRO | MICRO |
| MINIVAN | MINIVAN |
| PICKUP | PICKUP |
| ROADSTER | ROADSTER |
| SEDAN | SEDAN |
| SUPERCAR | SUPERCAR |
| SUV | SUV |
Date value
All date (IN or OUT) are UTC
Below is the list of all accepted date formats:
- YYYY-MM-DDTHH24:MI:SS
- YYYY-MM-DDTHH24:MI:SSZ
- YYYY-MM-DDTHH24:MI
- YYYY-MM-DDTHH24:MI:SS.ms
- YYYY-MM-DDTHH24:MI:SS.msZ
The POST request requires a body in JSON format containing the necessary information to execute the incoming flow. Here is an example of the body structure:
Example of JSON Body
JSON
{
"customer_incoming_order_no": "VOL-2345-RTG-3089487",
"kind": "vehicle_enter_platform",
"issuing_date": "2025-03-19T13:01:02",
"issuer": {
"origin_software": "VOL-DMS"
},
"account": {
"code": "VOL"
},
"allocation": {
"pickup": {
"incoming_member_role": {
"name": "CEVA ETUPES",
"zip": "25460",
"city": "Étupes",
"country_code": "FR",
"place_name": "1375 Avenue Oehmichen, 25460 Étupes, France",
"contact": {
"name": "Nicolas Melisson",
"email": "ni.co@las.mel",
"phone": "+33 6 01 02 03 04",
"language": "fr"
},
"platform": {
"code": "CEV_ETUPES"
},
"check_private": false
},
"target_date": {
"date": "2025-03-26T23:00:00",
"utc_date": "2025-03-26T22:00:00"
}
},
"delivery": {
"incoming_member_role": {
"name": "CEVA ETUPES",
"zip": "25460",
"city": "Étupes",
"country_code": "FR",
"place_name": "1375 Avenue Oehmichen, 25460 Étupes, France",
"timezone": "Europe/Paris",
"platform": {
"code": "CEV_ETUPES"
},
"check_private": false
},
"target_date": {
"date": "2025-03-27T00:00:00",
"utc_date": "2025-03-26T23:00:00"
}
},
"vehicles": [
{
"vin": "NMN085J9M95FUBPCN",
"license_plate": "DCH-56-NGL",
"customer_references": [
{
"key": "dms_reference",
"value": "DMS12J68JU1"
},
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value2"
}
],
"incoming_vehicle": {
"make": "FERRARI",
"model": "F8 SPYDER",
"shape": "COUPE"
},
"incoming_seller": {
"name": "AUTO1 France",
"zip": "92320",
"city": "Châtillon",
"country_code": "FR",
"timezone": "Europe/Paris",
"contact": {
"name": "John Doe",
"email": "auto1.testnmn@e4cars.com",
"phone": "+330101010101",
"language": "fr"
}
},
"incoming_buyer": {
"name": "Renault - Cordes-sur-Ciel",
"zip": "81000",
"city": "Albi",
"country_code": "FR",
"place_name": "81000 Albi, France",
"timezone": "Europe/Paris"
},
"origin": {
"incoming_member_role": {
"zip": "77171",
"city": "Sourdun",
"country_code": "FR",
"place_name": "77171 Sourdun, France",
"timezone": "Europe/Paris",
"contact": {
"name": "John Doe",
"email": "origin.testnmn@e4cars.com",
"phone": "+330101010101",
"language": "fr"
}
}
},
"destination": {
"incoming_member_role": {
"name": "Debard Automobiles Albi",
"zip": "81000",
"city": "Albi",
"country_code": "FR",
"place_name": "81000 Albi, France",
"timezone": "Europe/Paris",
"contact": {
"name": "John Doe",
"email": "debard.testnmn@e4cars.com",
"phone": "+330101010101",
"language": "fr"
}
}
},
"logistics_status": "ordered",
"group": {
"code": "FLT"
}
}
]
}
}
| Code | Description | Example Response |
|---|---|---|
| 200 | Success, the flow was executed correctly. | { "status": "success", "message": "Incoming flow executed successfully." } |
| 401 | Unauthorized, missing or invalid authentication. | { "status": "error", "message": "Unauthorized. Please authenticate." } |
| 403 | Forbidden, insufficient permissions. | { "status": "error", "message": "Forbidden. You do not have the necessary permissions to execute this flow." } |
| 400 | Bad request, invalid body or parameters. | { "status": "error", "message": "Invalid request. Ensure all parameters are correctly provided." } |