FIASCO API

Version 3.9.0 · OpenAPI 3.1.1

We are providing several API endpoints for external partners which are described in this documentation. All endpoints are using a REST-like interface, meaning they are called via HTTP with a specific payload (described separately for each endpoint, don’t forget to set the Content-Type header accordingly) and respond with an application/json payload. We notify customers about events using webhooks (HTTP requests with a JSON payload describing events).

Download fiasco-spec.yaml the raw OpenAPI document, for generating client bindings

FIASCO Support support@fiasco.de https://fiasco.de/

Servers
  • https://cloud.staging.fiasco.de/ staging server
  • https://cloud.fiasco.de/ production server
Authentication

BearerToken http · bearer

Please provide your API key as the bearer token (via the HTTP header “Authorization: Bearer $API_TOKEN”).

Contents

Calculation Requests

Calculation requests are requests to calculate the costs of a repair based on the provided data. The calculation is done asynchronously and the results are delivered via webhook.

post /api/v1/calculation_requests

Creates a new calculation request

Input data is processed asynchronously, results are delivered via webhook.

Operation ID v1_createCalculationRequest

Authentication BearerToken

Parameters

  • User-Agent in header string required

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0

Request body (required)

Responses

200 The request has been accepted and will be processed asynchronously. The response contains the ID of the created calculation request.

400 One of the input parameters does not match the requirements. Details are provided in the response body.

401 Your credentials could not be authenticated.

403 You are not authorized to create new calculation requests.

429 The company's daily API request limit has been reached. The `retry-after` header contains the number of seconds until the limit resets at midnight German time. It is omitted for a company whose limit is `0`, which blocks API request creation entirely.

application/json

RateLimitErrorResponse

500 An internal error has occurred. Additional details might be provided in the response.

post /api/v1/calculation_request/{calculationRequestId}/update

Overwrites a subset of fields in an existing calculation request. Triggers a new calculation based on the updates.

Operation ID v1_updateCalculationRequest

Authentication BearerToken

Parameters

  • User-Agent in header string required

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0
  • calculationRequestId in path string required

    The ID of the calculation request.

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

Request body (required)

Responses

200 The request has been updated and will be processed asynchronously.

400 One of the input parameters does not match the requirements. Details are provided in the response body.

401 Your credentials could not be authenticated.

403 You are not authorized to create new calculation requests.

409 Calculation is not ready yet.

500 An internal error has occurred. Additional details might be provided in the response.

Calculations

Calculations are the results of either a calculation request or an express link request. They can be sent to an AudaNet recipient or via email to a specified recipient.

post /api/v1/calculations/{calculationId}/send

Sends a finished calculation to an AudaNet and/or email recipient.

Operation ID v1_sendCalculation

Authentication BearerToken

Parameters

  • User-Agent in header string required

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0
  • calculationId in path string required

    The ID of the calculation finished calculation (you receive this via webhook).

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

Request body (required)

application/json

CalculationRecipients

Responses

200 The calculation has been sent to the specified recipients. Please note that there are no delivery guarantees for email recipients.

400 One of the input parameters does not match the requirements. Details are provided in the response body.

401 Your credentials could not be authenticated.

403 You are not authorized to create new calculation requests.

409 The calculation is not in a state in which it can be send. One such reason might be that the calculation has not been finished, yet. Requests that return this error should be retried at a later time.

500 An internal error has occurred. Additional details might be provided in the response.

get /api/v1/calculations/{calculationId}

Returns the details of a calculation.

Operation ID v1_getCalculation

Authentication BearerToken

Parameters

  • User-Agent in header string required

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0
  • calculationId in path string required

    The ID of the calculation (you receive this via webhook).

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

Responses

200 The calculation data has been retrieved successfully.

401 Your credentials could not be authenticated.

get /api/v1/calculations/{calculationId}/possible_parts

Returns a list of parts which apply to the vehicle in the given request.

Operation ID v1_possibleParts

Authentication BearerToken

Parameters

  • User-Agent in header string required

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0
  • calculationId in path string required

    The ID of the calculation finished calculation (you receive this via webhook).

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

Responses

200 A list of parts applicable to the requests vehicle.

404 Calculation not found.

401 Your credentials could not be authenticated.

409 Calculation is not ready yet.

500 An internal error has occurred. Additional details might be provided in the response.

get /api/v1/calculations/{calculationId}/photos/{photoId}

Returns the details of a calculation.

Operation ID v1_getCalculationPhoto

Authentication BearerToken

Parameters

  • User-Agent in header string required

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0
  • calculationId in path string required

    The ID of the calculation (you receive this via webhook).

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
  • photoId in path string required

    The ID of the photo.

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

Responses

200 The photo has been found and is returned as a JPEG image.

image/jpeg

format
byte
example

401 Your credentials could not be authenticated.

Requests

Generic requests for various operations that can be processed asynchronously. These provide a unified interface for creating and managing different types of requests.

post /api/v1/requests

Creates a new request in the system

Creates a new generic request that can be processed asynchronously.

Operation ID v1_createRequest

Authentication BearerToken

Parameters

  • User-Agent in header string required

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0

Request body (required)

Request data

application/json

CreateRequestBody

Responses

200 The request has been accepted and created successfully.

application/json

CreateRequestResponse

400 One of the input parameters does not match the requirements.

401 Your credentials could not be authenticated.

403 You are not authorized to create new requests.

422 The validation of input data has failed.

429 The company's daily API request limit has been reached. The `retry-after` header contains the number of seconds until the limit resets at midnight German time. It is omitted for a company whose limit is `0`, which blocks API request creation entirely.

application/json

RateLimitErrorResponse

500 An internal error has occurred. Additional details might be provided in the response.

post /api/v1/requests/{requestId}/update

Updates an existing request with partial data

Updates fields of an existing request. All fields are optional for update operations.

Operation ID v1_updateRequest

Authentication BearerToken

Parameters

  • User-Agent in header string required

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0
  • requestId in path string required

    The ID of the request to update.

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

Request body (required)

Request update data

application/json

UpdateRequestBody

Responses

200 The request has been successfully updated.

application/json

UpdateRequestResponse

400 One of the input parameters does not match the requirements.

401 Your credentials could not be authenticated.

403 You are not authorized to update this request.

404 The request with the specified ID was not found.

409 The request is not in a state that allows updates.

application/json

UpdateRequestErrorResponse

example Request is closed {"message":"request_closed"}

422 The validation of input data has failed.

500 An internal error has occurred. Additional details might be provided in the response.

get /api/v1/requests/{requestId}/status

Returns the status information about a request

Retrieves the current status and workflow state of a specific request.

Operation ID v1_getRequestStatus

Authentication BearerToken

Parameters

  • User-Agent in header string required

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0
  • requestId in path string required

    The ID of the request.

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

Responses

200 The status information has been retrieved successfully.

application/json

RequestStatusResponse

401 Your credentials could not be authenticated.

403 You are not authorized to access this request.

404 The request with the specified ID was not found.

500 An internal error has occurred. Additional details might be provided in the response.

Scan Notifications

Scan providers announce that a hail scan became available for a CombiConnect assignment, so that we fetch it immediately instead of discovering it on our next polling round.

post /api/v1/scan-notifications

Announces that a hail scan became available for an assignment

Call this as soon as a scan is retrievable from your scan API. We answer immediately and fetch the scan asynchronously, so a 200 means accepted, not imported. An assignment number we do not know still returns 200: whether an assignment is known, and whether it is worth fetching a scan for, depends on state you have no visibility into.

Both combiOrderNumber and combiPartnerId are required: the pair is what resolves the notification to an assignment, and a partner number that does not match the one we have stored for it drops the notification.

Duplicate notifications are safe. A scan whose scannedAt matches the one we already have is recognised as unchanged and its attachments are not downloaded again, so sending the same notification twice is preferable to sending none.

Retry only on 500 and on transport-level failures.

Operation ID v1_createScanNotification

Authentication BearerToken

Parameters

  • User-Agent in header string

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0

Request body (required)

The assignment the scan belongs to.

application/json

ScanNotificationBody

Responses

200 The notification has been accepted and the scan fetch has been queued.

400 `combiOrderNumber` or `combiPartnerId` is missing or empty. Do not retry without fixing the payload.

401 Your credentials could not be authenticated.

403 Your token is not recognised as belonging to a scan provider, so it may not send scan notifications.

500 We failed to queue the work. This is the only status a retry can fix.

Parts

get /api/v1/calculations/{calculationId}/possible_parts

Returns a list of parts which apply to the vehicle in the given request.

Operation ID v1_possibleParts

Authentication BearerToken

Parameters

  • User-Agent in header string required

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0
  • calculationId in path string required

    The ID of the calculation finished calculation (you receive this via webhook).

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

Responses

200 A list of parts applicable to the requests vehicle.

404 Calculation not found.

401 Your credentials could not be authenticated.

409 Calculation is not ready yet.

500 An internal error has occurred. Additional details might be provided in the response.

get /api/v1/parts

Returns a list of all available part numbers.

Operation ID v1_listParts

Authentication BearerToken

Parameters

  • User-Agent in header string required

    Please provide the name and version of your application here.

    example
    partner-web-app/1.0

Responses

200 A JSON containing a list of all parts available.

401 Your credentials could not be authenticated.

application/json

ListPartsErrorResponse

403 You are not authorized to list parts.

application/json

ListPartsErrorResponse

500 An internal error has occurred. Additional details might be provided in the response.

application/json

ListPartsErrorResponse

Webhooks

Requests FIASCO sends to the callback URL configured for your account.

calculationRequestCreated

post

Webhook for calculation request events.

This webhook is called for events that occur when processing calculation requests.

Parameters

  • User-Agent in header string required

    Name and version of the application providing the calculation.

    example
    FIASCO Cloud/1.0
  • Authorization in header string

    An optional authorization token can be send as bearer token (provided by you).

  • event in query string required

    A name identifiying this event.

    one of
    requestReceivedvinLookupErrorcalculationReadycalculationRequestClosedfeedbackRequested

Request body (required)

Responses

200 The webhook has been received successfully (all 2xx responses are considered to mean this).

400 A client-side error occurred (all 4xx responses are handled like this).

401 A client-side error occurred (all 4xx responses are handled like this).

403 A client-side error occurred (all 4xx responses are handled like this).

500 A server-side error occurred (all 5xx responses are handled like this). In this case we will try to redeliver the webhook notification a few times.

expressLinkCompleted

post

Webhook for express link events.

This webhook is called for events surrounding express links.

Parameters

  • User-Agent in header string required

    Name and version of the application providing the calculation.

    example
    FIASCO Cloud/1.0
  • Authorization in header string

    An optional authorization token can be send as bearer token (provided by you).

  • event in query string required

    A name identifiying this event.

    one of
    linkSentViaSMSlinkSentViaEmailrequestReceivedvinLookupErrorcalculationReadycalculationRequestClosedfeedbackRequested

Request body (required)

application/json

ExpressLinkResultBody

Responses

200 The webhook has been received successfully (all 2xx responses are considered to mean this).

400 A client-side error occurred (all 4xx responses are handled like this).

401 A client-side error occurred (all 4xx responses are handled like this).

403 A client-side error occurred (all 4xx responses are handled like this).

500 A server-side error occurred (all 5xx responses are handled like this). In this case we will try to redeliver the webhook notification a few times.

requestUpdated

post

Webhook for request events.

This webhook is called for events that occur when processing generic requests, including create, update, and status change events.

Parameters

  • User-Agent in header string required

    Name and version of the application providing the notification.

    example
    FIASCO Cloud/1.0
  • Authorization in header string

    An optional authorization token can be send as bearer token (provided by you).

  • event in query string required

    A name identifying this event.

    one of
    requestCreatedrequestUpdatedrequestReceivedvinLookupErrorpreprocessingStartedpreprocessingCompletedcalculationStartedcalculationReadypostprocessingStartedpostprocessingCompletedrequestClosedfeedbackRequestedvaluationReady

Request body (required)

Responses

200 The webhook has been received successfully (all 2xx responses are considered to mean this).

400 A client-side error occurred (all 4xx responses are handled like this).

401 A client-side error occurred (all 4xx responses are handled like this).

403 A client-side error occurred (all 4xx responses are handled like this).

500 A server-side error occurred (all 5xx responses are handled like this). In this case we will try to redeliver the webhook notification a few times.

Schemas

UpdateCalculationRequestBody
  • hailDamages array required

    A list of parts that are affected by hail damage. Can be empty and updated later.

    array items

    HailDamagePart

RequestMetaData
  • referenceId string | null

    A reference ID that is added to the request for future reference (e.g. case ID, order ID, etc.). Set this to something for your own reference.

    maxLength
    50
  • webhookAuthToken string | null

    If set, this token will be used from our servers to authenticate against a receiving webhook server. If not set, a value configured for your account will be used.

  • callbackUrl string | null

    The webhook URL to send the results to. If not set, the default URL configured for your account will be used.

  • billTo string | null

    If this field is set, the calculation request will be billed to the company associated with the value of this field. If no such company exists, the request will be denied. If the field is empty or not set, the request will be billed to the company associated with the API token. Possible values will be provided by FIASCO open request.

    The format of this field is that of a UUID with the prefix “fiasco-cust-”.

    minLength
    48
    maxLength
    48
    pattern
    ^fiasco-cust-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    example
    fiasco-cust-12341234-1234-1234-1234-123412341234
  • parametersTag string | null

    Selects the calculation parameters collection to use as the base for this request. Must match exactly one collection owned by the billing company (billTo when set, otherwise the API-token company) that carries this tag in its tag list. If omitted, the company’s default parameters collection is used (falling back to the FIASCO default). If the tag does not match exactly one collection, the request is rejected with status 400.

  • providerAccountTag string | null

    Selects which of your own provider accounts the resulting calculation and dossier are created in, by a tag on that account. Must match exactly one dat account of the billing company (billTo when set, otherwise the API-token company) that carries this tag in its tag list and is available for calculations — active, with verified credentials, and not limited to connector use. Tags are matched exactly, including case. Only supported for hail_damage requests with calculationProvider dat, and only for companies enabled for calculations in their own provider accounts — contact FIASCO to have this enabled. If the tag matches no such account, matches more than one, or the request is outside those conditions, the request is rejected with status 400. When omitted, the account is selected automatically and behaviour is unchanged.

    Note that preparatory steps FIASCO performs before the calculation itself — input optimization and standard work-hour lookups — always run in a FIASCO-owned account and are never charged to the selected account.

    example
    kunde-a
CalculationRequestType
  • calculationType string | null

    Defines the type of calculation that should be performed. Either a normal “damage” calculation or a “hail damage” calculation (mainly fixing dents). Depending on the type of calculation, different parameters are required.

    default
    damage
    one of
    damagehail_damage
    example
    damage
  • calculationProvider string | null

    Via this parameter it is possible to select the calculation provider. The default is “audatex”.

    default
    audatex
    one of
    audatexdat
    example
    audatex
DamageRequestData
HailDamageRequestData

The data required for a hail damage calculation.

VehicleData
  • vin string | null required

    Vehicle identification number (VIN; 17 chars) with optional check digit (18 chars).

    minLength
    17
    maxLength
    18
    pattern
    ^[1234567890ABCDEFGHJKLMNPRSTUVWXYZ]{17,18}\d?$
    example
    M2Y3ULY19D85CCCNN5
  • mileage number | null

    Indicates the number of kilometers the vehicle has driven. Required for total loss calculation.

    minimum
    0
    example
    142000
  • firstRegistrationDate string | null

    Date of first registration of the vehicle in the format as defined by full-date in RFC3339 (‘yyyy-mm-dd’). Additionally we support the format ‘dd.mm.yyyy’. Required for total loss calculation if not enough data is available via VIN lookup.

    format
    date
    example
    2020-04-14
  • licensePlate string | null

    Will be added to the calculation result (for further reference). Not required for the actual calculation.

    maxLength
    15
    example
    S-AB 1234
  • hsnTsn string | null

    Will be added to the calculation result (for further reference). Not required for the actual calculation.

    maxLength
    7
    example
    1234ABC
VehicleAndDamagePhotos
  • photos array required

    Photos must meet the following requirements:

    • Must depict normal passenger cars (EU 2018/858): Classes M1/M1G (excluding platform types SA, SB, SC, SD, SG, SH) or N1 (excluding BA, BC, BD, BE, SB, SG, SM, SF, BCSL, BX)
    • Cars must be younger than 20 years
    • Must be pre-classified using the subject field to discern damage photos from general photos
    • Subject must be clean (not wet, dirty, glossy, or snowed over) with clearly visible car and damages
    • Reflections must be kept to a minimum
    • Car must not be constricted (recommend at least 3m free distance around car)
    • Multiple photos (ideally four) for each damage from different angles (slightly tilted left/right/up/down)
    • Minimum resolution of 1500px × 1500px
    • Must be correctly oriented or include EXIF data for orientation
    • Damaged part must be completely visible on at least one photo
    • Must be taken using daylight or in a well-lit area (avoid focusing light directly on damage to prevent reflections/overexposure)
    • Must not be manually edited (no markings like lines, arrows, circles)
    • Must not contain hands/fingers highlighting something
    • Must not contain deflectometry patterns (horizontal/vertical stripes)
    • Must not contain hail damage
    • Avoid re-encoding files (e.g. JPEG to JPEG or JPEG to PNG)
    • Quality settings of encoders must be 90% or higher

    array items

    • data string required

      Base64-encoded image data. Formats: JPEG, JPEG-XL, PNG, HEIC (HEVC encoded in HEIF), WebP, or TIFF.

      format
      byte
    • contentType string | null

      The MIME type of the image (e.g. ‘image/jpeg’, ‘image/jxl’, ‘image/png’, ‘image/heic’, ‘image/webp’, ‘image/tiff’).

    • filename string | null

      Filename of the photo.

    • subject string | null

      The subject of the photo (common picture of the car, photo of a damage, other/unspecified, …). The value glass_sticker means a special sticker placed behind glass to highlight defects in the glass itself, e.g. a chip in the windshield.

      Only photos not marked “common” or “other” will be considered for damage detection.

      default
      common
      one of
      commonotherdashboarddamageregistration_papervehicle_frontwindshieldglass_stickerglass_generalglass_damagetires_generaltires_damageinterior_generalinterior_damagebody_dirtglass_dirtinterior_dirt
VehicleDamagesToConsiderOrExclude
  • damagesToConsider array

    If not empty, the union of damages detected in the photos and this list will be considered in the calculation. This is a way to limit the calculation to certain damages (e.g. a subset reported by a driver).

    minimum
    0
    deprecated

    array items

    • damagedPart string required

      The damaged part (e.g. ‘bumper_rear’, ‘bumper_front’, …)

      one of
      a_pillar_lefta_pillar_rightbumper_rearbumper_frontdoor_rear_leftdoor_rear_rightdoor_front_leftdoor_front_rightengine_hoodfender_rear_leftfender_rear_rightfender_front_leftfender_front_rightfuel_filler_capheadlight_leftheadlight_rightrear_mirror_leftrear_mirror_rightrear_windowrim_rear_leftrim_rear_rightrim_front_leftrim_front_rightroofside_rear_leftside_rear_rightsill_leftsill_righttailgatetaillight_lefttaillight_rightwindschieldroof_windowtrunk
    • damageType string required

      The type of the damage (e.g. ‘paint’, ‘dent’, …)

      one of
      paintdentpaint_dentcrackcrack_defect
  • damagesToExclude array

    If not empty, the damages detected in the photos less the damages defined in this list will be considered in the calculation. This is a way to limit the calculation to certain damages (e.g. new vs. old damages).

    minimum
    0
    deprecated

    array items

    • damagedPart string required

      The damaged part (e.g. ‘bumper_rear’, ‘bumper_front’, …)

      one of
      a_pillar_lefta_pillar_rightbumper_rearbumper_frontdoor_rear_leftdoor_rear_rightdoor_front_leftdoor_front_rightengine_hoodfender_rear_leftfender_rear_rightfender_front_leftfender_front_rightfuel_filler_capheadlight_leftheadlight_rightrear_mirror_leftrear_mirror_rightrear_windowrim_rear_leftrim_rear_rightrim_front_leftrim_front_rightroofside_rear_leftside_rear_rightsill_leftsill_righttailgatetaillight_lefttaillight_rightwindschieldroof_windowtrunk
    • damageType string required

      The type of the damage (e.g. ‘paint’, ‘dent’, …)

      one of
      paintdentpaint_dentcrackcrack_defect
HailDamagePart

Data required to calculate hail damage costs. If a part shall be replaced, only a subset of information is required (basically just the part id). If a part shall be repaired, more information is required.

HailDamagePartMetaData

Meta data about a part that was damaged by hail.

  • partId string | null required

    The FIASCO part ID of the part that is affected by hail damage.

HailDamagePartRepair

Data required to calculate repair costs after a hail damage.

  • isPlastic boolean | null

    Set this to true if the part is made out of plastic.

    default
    false
  • repairMethod string | null required

    The repair method for the part.

    one of
    repair
  • allowRepairMethodOptimization boolean | null

    If set to true, the calculation engine is allowed to choose the best possible repair method and techniques. In this context, “best” refers to the cost.

    default
    false
  • optimizedRepairMethodThreshold number | null

    If repair method optimization is enabled, this threshold controls how big the difference between different repair methods and techniques must be before a method or technique are changed.

    default
    0.01
    minimum
    0.0
    maximum
    1.0
  • repairMethodOptimizationMethods array | null

    If repair method optimization is enabled, this field determines which optimization methods will be used for repair.

    default
    []

    array items

    one of
    hail_repairpressreplaceglue
  • numberOfDents integer required

    The number of dents on the part.

    minimum
    1
    maximum
    800
  • avgDentSize integer required

    The average size of the dents in millimeters. Values can only be given in 10mm interval steps.

    default
    10
    minimum
    10
    maximum
    80
  • repairTechniques array | null

    The repair techniques that can be used for the part. One ore more techniques must be specified.

    default
    []

    array items

    one of
    prePrintoverlapZoneglue
  • usePtpValuesWithHailRepair boolean

    When true, the PTP values below will be required and used when performing hail_repair (during repair method optimization or directly). When false, these values will not be required or used.

    default
    false
  • ptpNumberOfDents integer

    The number of dents on the part from PTP statistics.

    minimum
    1
    maximum
    800
  • ptpAvgDentSize integer

    The average size of the dents in millimeters from PTP statistics. Values can only be given in 10mm interval steps.

    minimum
    10
    maximum
    80
HailDamagePartReplace

Data required to calculate replacement costs after a hail damage.

  • repairMethod string | null required

    The repair method for the part.

    one of
    replace
HailDamageData
  • hailTriggerVariant string

    Variant to use for calculation matrix and rules. Please contact support to acquire possible values. When omitted, the default depends on per-company configuration.

  • hailDamages array

    A list of parts that are affected by hail damage. Can be empty and updated later.

    array items

    HailDamagePart

CalculationParameters

Contains all parameters necessary for an actual cost calculation (e.g. labor rates).

All of

  • paintSystem string | null

    The paint system to base the calculation on (AZT or Manufacturer). When omitted, the default depends on per-company configuration.

    one of
    manufacturerazteuro
  • replacementPartsSurcharge number | null

    Relative surcharge for replacement parts (e.g. 0.1 for 10%, -0.2 for a 20% discount) [Audatex block codes 20 and 21]. When omitted, the default depends on per-company configuration.

    minimum
    -10
    maximum
    10
  • paintMaterialPercentage number | null

    Relative percentage of paint material in relation to labor costs (e.g. 0.3 for 30%) [Audatex block codes 40 and 51 depending on the chosen paint system]. When omitted, the default depends on per-company configuration.

    minimum
    0
    maximum
    1
  • paintMaterialVw number | null

    Paint material costs per unit in EUR for VW vehicles [Audatex block code 81]. When omitted, the default depends on per-company configuration.

    minimum
    0
    maximum
    999
  • smallPartsPercentage number | null

    Relative percentage of small parts material in relation to labor costs (e.g. 0.01 for 1%) [Audatex block codes 40 and 51 depending on chosen paint system]. When omitted, the default depends on per-company configuration.

    minimum
    0
    maximum
    1
  • colorMatchingAllowed boolean

    Allow paint color fading on adjacent parts.

    default
    true
  • paintAllAssemblyPartsDismounted boolean

    Paint all assembly parts dismounted.

    default
    true
  • resetErrorMemory boolean | null

    If set to true, a position to reset the error memory will be added to the calculation. If set to false, it will not be added. If omitted, a context specific default is applied.

  • ignoredPartTagsByAction object | null

    Defines which part tags should be ignored for specific actions during calculation. Each action type can have an array of tag strings that will be ignored.

    • replace array

      Array of part tags to ignore for replace actions.

      default
      []

      array items

    • repair array

      Array of part tags to ignore for repair actions.

      default
      []

      array items

    • paint array

      Array of part tags to ignore for paint actions.

      default
      []

      array items

    • repairPaint array

      Array of part tags to ignore for repair paint actions.

      default
      []

      array items

    • newPaint array

      Array of part tags to ignore for new paint actions.

      default
      []

      array items

  • checkTireWhenReplacingWheelArchTrim boolean

    Enable checking the tires whenever the wheel arch trim is replaced.

    default
    true
  • onlyCheckWheelsAndTires boolean

    Enable to force wheels and tires to only allow check positions.

    default
    true
  • workHoursForHighVoltageActivation number | null

    Number of hours required for high voltage safety procedures during a calculation.

    default
    0.5
    minimum
    0.0
    maximum
    10
  • materialCostsCavitySeal MaterialCosts
  • materialCostsAdhesive MaterialCosts
  • materialCostsAlluvial MaterialCosts
  • materialCostsUnderSeal MaterialCosts
  • maximumRepairTimeByPartGroup object | null

    Defines the maximum repair time for parts in a group, before they will be replaced instead of repaired. Possible part groups: front_bumper, headlight, window_screen, engine_hood, front_fender, front_door, a_pillar, b_pillar, c_pillar, d_pillar, door_sill, strut, roof, wheel, back_door, rear_bumper, side_panel, tailgate

    • groupName number

      Maximum repair time in hours.

      default
      null
MaterialCosts

Sets the additional material costs for this material depending on the amount of affected parts. Please not that only certain parts incur costs for a material.

  • steps array

    Array of number of minimum affected parts to choose costs for.

    default
    [1,3,6]

    array items

  • costs array

    Array of of material costs to apply for the minimum number of affected parts given above.

    default
    [10,15,20]

    array items

LaborRates

Defines the labor rates to be used for the cost calculation. All fields are optional. Any field that is omitted will inherit from the company’s default calculation parameters preset, falling back to the global FIASCO default preset.

If laborRatesArea is provided, the average labor rates for that area overwrite any specific labor rates that are also provided.

  • laborRateMechanics number | null

    Labor rate for mechanical work (Karosserieschlosser)

    minimum
    0.01
    maximum
    999.99
    example
    80
  • laborRateElectronics number | null

    Labor rate for electrical work (Elektrik)

    minimum
    0.01
    maximum
    999.99
    example
    80
  • laborRateBody number | null

    Labor rate for body work (Karosseriebau)

    minimum
    0.01
    maximum
    999.99
    example
    80
  • laborRateHailDamage number | null

    Labor rate for hail damage (Hagelschaden)

    minimum
    0.01
    maximum
    999.99
    example
    80
  • laborRatePaint number | null

    Labor rate for paint work (Lackarbeiten)

    minimum
    0.01
    maximum
    999.99
    example
    80
  • laborRatesCountry string | null

    Country code (ISO 3166-1 ALPHA-2) for the ZIP code.

    default
    DE
    one of
    DE
  • laborRatesArea string | null

    The area in the country (usually a zip code) for which average labor rates should be determined.

    example
    12345
  • laborRatesZipCode string | null

    The zip code for which average labor rates should be determined. DEPRECATED: Use laborRatesArea instead.

    deprecated
    example
    12345
CalculationRequestResultBody
  • success boolean

    Either true (request was successfully created) of false (an error occurred). Always available.

    example
    true
  • message string

    Describes the return status (e.g. error details). Can be null or empty.

    example
    Calculation request successfully processed
  • calculationRequestId string

    ID of the newly created request. Only available when success is true.

    format
    uuid
    example
    12341234-1234-1234-1234-123412341234
  • calculationId string

    ID of the finished calculation.

    format
    uuid
    example
    12341234-1234-1234-1234-123412341234
  • calculationText string

    The calculation text as returned by the calculation engine. Only available when success is true.

  • calculationDV90 string

    The calculation in the DV90 format. Only available when success is true.

  • calculationVXS string

    The calculation in the VXS format. Only available when success is true and the calculation provider was DAT.

  • calculationPDF string

    Base64-encoded PDF that contains the results of the calculation. Only available when success is true and the calculation provider was DAT.

  • referenceId string

    The reference ID that was passed in the original request.

  • audaNetCaseId string

    The AudaNet case ID. Only available when success is true and if an audaNetRecipient was specified when the calculation was requested.

    format
    uuid
    example
    B1CAF6C5-AFAF-B40D-B0C8-9E0A2A041179
  • AXTaskID string | null

    The AudaNet task ID of the calculation, for merging it into a case of your own. null when the calculation was not performed by Audatex or no task exists for it.

    example
    40123456
  • totalPrice number

    The total price of the calculation without tax.

    format
    float
  • totalPriceWithTax number

    The total price of the calculation including tax.

    format
    float
  • totalTax number

    The total tax amount.

    format
    float
  • taxRates array

    The tax rates that were applied in the calculation.

    array items

    • rate number

      The tax rate percentage

      format
      float
    • amount number

      The tax amount for this rate

      format
      float
RateLimitErrorResponse
  • success boolean

    Always false.

    example
    false
  • error string

    Machine-readable error code.

    example
    daily_request_limit_reached
CreateCalculationRequestErrorResponse
example
{"message":"Your token could not be authenticated","success":false}
  • success boolean

    Either true of false. Always available.

  • message string | null

    Describes the return status (e.g. error details). Can be null or empty.

CreateCalculationRequestSuccessResponse
  • success boolean

    Either true (request was successfully created) of false (an error occurred). Always available.

    example
    true
  • message string

    Describes the return status (e.g. error details). Can be null or empty.

    example
    Calculation successfully requested
  • calculationRequestId string

    ID of the newly created request. Only available when ‘success’ is true.

    format
    uuid
    example
    12341234-1234-1234-1234-123412341234
  • photos array

    A list of photos that were successfully uploaded. The order of this list equals the order of the list received during the request.

    array items

    • filename string

      The filename of the photo.

      example
      fi-img-952a6927-5c6c-49ab-881a-3d29b4399292.jpeg
UpdateCalculationRequestSuccessResponse
  • success boolean

    Either true (request was successfully created) of false (an error occurred). Always available.

    example
    true
  • message string

    Describes the return status (e.g. error details). Can be null or empty.

    example
    Calculation successfully updated
UpdateCalculationRequestErrorResponse
example
{"message":"Your token could not be authenticated","success":false}
  • success boolean

    Either true of false. Always available.

  • message string | null

    Describes the return status (e.g. error details). Can be null or empty.

ExpressLinkRecipients

An express link can be sent via email or SMS. If both targets a specified, the link will be sent to both.

  • emailRecipient string | null

    An email address to send a request for data to.

    format
    email
  • smsRecipient string | null

    A mobile phone number to send a request for data to (via SMS).

    format
    phone
ExpressLinkVehicleOwnerDetails
  • firstName string | null

    The first name of the vehicle owner.

    maxLength
    128
  • lastName string | null

    The last name of the vehicle owner.

    maxLength
    128
  • street string | null

    The street name and number of the vehicle owner.

    maxLength
    128
  • city string | null

    The city of the vehicle owner.

    maxLength
    128
  • zipCode string | null

    The ZIP code of the vehicle owner.

    example
    12345
  • country string | null

    The country of the vehicle owner.

  • phoneNumber string | null

    The phone number of the vehicle owner.

    format
    phone
    maxLength
    35
  • emailAddress string | null

    The email address of the vehicle owner.

    format
    email
    maxLength
    160
ExpressLinkStyling

Please note: Due to certain limitations in the OpenAPI specification (required fields cannot be defined as dependent on a value of another field), the specification is slightly incomplete. The fields marked as “required” are only required if the field doCalculate is true.

  • logo string | null

    Base64-encoded logo image. Supported formats: SVG, JPEG, PNG, HEIC (HEVC encoded in HEIF), WebP, or TIFF.

    format
    byte
    example
    iVBORw0KGgoAAAANSUhEUgAAAlgAAAC6CAIAAAD9F6QrAAAAAXNSR0IArs4c6QAAL1ZJREFUeNrtnXd4VVXat+ev7311nGIZx9HpMzpdASkKKnaxYUcB6QEB QSnSpRcFlCoI0otKFQEBBVFsCNJJb5BKKklIIT18d86SvJkkkL3PTsgpv9+1Ly/khJ11nlXutZ71rGf95JwkSZIk+bF+IhNIkiRJAqEkSZIkCYSSJEmSJBBK kiRJkkAoSZIkSQKhJEmSJAmEkiRJkiQQSpIkSZJAKEmSJEkCoSRJkiQJhJIkSZIkEEqSJEmSQChJkiRJAqEkSZIkCYSSJEmSJBBKkiRJkkAoSZIkSQKhJEmS JAmEkiRJkiQQSpIkSZJAKEmSJEkCoSRJkiQJhJIkSZIkEEqSJEmSQChJkiRJAqEkSZIkCYSSJEmSJBBKkiRJkkAoSZIkSb4CwqiE/CPhecci/es5GpGXnVdS xRT5haXmIyv/nP/y817XjE6eulh181FccoH/dKqi4tKsnOJT6YXRiQUhJ8+W16wPtfDyJlpQX020oKg0I7s4IbUwMj4/+IQvWOxIeC5fpy5NVFiacQYTFWCi oBNnvaPZROYdj8oLiz0bk1SQmlGUe7akrKzML0DYZ+qJRp0Cm3cP8qunSZfAfUE5VUxxIrGgZc/gZt1q/+f8TMuAYH7e6yh4f//Qpl0v+L2adgl6bFBYUnqh r5IvL7+EUXvTVxnTV5965e2TL7we+cjAsHv6hrbqFXxbj2BfauE00dsCghmC68p0mdnFh8JyPtyZPmlpQu+pJ58bEdnm1bC7+4S06ukjpru54/Fpq045MVHG maKDoTkffJY2cWnCS2+eeHZE5EOvhrXuE9LSq0zUonvQ7QHBd74Ucn+/0LZDwruMjx72Tuy7G5M/P5AVm1xQWlrmmyDsO+1kk85B1JNfPcBgf00gvKNXSIvu tf9zfoaf9C4QFpeU9X/rZONOgRf/ao1eDBz5bpynTQMdKiev5IuDWeMWxT81NKL8O3YK5GvS7GkGzboxQpVXaAvfauF8I8Zf5yBMySjatOf04NkxDw8MA663 vBiI9Yzpmndz2c1XTEeTYHrkhomSTxdt/DJ94KyYNgMqmaiLt5qoRY8fy0y/4Ovc2iWIQeMWV39p3Tuk8/iod9YnBUblNdQQIRAKhI60ZldarRQ0z61dAnfs zfANBKacLly4KfnJoeFNOpcPT826BlmpX4EQhceenbws4cH+oditcWfGdB8fJdwAYejJvIlLEu7/PxP5fqOCi0CRPwdMid6+N4PNBYFQIPQaEJ5IzL+3b4jF jopxcBiCEK9GYGFR6crtqbjv6Ld8I39r4U5AmJ5VNHVl4h29ytng84O7eyBk/2zK8gTcwn5losqtC2o07hzYdUL094HZAqFA6B1O0X4WnKL/NSh0Chy1wIsd pIC/5xvRDFLNuvld23YIwr3Hs58YEs7swU+Wzm6A8OsjZx4f7I8mqv7ADrYVZ3x4quBSRQ4KhAKhu07RnWm2KHjeQRr02b5Mb6TgwdBcdmvc+MoC4Ybd6QRK UPV+aDGLIKQ3EU7ihz6Gi7Q05gSEnmXmFAuEAqGHKjoh/x7LTtEqJnp0UFhKhpc5SAmCxwnsn0O5QxCu351O2LAfOvqsg/DDnWnsoPutiS7ywMLeb56ofiZN IBQIPcIp+vJ0nKJu1i8O0tEL47yIgompBRz/EAXdACEe0fIQfz8e4msF4VdHzrQoP2Ag7F2QhQwX9X2+QiAUCG2LI00OPYRAZaeXOEhLSssGzYpp5N8eUfdA ePpM0ZNDwv18AnFxEKZmFj02OFwe0Ys/jDabvjotEAqEHqQod52iVQzFGosYOc8H4a79mZyR0GDkBghnfnjKxMQLhBcy0bRViTJRrQ/Hkx4dGEbUsY+DkGGx /DCy9z//7nD8++O+DELO91CzjesCDAwQY96LP3fOoyNI+b5dxke5t6ahNmnY5eHgncrPDvtGC2fUZjcrIq52EOJPvvflUPc8fs0rmc7bLfb3dsfeWJFYo4nI qHJ37xB/MFFj14FI+hHh1i3cdZAu3pziyyDENB3GRDEmjl7o9Q/JU6pPln0JhDhF68pJ2MLlIN31g0c7SPcFZbvhtmriyppxV++QZ0dEkDZs6Duxoxf4QvPm eX1h/JhF8SQ9qdV0S7ak2F3r0P4Z1rHefS+Hth8dxeGcEfPjvN1iw+fFbf225jwS736U7J6J6DgkKmPY7P9WjFeYaNSC+MGzY7tPisYPbCbBzWx2K7rh08Mj yGXosyCkKSz9JPWc78pnQBgVf9a5U7RK4+bgVFqm5zpIpyxPbGRnqCKzGhGSvd44Qf4w8gsXeGH+9LoKp+o8zt5Kmh8m0e7webG7D2QlnS7iDb5tIpwN7UdH NrVpIs7aj5wf9+WhrGTvNBHxn+RRYwbAoVK7cQYMF/V3yt4jQLhos0Do6SA87xQNqvMdlLGL4j2z4rgJod3ISOsrQia5OAOZ/jd4BmEPaPP5Ftt8xQHqdiMj DoXm+I+JcC+z22rLRCRzPxqR6xtfnztGpq5IYB5g3QKQYvbaJIFQIGxIrd6Rat0pirvbeu4VSPP5AU90kJ48VXCn5dG8eXndBe8Pyj4nnTv36b5M6/P9cq/X sPBTaYV+ZaKt32RY71C3dg3Cze51p29rFWCz3k7wmXOmsJ7mmAKhQGjFKZrPzTgWnaIsjNq+Fk5Caotrqaaun0/L8jgH6TdHs6079xjUSJ8vBBq9u9HGBiEN YM+hLH8z0ew1SdZNRGry74774ByroLCkwxirThfm1gwU3GUoEAqEDSCcotwuadEpakJgvjqchTff+p0MtIFxiz3OQbrhi9MWNwj5mlwlE+tPlw9fXGMWxluc 6TMIslVWVOx3zmSCXCxf2xLEhmuJj/rbrcff0cvu7hOaWD+eA4FQIKxFq+w4RfnJ1xf8mDWGi/qsgsQ1IHK3n0d9ccK1Lc7Z2ep4cazPDlVuaMCMGIvdnwbD lbx+aCLrIySdaOqqRF+1Q1B0nhkBrAyPZKwNj82vj2IIhALhxRQRd5a1jnWn6MMDwpLPX7TElgb3LjWz7iAdEp7uSQ7SueusRrfT1F95O0b8qxCHRqx3//c+ TvFDEwVMPmHR8Y6JlvluXD0rPLZdLA2PrhEyMOqsQCgQXlLhsGJ32nqkKDX+yX8fmfrk29PW07LQEiYs8SAH6ey1NkA4YKZA6CYIl2xJ9UMT9ZhkA4Tvf5ru q3bgHIjFxAsCoUDYMOIGWltO0SFzY6vcNVhaVjZ4Nok6g6ynYvnSYxykAqFAKBAKhAKhX4MwPNaOU7Rb8IP9QxNSaih5bHL+ff1CLZ6mAISctCVZs0AoEAqE AqFAKBA2pAqLSkmPYt0pSvbRj768YHr4NbtsJGajPUz0jOgJgVAgFAgFQoHQf0G4YpsNpyjJD1+dEXORmEkOYPQuP4BhNYKU+Jo9hxveQSoQCoQCoUAoEPop CG05Rfkx2vHJxFpimsNizt75ktVE+zhIOY+f0dAOUkWNCoQCoUAoEPojCHGK9nwj2rpTlIXjhzvTrLx50cfJ1hNY0yomLWtgB+kiW+cIx+kcoUAoEAqEAqFP gHD5J3acop2D+kw7gefTypvPFpSSIMNiq8AUxNd8deRMA5pi/W57mWXilFlGIBQIBUKB0NtBGBaTd5cdp2jrPiGcuLf+/sNhOeSGsJh3jUTDTw0LJ0t9Q1nj myNnbOUafXdjshAoEAqEAqFA6MUgLHeKTrHnFF2+zXZOkBkfnrrFjoN0yvIGc5Cy8Wnr9gk2QQ+E+NFFQgKhQCgQCoS+BsKlW1OsO0Wp3IDJ0bDT7m85k1v8 3IgIi0OAcZB+fbRhHKRcq2vrPkJ+khOT2/dmVMkqIBAKhAKhQCgQegEIQ+1EdZq794JP5LnpcjyaBd4srrSIQ3l6WERmAzlIJy9PsHlDfRA45LKOLd9kxKUU uDFREAgFQoFQIBQIGwCEXMUeUO4UtZxNjUTJmxwlSianqK0I0jdWNIyDlMukrK8IKy+XuWGHVMLPj4p8efrJkfPjxi9O8LRnwpKEN1cmciseHCIZwtdHznDE 5fSZ4jpZzgqEAqFAKBB6GQiXbk215RTtPD6KEFAnvzEts+ixQWEWGYNZuJj022MN4CAl7TiRrtZDZqqnTjVQbOSpD72Phz/wHYljeujVsK4ToicvS9j2XWZC qvsXvwmEAqFAKBB6EwhDTuZZd4pSwpYBwUcicp3/3h17M5p0sUpfhoxnhkdk5jSAg/SzfZnW18pe/bgmHOWmhovlK9q+If2mx2z+OiMr17bZBUKBUCC0DcKF m1KKS8q89Kn1GLUng5B4kB6To5tYjhSlsuauS6qTX40HbujcWFs5SKeubIDrSalf0qdZL6cvcZGGwRdv+1o49+Fl5xULhAKhQFhfIOS7tRkQ1mF0VHsvfFim cB7Ae0G4ZIuNSFH6bfvRkblnS+rqt8enFDzQ3+rFFMZB+l1DOEgpJzcMu+cg9YGH1K+MxcT6Ws9vIBAKhAKhPRCao9nspnjj858Ox4e8E+ulICTs886Xgq07 RVt0D/ohOLtuy7B+d3pjOyR+dkREVkM4SA+F5hD80tRfWWiMz0Rk3oakkpIygVAgFAjrHoTe+zCID58f540gzC8s6T7JnlP0rffr3jNZXFL68rQTjTvZKMa0 VYkN0mP3B+c89EpoY//zkVZun9h/3KL4WpPqCYQCoUAoEHoBCBdvTrae4eXHpVhuvVwHQZI265ddlDtIuwftDcxukE4blXA2YFI0drPozvXJ55aOgVNXJF78 lIVAKBAKhAKhp4Ow3Cnay4ZTtFk9n14oT2pjh8rPjYw4k9swR+wJL1q2NeXBV0LLcdjVH3HYwtXsN36ZLhAKhAKhQOitIMwvLO020Z5TdHI934iEn7bLhCjr RYKa01cnNmDvTUovnL8hmXDKJp3LD+GVJ8rxq/CZbsEkkyOGSCAUCAVCgdArQWjrXsDyO3KHhJ+u/ztyj0bktrR8MYWJ3Pm+gRykFWJVumt/1ugF8U+8Fk55 GrlOptPsMRqeXlchg30VkIzOE5cmCIQCoUAoEHofCIOi8+6w7hR1gXD3waxL0yVmrz1la9uyXcM5SKuIIyWBUXkbvkh/c0UiOdXajYrkRNDdvUNaBQTf5nIs e+BDBCyJAjB4407ubHnShLiE60JXMAqEAqFAKBB6KAjtOkVZ4ox9L/6SdQmObIMQ68f1GCDefj/RA/t2YXEZWcITUgoi4vIB5OHw3ENhnvUcDM0l4IikOdzD PPLduLZDwjG73cMh2J/NXYFQIBQIBUJvAuF7Np2ijw4KS80ovJS94rvjZ5pbvpjCOEj3B2Wfk5xOQUo+/T6zw+hIW8nkGMdJS1RaU2YlgVAgFAhtg9AkOfTG h1DyofO8A4SBUbmtLDtFzTC34/vMS98xJi9NsBVB+vyoCFvZv6SL4HDUu3HWWUhburdvKHFDAqFAKBA6BSHfjZwdDw8Ia+OFz719Qy4SMuA5IMQp2tVWWCYr 3XmxDXK/bHpWEdGY1i8/YpiY8cEpYaxOxOEQ7lu27p3Gm7ovMEcgFAgFQqcgZMyduz45M6eEbRWvezKyi2vNvekJIFy4yYZTlNAJruM5lVbYUH1j575M62Ox MWyd537zW+Fqbt7Nxi7yut3pAqFAKBA6BSHVvHiLrmGqRxAej8xt1dOGUxTn2OavTzegxchawnrUVjbwF16PzJGDtE4WhUWlZBGyuCKn887bkCwQCoQCYR2A UPcR1h8IzxbYPKveKXDQrJjS0rKGNVpiagHZW6yH9dOKZn4oB2ndaNCs2MaW3Tk13o0lEAqEAqFA6EEgXPCRjZyigOf+fqGxyQWeYDeSeFkP3DDmPRCSI4w5 19hFCRaX47hGJ9W0Ry4QCoQCoUDoKSC07RTtFLjuc0/pclx63P+tk41tXpeYU3fXJfqtxi22DMJOAqFAKBAKhB4MQpyincfbcIqCnH7TT3IvkueYLir+LBHF Fi+mMG1p9pokkUwgFAgFQoFQICzX/I02nKLABuREJeR7mvWWb0u1Hu+KAW/vEXwwVA5SgVAgFAgFQr8H4bHInJY9reawNiPaqh2eWAsEMdq6QJjBhQwpuXKQ CoQCoUAoEPozCPNwio6z4RTlJ3u9caKwqNQzDXg8KtcW1GlRc9bKQSoQCoQCoUDoxyCctyHJujuRJnjnSyGhMXmebMO565NuseUgDQg+FCYHqUAoEAqEAqFf gvCInYv9TAT8ki0pHm5DYkE5Mm893UwTHKRjInPz5SAVCAVCgVAg9DMQ5uWXdMIp2sWGU7TbxCgyTHq+GbmGt3n3IFsO0rnr5CAVCAVCgVAg9DMQzrPpQuSU ITtw3mLJN1Yk2nWQHg6Xg1QgFAgFQoHQb0DIoH97gL2gkvkbvGnNdPpM0RNDbFxMwcr4xbGReXKQCoQCoUAoEPoDCBnuXxxrxynaJajjmCivg8TnP2Tdauci 9QtlhZYuohHz4xpbBuHkZTWAsI8dEC74KMUPjRww2QYIl/ruXCEhtbB1H2vDo2uEDIoWCAXCC+ud9Um2Dp7f1iPISw+ec3ms9Ysp+KaEDh2NyD0nWROXUPaY ZPVKwkbluc5rcCoMnBljPW33mPfi/dDO/d6ycVHdpNouPfVeHQnPtXjtV3lf7hkcGV8vST8EQl8A4eEw205R772rgSvRuS7R+sUUtEMCiEg4J8hZm6EX3NM3 xGJ+WkC4/JMaOu8Ey87VZl2Dnh4W4Ye18/qCeIsmYi+g3chIjz3m61CLN6dYnMEzvt3bN5TuLxAKhDWILCo4Oa07DPnJdiMjsvO8eOjZtOe09YspvHE3tAFF LgLrC25qYef+zBpHN+thTQwUH3912t/sPH+DjQyIt3YJ3PZdhu8ZISun+Mkh4c2s7frzY08NZc5ULxMCgdDrQThnnb1IUQ4hcBTBq01aUlr2ygwupgiynjSA +NhjkXKQ1qIvDmZZP4Rq3M7hsfk1veeM9cRGzboFP9A/NOhEnl+Z+rPvM63frIL/o82roR6e9cKuiorLRi2It96LaVFcR1NPhREIvRuEh+w7Rd+s6SZVr1N0 4tlyD57liylojdzFIQfpBf0K+SUrtqXe0SvYus+5fIZ+Aa9mQkqBxQiICu8f9zBv/eZ0UXGpnxg8JqmAjE7WTYQjp82rYdv3ZnA9mQ98fS6WeXVGjF2/zsJN 9RX4JhB6MQhxipI/xXqkaFPXyJWZXewbhl213cbFFOcDFN3oSGWux9dUWlqWX1CacrqI24zf3Zj87IgIwlusX11pNggnLIm/0MvJXmt9UWgWPYz1TFa4b+RY ZF56VjF5HkrLfNP4xqvRbWK0rRDochN1Deo6IXrl9tTjUS4TFRkTebrKysq4343tmJOnCj79PpN4N+66aWynebhuyAmqv6g3gdCLQTh7rZ1IURcI9xzO8hnD Ej4QMNnGxRTGQXrcpoOU3zJ8XlzXidE9Jp/wjYfAfS70IIDo6eER9/ULZXilFVk/nfl/86ouQXsv7GNfuyv9FjvTlIp1DzuULbqzQAx7dkQkXCSENcCbrY2d V3+aVvNMbkeaAxMFY6LnRhoTnQjw7PYG8tuPjnpscDiLYFaBuENtTbnMtyYSov4ihgRCbwUhhx84AmHLKTp+ia/FqQdF57XqFWy9U9Emu4yPyrez355fWNr2 tXCsR1f0sQffpt3xqPI5VCxZeGFP5umsoocHENzrzstbuC7IhM0+YOR/vXD8QpsRqRlFOIT9xEQUlSlXC3fbGx1w3ef1mFVAIPRKEJKEmlv3brXjFH18cHha VpHvmdfW/cPGobfgoyRbIHxmeIQbCybffgDh7gOZFzfdsk9S3Fjx+NhDe5u++oJHld77OFkmshboHplTn5eMCoReCcLZa07Z6j+0pBrD3H1AJMexNScwDtLA qDyB0O2HtjdsXmytu1NUDfdi2t0K8isQmhltk85qXRcbFXFdfHWkfvd0BELvAyHRDeezw1i9fZ7daR+28P7g7BZ2LqagZXadgIO0RCB0Zy3YufwIPG49K9Yj 4p/gXn+23sVBiAKj81r3DmmmBtag92wLhF4GQqaQ7e0sgOhgbNXUUzoGz9HUVYl2HaR4pQRCNyjYZkCYrQNtXx/J4lSG3xqwVhCi3a7jm2pjNdKBDHyX4MSI QOhlIJxl0ynapHPg1m8zzvm6OBNC1gnrQ0nzclOTwDdPILQ1KmEKN451f3vszP39Q62fH/c3EKI9h7LuezmksXykldIs0GDeWJ5QeEmOlgqE3gTCH4Kz7TpF X5sT6xUnjZzri4OZ4KqFncUNlxLn13YpsUBo9piZUQ2dG5uS4aZrISo+v+eUaKjgbz5AiyBE4bFnu02KZjy0ntPAVzcFGbi4m6lew0QFQm8FYXZe8Quv23GK dgsic1V8SsE5v9HohTYupjCD1KLNKQLhRRqkObVGzN6OvRkOz7ZzCOyDz9IeHVR+FsV/7GkdhIgcAqSJeGRgmF+ZqNKR+WDTf7kI7ERi/qUcOgRCrwEh90XY copycHXjF+nn/ElshZafXesabMdBGhJ80SyXfghCzMLpCNPYOHr/8VcZdXhv5ekzxSt3pL0wOpKJmjmd6fbZMt8DoVFaZhF3ejw/KpLVs8+bqDwotFsQXlAe Ju5jF8U3SE7g+gIhN3M2cqUPqPX5T0fCFnwchK16huDyrtUU/EzLnjWDcF9QNsmyrbyEx/gWXpkRQxqnc36mLd9k0KOsWKnCUKS9uEgOUkBIkCRgsPhOb3q6 lT/NXIey2Z3CFCbFzP39QntOObFwUwp7qKX104RYHRL8PHPNKRKjkG3rVhd3KQCzZxLWMDI27+YjRr65Y+C0Ve5cecbq8IfgnBkfnCI3TesqJurqnSbqVs48 kwSA5DI0NroqqZKfeC1ixLy4LV9npJxusJi++gLhwFkxd/QM4fqoWh8MUeOVZj4j0usx07mnT+2m4Gf4SX6+mlO0hMH6zl6W7MnDyPLooLBL7FvwEDFws5V1 h2Vb8RCwt3pH6kVA2HFM5F0v2Xih5z/38N+XQ2hseOFItAaNBsyMmboy8cOd6fuDc0hAeskyfDJX447yb49mr9yWxvWzXC/w4tiop4aGs7KneD5galrXrDVJ zkxUygbHN0ezV2xLm7g0oZ/LRE+6THR/f69pbyTze+iVMNJ6sNJlmoXzc9765G3fZYbGnM092/Cp8OsLhDhATqUVJaXX/pxKK8zJ8+U7AYj9tWKHiqd6rDCp dRksrL8By2P/c/4q0EWjsmWulAufiiNfcGpm0Sk7NegVT/LporSs4jO5JZirzJPCqUAjd85xUx0eQh+wM60LI9eTiVK9x0R0MQYlhnpuX/LAQeMn5yRJkiTJ jyUQSpIkSQKhJEmSJAmEkiRJkiQQSpIkSZJAKEmSJEkCoSRJkiQJhJIkSZIkEEqSJEmSQChJkiRJAqEkSZIkCYSSJEmSJBBKkiRJkkAoSZIkSQKhJEmSJAmE kiRJkiQQSpIkSZJAKEmSJEkCoSRJkiQJhJIkSZIkEEqSJEmSQFhFR48eHT582IgRwxcvXuz2S1atWslLhg8fun//fs+0bE5OzpQpk0eNGjFu3Ni0tDQ/aU+f fLJ12LChPJ9+usPTyrZ9+zZTtm3bPlHPr6vmPWHC+IyMDCev2rFju6mXHTsctRl6GX2NIlEwiqc6kjwahGvXrv3pTy+74orLH3/8Mbdf8sIL7XjJ5Zf/z9Kl Sz3TsikpKX/9619+8YufXX/9ryMjI528qvS8ysrKPLw9DR065LLL/odnzJjRnla2UaNGmrKNHDnCYw1IFVdUtydXtKt5/5nm/dvf3hATE+PkVaNHv27qZfRo R20mKiqKvkaRKBjF0+AueTQIN27c8KtfXX3ttdc8++wz/gDC3/zm11FREU5exWT5nnvuvvvuuz7//HMPb0+vvz7q6quv5Jk4cYKnlQ3+mQEXb4THGnDfvu/v vffu++67p2/f3p7MwtTU1P/851+07Rtv/GtsbKyTV7GmNG1mwgRHbQYQUh6BUPIjEK5du2bChHHjx489dOiQZ1oW58zMmTMmTZo4deqb6enpTl713HPPXHnl L375y5+vX79eIHRbu3btpMHw7Nz5mccakLJdddUvr776l/fff69AaEunT5+mr9HjZs58Ozc3V4O75Psg9Cu1b/885sJoGzduFAh9W59/vuvXv/7Vddf9qk2b BwVCSRIIpR/VsWN7A8ItW7YIhL6tr7/+yoDw4Ycf8uRyCoSSQGhD+/btmz17FtFc77wzNygoiL/ZtOkj5yA8cuTwZ599iuLj4x2WEC8KYYRvvvkGHXL16lUp Kcn8ZWDgcfN+twMBCgoK9uzZg6dr9+7P3XbUJCYmUoyHHnrguuuuZXykhLzw0KGDzuslKyvryy+/XLhwwfTp06igjz/eFB8f59sgDA8P+9Ql/uDeGwh64p9T IyEhwcaG2O2tt6bPmTN7586deXl5TorH+m/v3u+oDujC06rV7dQ17tzMzEyHX7ykpOTAgR+WLl3CyykqAb1nzpzxPRBif/oaRqPf0fucvOrs2bPEGONopWwr V65MSkriL4OCAs2YcOJEdF20xvAPP/xgxoy33377rfXr1yUkJDh/54EDByghjylwbGwMhZ8+fSrd/Icf6jK6njaJqRcseNe0qM2bP46Li6vD90MKhmIsg5d7 06ZNl2DHtx5BeOZMVu/eL11//XWuPY8r+e8f/vA7vtuGDeuhoEMQskhiV/znP//p8uXLnBTy+PFjBCYAZtMVeRo1uoW+9Mor/X7+8yt+9rOfzp8/z703U3l/ +9tNvPB3v7shKsrNqFG6CsW44Ybf8BIexh12Cp955iknX5kxgi/VvHlT4FrxrbHA3/9+07hxYxyO5p4MQqITqVAeCuneG954Ywr/nFZHuM3+/ftatrz9mmuu Mt+X9nzfffceOXLESb3cfvttVISp69/+9nqmPvwvv8jJtz548GDbto/RhCrXNSVnuPQxEBIsg914z9/+dqOToTM4OOiBB+6vGBMYuG655T8c7Rg4cIAZE6CX k3JCqb59+/zpT3+oaDz84Z///PvcuXMchoU/8cTjjA8MjJs3b169ejU9uqLSGYe7deuSlpbqsBMxXVu06L1mzW6lcVZuUdh88OCBycnJDt9/4sSJrl07Q4qK l2Mc7L9ixXKvBCE12r9/P2rFDN98GWM4/kBQHH/pEIRdunTC+tdccyVTHgedOeW225pTJFMeXkghTdQZ83GaDgVmMuVgpPg33/0vf/lTdHSUey95//3VRDlS EjM4UkhiZZ94oq2TeiEG9fLL/xcK8n15eLkZcPkD9fXSSz2Li4t9EoS4JUzZxo4d494bpk2byj+nTh999JGbb/43w6J5IcakdrDhrbc2Tkhw00UBCJs1a8qw a+raoIsgKeJInfhjbrrprxTsfB/8sZHz8CvYj/QlEEZHR9PXKBIFo3juvSQ9Pa1Vq5bVxwTeXDEm4EFxYrcHHriPWuZV/BazJDC9j7+cNm2aEws8++zTvI0p 1PPPP2e6s2vIvdIMILQl1g+FhYVORg+ORVFOjGzKbyoOE9Fc+fs77mjpZGkYE3OyRYvmBtsVxuHh12GixYsXeR8Icd9hGqqE3Y677roDt8wXX+z+4IP3H3vs ESrGQ0DIzI7GQWEYyDp3fhGfLev9OXPmMAGheGZ22bAgxEM7ZcqUli1vo2Xwqh49uuPCJWLWSdUEBwcTffPHP/7+pZd6rVu3Dnccbr1XX33F1Bftb8uWzQLh RUBIw6DnU62DBg14772FODkefriNQQvNye2XM/8gxYRxotxww3VNmjTi1/G47fzHIY+3g5ZM827SpDExzKwCOcX75JNtDQsZ2fHuCoSVxbLsqqt+HBM6duzw 0UcbGRPY1mnU6OaKMcEJCIcMGUwjoa+xIhw5cvgn5drar9/Lrkovd/w4CYM3IPz9739LL27atMn48eNYvfFfFnDn52pXbdu2ze334xY2oKXxMOfjPBLvp4ky qvM3gPDpp59KTk5ye63ZrVtXQ0HWlxR7+/btOF27d+9G4fnLG2/8C4t+LwPhtGlvmlkPdVB5jpydnf3gg/fzxRochGycPPLIw9QfJenZM6ByhB4bKn/+85+o 7wYHodGLL3Yw08atW7fWSe0UFRWxRVHlL+mWLpNeFRDQQyC8CAhpGIxiX3zxRcXf5+fnYzQzdb3zzlb8r9uF/Oabr02wzCOPtHH4fQmtMkuNxo1vqVzdABIf mvHQrFnzoUBYeSxu2/ZxMybgSGSIqPjo8OHDOIrMMt1tELJauummG6kRmhC7y5U/YqVlnLFMSR2CEAvg+o6Li638e2mWxisAdN1eDrZv/wKFZPTGdVx55ccc jt2Wl1/um5vrfkKfwMBAEI6F//znP3711Z7Kv5cy83sBysSJE70MhD16dDP1ygqmykfvvjvf7Kk0LAg5dcTKz0zE8CBV+bRdu+cooYeA8NIcn2CDmobIKMAJ tspDgEBYBYTURadOHauts4PY2KAtMW91kmmlDo9PvPbaILMZwSqnykfE4DCc8VHPnj0cNG9fAyHrYxbixvvy7bffVvm0Q4f2ZkxwG4QEzBuPH1PbKh+xqfnv f/+Tqm/evJnb+eEMCCnh3Llzq3y0YsUKsz/Vps1D7rUrDkOzHWCMU3kWWFci9Ma13XjVq6/2r/JRREQENUvh8So72bhpABAakGB6QmOqfIS3wXnUqHMQ4nFi AU5OJraUExOrhmz169fXeMB9GIT0BzYMCs6LbWoMQmu74w731zT+AEIaxrBhQ6p8RGgYYyjVDQ5NdHSDg/Dpp5+k2cBmIsKqj/jQgk9JV+TeppFPgjAp6RRB K4wJbKxW3+tirWbGBLdBSBiq+aY1jirPP9+OPs6eRWhoqBMQ8hIiLat8RE5mGMbsx+3ejVMBRwgvYVhzmCHkAvO2wZiXhy2q6p/iR+Sr/eMffzt16pT3gZAq qeIBOFdH5widg5DeS3On0ddoXN8GISFwxK0x1LZufeddd5U//AF3CoM4BRYIawUhKVWrgfAMuzJYj1U1O7sNDkL+7UMPPcjAR3kYYfHQVH4IzGPlSmlxiuAa EQgrg5A3MDmufp7BOQjZVDOhK1RulRrhof0YVnGW1CEIP/qoKksOHz7kitgAhC3d693EFgBpjENIFztcdd49e/XqScmZtxHkXM043c1i1NW5AgVCgdApCBkf yT1tvNautG0/IyLOPPwvXUUg9DEQmhCeilqueEyLIh2ue1NsgdANcWEOb6CF4ACsXiPGdUmoJ9dxeCAIOTt7CUBowpGqG8cgg4cADoFQIHQKQsZZM+2iV+A6 wx1B5+RABRda9e//Mq4PJ84TgdAzV4S8ikhRTt1UeZh6E/7gnptLIHQbhPQ+QldqrBEegqS+/97NAzM+AEIKec89rS9gnMcJZQoLC62PwaHeQciOYJWPPGaP MO78HiEgTPQTEDKCmwOwRKlVOb3LgEj/1x6hb4CQyiWo3UT8OymPf4KQkaH6qZUBA5yCkCMB5psuWbK4Plp4vYKQfExMlDHOzTfjTq/7PUIm4pjXlUhy86Uf HOoLhF27djH+t+qNhqNXnhA1WhEExUjBXcFVPuWaJw+MGq3evu2qc+dO5nh19ZRLRAzVIQi5BEAgdAJCco06DJbp1SvARB/Ux0nkyiB0mF6rAoQOg+Odg5Ab hkks5Yokv756IsMXX+zoMGp02bKlZhrKppfXgZB7jzGsCbP/7rvv6rzwlSLRhvoOCCdPnsRVMjTKu+9uXfnQLtGJZOUwJ3UaFoSE4bpyeJYnVakyrpFUkFAC c2bIc0BIE1mzZo3DeiFc3izHOcZb5SP8w/iKHYKQNGbnYeNxF/N6BQg5vu0C4bUcYnH4fZctW2aOJ3OankiH/176JBHB6CQPGVmZDAg59eXwYt4KELqd+q6u QMjM49FHHzaJlgYNGlj5IyI5WSY6PEdoTiiZg/NVXGX0uHnz3nGSRai+QYiPgfvgeD/2eeqpJ6ukwIXxpKBzkuKVE7QUD+NQifSCyh+ZK+1CQkK8D4S4uWmR JgfHE0+2JYPt8ePHuVeWZA1sFHtIZhlSR5rMMlh/yJDXmOYQaM4R49tua+EhmWWMiPBk8OVVxBCTDcfJupD2ROIMXkWY6LfffsMchV6Bx5900mxgmHTPTkBI Dg6TSAEqkJCX7uEkpZMfgpABy+zgAhhmFWQ0ru63t94CQSCDCw9n1PjWuNYZf7EDRf3FL654/PHH3E5bQ07a229vYRoMCUFolm4P4hwsNm2G0tJmcBu6N57W SWaZ6dOnmzGB8sBCThMyJqxbt5aYaueZZQAtLhneQBXTTujXJNvCEzhr1kwm5RiBaqJXeiYIz5Xfl7DJJJ9jVGcnj8ZJ4TmhyFoZs1N+5tlu54jnJBcN0qSA cKVtGkgKLTLL0CRat76LGCLSYVY/COTpIOREdkBAd5Nr1ORzouKpBhoZuWY8BIQ4Azn7Zdq3qQAKaVKH0Cc9Z0VIbzGdk7ddccXl7CS7/Som73Q2k36Cr8mA CPY4w0shqSznUaNMd8wgYlIdYoHs7JxzniGvACGTX1Jvm0RW/CKHuUZZ95uEWCZ5o8kuayZV115b7iHn3hW3X44RTAentJdd9v+YVjpZJxmfGy9kl869wbRO QMhamXo04YsVY4KJcGGscLgiPOfKDM77DQtNXZj/mvkKX5/1sdupt+sbhIzqRAyZFHGuhAxXmsKb5sqX+te//sGU2m3jkLOe2melxPuNV7/COCaFG4tmLwPh OZdP2bX+u9qMHeYOij59ei9dutQkcYf/TryFIOGnP/1f3uakkOSUYaKBF5dKNeMONcouZsXGuNsgxO/E9gktm77k9u0TFbNvEu4ZS7pA+ISTt+GCIMmkSVlk Lr4nOplvza8gKoyFQtOmtzpJEsai0PSK8yDMPucZ4twI2cZ5OM7l3htw+PPPyXuOF6jKR6ytmWHwlTHssWNHnZST7JN45mmTzpNun3Ndec+pedJtm25IOzej MGkhHb6Z0BK2OczcgtTwboMQkaAL8NAgnYAQxpjpF9Zz4vUlQJ/sviZdtRkTMBclZI1ixoRZs2Y5sVtERPgLLzxfcR+IeScVRCgpayAnG8OPP/4o4ypDxPr1 VdOYHDx4wBxLAMNOejeLdSra3KtTUXiTgJeM3mFhYQ47KSwkOpTZTOX3m52C6rs53gFCM4P47LPP8PD07t2LSH2OUlDNbK2vWrWS66acJL/fs+fLVeVaSfYd h4XkQDHvGTx4EEmoCesy51TIm2fqgKyy7r2WK804KML1ETRu59e/saNJ1nKcSPg2a8y8YEvACWc12e+oFBJxkTaafkL3IA0Q9UKOSrdTrBkdO3aMAI3Zs2d6 lGuUdMZUNOJmIne/11HewEOejiofkb4VxxHVzc1Z7h1Rr7K44bfgeuLhTkqHb2MiRV/j3kQyPrMFwDt/+OEHhzf+nH9zLthm6uPENVrhS8ApSpvhv+6N1LRq +hpVQL9zMtafc0XN8B56BwMXjgRzE1bF8Yl58+Y5tlwZPQ64jhgxDL6CFhLfu31raYV27dpF/0UnT56svizBscSX2rp1i/MsZYzhtHMsQ+G5kozVwtGjR+qQ Gnv37qWVEjXDsIxr1PkFkw0MQu8Vu8FmzxwntawhSdJzzz1rYtYArazhY/J3EDJ5r8mNcJATM1yF49rei1YrkST/EY5Zroyv8pecsOJGGlyvjAzVb26RBEIv VmxsDPtt+DrY9sfFigcJLuIz5HJI46TmNGSdeJAkSfIK4fR75pmn2a3EKQfwGBNwk3766Q52DX/zm/L7Org4wuH5Tkkg9Cyx/3fFFZcxy8MFygY7bZ2b20xE ODF1xD7UUzofSZI8Uxy+JNjEjAlcQOgaExqdHxOuIZCH+7ZkJYHQp0SAAzux+D9NRKuJ0zOhSgQpuR1SIUmS944JM2bMAIHVx4R77727ej4mSSD0ERHNzMEg Tj22a/csEcCEKnFKFJeILCNJ/ikOw82ZMycgoAcBMh06vMDWyccff+w8qlMSCCVJkiRJIJQkSZIkgVCSJEmSBEJJkiRJEgglSZIkSSCUJEmSJIFQkiRJkgRC SZIkSRIIJUmSJEkglCRJkiSBUJIkSZIEQkmSJEkSCCVJkiRJIJQkSZIkgVCSJEmSBEJJkiRJEgglSZIkSSCUJEmSJIFQkiRJkgRCSZIkSRIIJUmSJEkglCRJ kiSBUJIkSZIEQkmSJEmqVf8fqjAad5+La4AAAAAASUVORK5CYII=
  • primaryColor string | null

    The primary color to be used in the branding (hex color code).

    pattern
    ^#[0-9a-fA-F]{6}$
    example
    #000000
  • secondaryColor string | null

    The secondary color to be used in the branding (hex color code).

    pattern
    ^#[0-9a-fA-F]{6}$
    example
    #00ff00
  • title string | null

    The title (e.g. name of the company) that is to shown in the app.

    maxLength
    255
  • introduction string | null

    Additional details (e.g. address of the company, instructions, …) that are to shown in the app (e.g. the name of the company’s location).

    maxLength
    4096
  • phoneNumber string | null

    The phone number of the company.

    format
    phone
    maxLength
    35
  • emailAddress string | null

    The email address of the company.

    format
    email
    maxLength
    70
  • websiteUrl string | null

    The URL to the website of the company.

    format
    uri
    maxLength
    255
  • imprintUrl string | null required

    The URL to the imprint. The app will directly link to this.

    format
    uri
    maxLength
    255
  • privacyPolicyUrl string | null required

    The URL to the privacy policy. The app will directly link to this.

    format
    uri
    maxLength
    255
  • customerInformationUrl string | null required

    The URL to the customer information. The app will directly link to this.

    format
    uri
    maxLength
    255
CreateExpressLinkRequestBody
  • expirationDate string

    The date on which the link will expire. If not specified, the link will expire after 30 days. Format as defined by full-date in RFC3339 (‘yyyy-mm-dd’). Additionally we support the format ‘dd.mm.yyyy’.

    format
    date
  • configurationName string

    Name of the app configuration to use. This is defined by FIASCO and given to each partner.

    example
    demo_v1
  • maximumUses integer | null

    The maximum number of times the express link can be used. If not set, the link can be used once.

    default
    1
    minimum
    1
  • doCalculate boolean | null

    If set to false, the express link will only collect and process data without triggering a calculation.

    default
    true
  • recipientProviderAccountId string | null

    The provider account ID for the recipient.

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
  • email string | null

    An email address to send the express link to.

    format
    email
  • phoneNumber string | null

    An phone number to send the express link to.

    format
    phone
  • redirectUrl string | null

    URL to redirect the user to after completing the express link journey. This enables serial integration where users stay in the same browser tab. Must be a valid HTTP or HTTPS URL.

    format
    uri
    example
    https://partner-site.com/return-page
  • reference string | null

    A reference ID that is added to the express link request for future reference (e.g. case ID, order ID, etc.).

    maxLength
    50
  • calculationParameters CreateCalculationRequestBody
  • vehicleOwnerDetails ExpressLinkVehicleOwnerDetails
  • styling ExpressLinkStyling
CreateExpressLinkResponse
  • success boolean

    Either true (messages have been sent successfully) of false (an error occurred). Always available.

    example
    false
  • message string

    Describes the return status (e.g. error details). Can be null or empty.

    example
    The phone number specified does not appear to be in an acceptable format
  • expressLinkId string

    ID of the express link. Only available when ‘success’ is true.

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
  • expressLinkUrl string

    The URL of the express link (this can be sent to end users). Only available when ‘success’ is true.

    format
    uri
    example
    https://demo.fiasco.de/#elt=something-unique
ExpressLinkResultBody
  • success boolean

    Either true (data was collected and (optionally) a calculation has been created) or false (an error occurred). Always available.

    example
    true
  • message string

    Describes the return status (e.g. error details). Can be null or empty.

    example
    Calculation request successfully processed
  • expressLinkRequestId string

    ID of the used express link request.

    format
    uuid
    example
    12341234-1234-1234-1234-123412341234
  • calculationId string

    ID of the created calculation. You can use this to later get the information about the created request(photos, answers…)

    format
    uuid
    example
    12341234-1234-1234-1234-123412341234
  • calculationText string

    The calculation text as returned by the calculation engine. Only available when ‘success’ is true and if a calculation was originally requested.

  • referenceId string

    The reference ID that was passed in the original express link request.(will be similar across all requests for the same express link)

  • audaNetCaseId string

    The AudaNet case ID. Only available when ‘success’ is true and if an ‘audaNetRecipient’ was specified when the express link request was requested.

    format
    uuid
    example
    B1CAF6C5-AFAF-B40D-B0C8-9E0A2A041179
RequestResultBody
  • success boolean

    Either true (request was successfully processed) or false (an error occurred). Always available.

    example
    true
  • message string

    Describes the return status (e.g. error details). Can be null or empty.

    example
    Request successfully processed
  • requestId string

    ID of the request. Only available when success is true.

    format
    uuid
    example
    12341234-1234-1234-1234-123412341234
  • fiascoId string

    A unique human readable identifier for the request.

    example
    D2025-SK-F5E8
  • calculationId string

    ID of the finished calculation (if applicable).

    format
    uuid
    example
    12341234-1234-1234-1234-123412341234
  • calculationText string

    The calculation text as returned by the calculation engine. Only available when success is true and calculation is complete.

  • calculationDV90 string

    The calculation in the DV90 format. Only available when success is true and calculation is complete.

  • calculationVXS string

    The calculation in the VXS format. Only available when success is true, calculation is complete, and the calculation provider was DAT.

  • calculationPDF string

    Base64-encoded PDF that contains the results of the calculation. Only available when success is true, calculation is complete, and the calculation provider was DAT.

  • reference string

    The reference ID that was passed in the original request.

  • additionalReferences object

    The additional references that were passed in the original request.

    additionalProperties
    true
  • audaNetCaseId string

    The AudaNet case ID. Only available when success is true and if an audaNetRecipient was specified when the request was created.

    format
    uuid
    example
    B1CAF6C5-AFAF-B40D-B0C8-9E0A2A041179
  • totalPrice number

    The total price of the calculation without tax (if applicable).

    format
    float
  • totalPriceWithTax number

    The total price of the calculation including tax (if applicable).

    format
    float
  • totalTax number

    The total tax amount (if applicable).

    format
    float
  • damageClass string

    The damage class (“Schadenklasse”), derived from the ratio of gross repair costs to the vehicle’s average replacement value (WBW) using the insurer’s own cost-ratio thresholds. Only present for insurers who have contracted for this field. “Nicht verfügbar” when no ratio can be derived — for instance when no WBW valuation has completed yet.

    one of
    Reparatur SchadenMöglicher TotalschadenTotalschadenNicht verfügbar
  • taxRates array

    The tax rates that were applied in the calculation (if applicable).

    array items

    • rate number

      The tax rate percentage

      format
      float
    • amount number

      The tax amount for this rate

      format
      float
  • status string

    Current status of the request

    one of
    creatingreceivingreceivedpreprocessingpreprocessedcalculatingcalculatedpostprocessingpostprocessedclosingclosed
    example
    preprocessing
  • directStatus object

    Additional status information for direct request types (only present if request type was “direct”)

    • expressLinkStatus string

      Status of the express link (only present if request type is “direct”)

      one of
      pristinerequest_receivedcompleted
      example
      completed
    • directReplacementValuationAvailable boolean

      Whether Direct replacement valuation is available

      example
      true
    • visionReplacementValuationAvailable boolean

      Whether Vision replacement valuation is available

      example
      true
    • visionCalculationStatus string

      Status of the vision calculation

      one of
      pristinerequestedcompleted
      example
      completed
  • damagedParts array

    A list of parts that are damaged for classification results.

    array items

    DamagedPart

  • photos array

    A list of photos that were uploaded with the request.

    array items

    • id string

      The ID of the photo.

      format
      uuid
      example
      a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
    • filename string

      The filename of the photo.

      example
      fi-img-952a6927-5c6c-49ab-881a-3d29b4399292.jpeg
    • subject string

      The subject of the photo.

      one of
      commonotherdashboarddamageglass_sticker
      example
      damage
ValuationReadyBody

Webhook payload for the valuationReady event. Fired each time a valuation becomes available, providing a snapshot of all currently available valuation data. Fields for valuations not yet available are null.

  • event string required
    one of
    valuationReady
  • directWBWMin number | null

    Minimum WBW (replacement value) from the direct/insurer-side valuation. Null if not yet available.

    format
    float
  • directWBWAvg number | null

    Average WBW (replacement value) from the direct/insurer-side valuation. Null if not yet available.

    format
    float
  • directWBWMax number | null

    Maximum WBW (replacement value) from the direct/insurer-side valuation. Null if not yet available.

    format
    float
  • directWBWPDF string | null

    Base64-encoded PDF of the direct WBW valuation report. Null if not available.

  • visionWBWMin number | null

    Minimum WBW (replacement value) from the vision/customer-side valuation. Null if not yet available.

    format
    float
  • visionWBWAvg number | null

    Average WBW (replacement value) from the vision/customer-side valuation. Null if not yet available.

    format
    float
  • visionWBWMax number | null

    Maximum WBW (replacement value) from the vision/customer-side valuation. Null if not yet available.

    format
    float
  • visionWBWPDF string | null

    Base64-encoded PDF of the vision WBW valuation report. Null if not available.

  • directRWPMin number | null

    Minimum RWP (residual value price) from the direct valuation. Null if not yet available.

    format
    float
  • directRWPMax number | null

    Maximum RWP (residual value price) from the direct valuation. Null if not yet available.

    format
    float
  • directRWPAvg number | null

    Average RWP (residual value price) from the direct valuation, computed as (min + max) / 2. Null if not yet available.

    format
    float
  • directRWPPDF string | null

    Base64-encoded PDF of the direct RWP valuation report. Null if not available.

  • visionRWPOffer number | null

    RWP2 offer value from the vision-side valuation. Null if not yet available.

    format
    float
  • visionRWPPDF string | null

    Base64-encoded PDF of the vision RWP valuation report. Null if not available.

CalculationRecipients
  • calculationAudaNetRecipient string | null

    If specified, the finished calculation will be sent via AudaNet to this recipient. Format according to Audatex B2B interface. The value contains a type prefix followed by a colon followed by the ID of the receiver. The type prefix can be ‘MemberId’, ‘LoginId’, ‘CustomerId’, ‘CommId’, or ‘ExternalOrganisationId’.

    This is only respected if the calculation was requested with the ‘audatex’ calculation provider.

    pattern
    ^((MemberId)|(LoginId)|(CustomerId)|(CommId)|(ExternalOrganisationId)):([^\s]+)$
    example
    CommId:DE123456
  • calculationEmailRecipient string | null

    If specified, the finished calculation will be sent via email to this email address. The calculation will be sent as plain text and PDF in a human-readable format.

    format
    email
PossiblePartsErrorResponse
example
{"message":"Your token could not be authenticated","success":false}
  • success boolean

    Either true of false. Always available.

  • message string | null

    Describes the return status (e.g. error details). Can be null or empty.

SendCalculationErrorResponse
example
{"message":"Your token could not be authenticated","success":false}
  • success boolean

    Either true of false. Always available.

  • message string | null

    Describes the return status (e.g. error details). Can be null or empty.

SendCalculationSuccessResponse
  • success boolean

    Either true (request was successfully created) of false (an error occurred). Always available.

    example
    true
  • message string

    Describes the return status (e.g. error details). Can be null or empty.

    example
    Calculation successfully requested
GetCalculationErrorResponse
example
{"message":"Unauthorized","success":false}
  • success boolean

    Either true of false. Always available.

  • error string | null

    Describes the return status (e.g. error details). Can be null or empty.

GetCalculationSuccessResponse
example
{"answers":{},"calculation":{"fiasco_id":"D2024-DL-13F8","id":"1bb39da6-29fe-4141-bc65-0dec22e93551","is_test_case":null,"status":"calculating"},"damaged_parts":[{"part":"2300","type":"dent"},{"part":"1150","type":"scratch"}],"message":"calculation request retrieved","photo_subjects":["common","damage"],"photos":["7725ecdf-7285-49b7-a2eb-b3bc6e543aad"],"success":true}
  • success boolean

    Either true (request was successfully created) of false (an error occurred). Always available.

    example
    true
  • message string

    Describes the return status (e.g. error details). Can be null or empty.

    example
    Calculation successfully requested
  • calculation object

    The calculation that was sent.

    • id string

      The ID of the calculation.

      format
      uuid
      example
      12341234-1234-1234-1234-123412341234
    • fiasco_id string

      Unique identifier for the calculation

    • status string

      The current status of the calculation.

      example
      preprocessing
    • is_test_case boolean

      Whether the calculation is a test case.

      example
      false
  • answers object

    Additional data collected during an app’s user journey.

  • photos array

    A list of ids for the photos of the calculation.

    array items

  • photo_subjects array

    A list of subjects for the photo ids above.

    array items

    one of
    commondashboarddamageregistration_paper
  • damaged_parts array

    A list of damaged parts detected in the calculation.

    array items

    DamagedPart

ListPartsSuccessResponse
  • success boolean

    Either true of false. Always available.

  • parts array

    A list of parts.

    array items

    • id integer

      The part number (also called “FIASCO Part ID”).

      example
      1130
    • label string

      Name of the part in German.

      example
      Leist. Grill U
    • label_ex string | null

      Extended, non-abbreviated name of the part in German.

      example
      Leiste Grill unten
    • group string

      The primary group of the part.

      example
      roof
    • locations array

      A set of location specifiers.

      one of
      leftrighttopbottommiddlefrontback
      example
      ['left', 'top']
    • parents array

      A list of parent parts IDs.

ListPartsErrorResponse
example
{"message":"Your token could not be authenticated","success":false}
  • success boolean

    Either true of false. Always available.

  • message string | null

    Describes the return status (e.g. error details). Can be null or empty.

GetCalculationPhotoErrorResponse
example
{"message":"Unauthorized","success":false}
  • success boolean

    Either true of false. Always available.

  • error string | null

    Describes the return status (e.g. error details). Can be null or empty.

CreateRequestBody

Request body for creating a new request

  • reference string required

    A reference ID that is added to the request for future reference (e.g. case ID, order ID, etc.)

    maxLength
    50
    example
    case-12345
  • created_by_worker_email string

    Worker’s email address

    format
    email
    example
    worker@example.com
  • additional_references object

    An object containing arbitrary key-value pairs for additional reference information

    additionalProperties
    true
    example
    {"customer_id":"CUST-12345","order_number":"ORD-2024-001"}
  • type string required

    The type of request being created

    one of
    direct
    example
    direct
  • send_result_webhook_auth_token string | null

    If set, this token will be used from our servers to authenticate against a receiving webhook server. If not set, a value configured for your account will be used.

  • send_result_webhook_url string | null

    The webhook URL to send the results to. If not set, the default URL configured for your account will be used.

  • foreign_company_access_key string | null

    Optional access key that allows Company B to create requests on behalf of Company A. When provided, the request will be created under Company A’s account (the owner of the access key), and billing will be attributed to Company A. The access key must be valid, active, not expired, and have the :create permission. If the access key is invalid, inactive, expired, or lacks the required permission, the request will be rejected with an appropriate error.

  • vehicle object

    Vehicle information for the request

    • manufacturer string

      Vehicle manufacturer

      example
      BMW
    • model string

      Vehicle model

      example
      3 Series
    • mileage integer

      Vehicle mileage in kilometers

      example
      50000
    • first_registration_date string

      First registration date in UTC

      format
      date-time
      example
      2020-01-15T00:00:00Z
    • license_plate string

      Vehicle license plate number

      example
      AB-CD 1234
    • vin string

      Vehicle identification number

      example
      WBAVB13506PT12345
    • hsn_tsn string

      HSN/TSN code for German vehicle registration

      example
      0005ABC
  • damaged_parts array

    A list of parts that are damaged for classification results.

    array items

    DamagedPart

  • data required

    Request-specific data, varies based on type

  • photos array

    Photos must meet the following requirements:

    • Must depict normal passenger cars (EU 2018/858): Classes M1/M1G (excluding platform types SA, SB, SC, SD, SG, SH) or N1 (excluding BA, BC, BD, BE, SB, SG, SM, SF, BCSL, BX)
    • Cars must be younger than 20 years
    • Must be pre-classified using the subject field to discern damage photos from general photos
    • Subject must be clean (not wet, dirty, glossy, or snowed over) with clearly visible car and damages
    • Reflections must be kept to a minimum
    • Car must not be constricted (recommend at least 3m free distance around car)
    • Multiple photos (ideally four) for each damage from different angles (slightly tilted left/right/up/down)
    • Minimum resolution of 1500px × 1500px
    • Must be correctly oriented or include EXIF data for orientation
    • Damaged part must be completely visible on at least one photo
    • Must be taken using daylight or in a well-lit area (avoid focusing light directly on damage to prevent reflections/overexposure)
    • Must not be manually edited (no markings like lines, arrows, circles)
    • Must not contain hands/fingers highlighting something
    • Must not contain deflectometry patterns (horizontal/vertical stripes)
    • Must not contain hail damage
    • Avoid re-encoding files (e.g. JPEG to JPEG or JPEG to PNG)
    • Quality settings of encoders must be 90% or higher

    array items

    • data string required

      The photo data in base64 encoded format.

      format
      byte
    • content_type string

      The MIME type of the image (e.g. ‘image/jpeg’, ‘image/jxl’, ‘image/png’, ‘image/heic’, ‘image/webp’, ‘image/tiff’).

    • file_name string | null

      Filename of the photo.

    • subject string | null required

      The subject of the photo (common picture of the car, photo of a damage, other/unspecified, …). The value glass_sticker means a special sticker placed behind glass to highlight defects in the glass itself, e.g. a chip in the windshield.

      Only photos not marked “common” will be considered for damage detection.

      default
      common
      one of
      commondamagedashboardregistration_paper
CreateRequestResponse

Response when successfully creating a new request

  • fiasco_id string

    A unique human readable identifier for the created request

    example
    D2025-SK-F5E8
  • request_id string

    A UUID for the created request

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
  • link string

    A deep link generated for the request

    format
    uri
    example
    https://cloud.fiasco.de/direct/request/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
  • already_existed boolean
CreateRequestErrorResponse

Error response when creating a request fails

  • message string

    Error message describing what went wrong

UpdateRequestBody

Request body for updating an existing request. All fields are optional for partial updates.

  • data object

    Direct-specific data to update. Currently supports updating customer contact information.

    • customer object

      Updated customer (Express Link recipient) contact information. Only provided fields will be updated.

      • email_address string

        Customer’s email address

        format
        email
        example
        customer@example.com
      • phone_number string

        Customer’s phone number. Used to receive SMS notifications.

        example
        +49 171 12345678
  • send_result_webhook_auth_token string | null

    If set, this token will be used from our servers to authenticate against a receiving webhook server. If not set, a value configured for your account will be used.

  • send_result_webhook_url string | null

    The webhook URL to send the results to. If not set, the default URL configured for your account will be used.

  • start_vision_request boolean | null

    A flag for manual direct cases which initiates the vision request.

  • damaged_parts array

    A list of parts that are damaged for classification results. Can be used to update damage information.

    array items

    DamagedPart

  • photos array

    Additional photos to upload. Photos must meet the following requirements:

    • Must depict normal passenger cars (EU 2018/858): Classes M1/M1G (excluding platform types SA, SB, SC, SD, SG, SH) or N1 (excluding BA, BC, BD, BE, SB, SG, SM, SF, BCSL, BX)
    • Cars must be younger than 20 years
    • Must be pre-classified using the subject field to discern damage photos from general photos
    • Subject must be clean (not wet, dirty, glossy, or snowed over) with clearly visible car and damages
    • Reflections must be kept to a minimum
    • Car must not be constricted (recommend at least 3m free distance around car)
    • Multiple photos (ideally four) for each damage from different angles (slightly tilted left/right/up/down)
    • Minimum resolution of 1500px × 1500px
    • Must be correctly oriented or include EXIF data for orientation
    • Damaged part must be completely visible on at least one photo
    • Must be taken using daylight or in a well-lit area (avoid focusing light directly on damage to prevent reflections/overexposure)
    • Must not be manually edited (no markings like lines, arrows, circles)
    • Must not contain hands/fingers highlighting something
    • Must not contain deflectometry patterns (horizontal/vertical stripes)
    • Must not contain hail damage
    • Avoid re-encoding files (e.g. JPEG to JPEG or JPEG to PNG)
    • Quality settings of encoders must be 90% or higher

    Maximum 10 photos can be uploaded in a single update request. Cannot be provided when vision_mode is express_link - photos should be uploaded by the customer via the express link.

    maxItems
    10

    array items

    • data string required

      The photo data in base64 encoded format.

      format
      byte
    • content_type string required

      The MIME type of the image (e.g. ‘image/jpeg’, ‘image/jxl’, ‘image/png’, ‘image/heic’, ‘image/webp’, ‘image/tiff’).

    • file_name string | null

      Filename of the photo.

    • subject string | null

      The subject of the photo (common picture of the car, photo of a damage, other/unspecified, …). The value glass_sticker means a special sticker placed behind glass to highlight defects in the glass itself, e.g. a chip in the windshield.

      Only photos not marked “common” or “other” will be considered for damage detection.

      default
      common
      one of
      commonotherdashboarddamageglass_sticker
UpdateRequestResponse

Response when successfully updating a request

  • success boolean

    Whether the update was successful

    example
    true
  • message string

    Success message

    example
    Request successfully updated
  • request_id string

    The UUID of the updated request

    format
    uuid
    example
    a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11
UpdateRequestErrorResponse

Error response when updating a request fails

  • success boolean

    Whether the update was successful

    example
    false
  • message string

    Error message describing what went wrong

    example
    Request not found or invalid data provided
RequestStatusResponse

Response containing the status of a request

  • status string

    Current status of the request

    one of
    creatingreceivingreceivedpreprocessingpreprocessedcalculatingcalculatedpostprocessingpostprocessedclosingclosed
    example
    creating
  • direct_status object

    Additional status information for direct request types (only present if request type was “direct”)

    • express_link_status string

      Progress of the express link the customer received. Only present when the request was created with vision_mode set to express_link and the link has already been generated.

      • pristine — the link was generated but the customer has not opened it yet.
      • opened — the customer opened the link but has not submitted it yet.
      • request_received — the customer submitted the link. Final state; takes precedence over expired.
      • expired — the link’s lifetime elapsed before the customer submitted it.
      one of
      pristineopenedrequest_receivedexpired
      example
      opened
    • direct_replacement_valuation_available boolean

      Whether Direct replacement valuation is available

      example
      true
    • vision_replacement_valuation_available boolean

      Whether Vision replacement valuation is available

      example
      true
    • vision_calculation_status string

      Status of the vision calculation

      one of
      pristinerequestedcompleted
      example
      completed
RequestStatusErrorResponse

Error response when retrieving request status fails

  • message string

    Error message describing what went wrong

    example
    request_not_found
ScanNotificationBody

The field names are taken from the PDR scan API — its query parameters and response fields — so that a provider needs no field mapping. Additional fields are ignored rather than rejected.

  • combiOrderNumber string required

    The CombiConnect assignment number the scan belongs to. The field that identifies what we fetch.

    minLength
    1
    example
    1747388473352
  • combiPartnerId string required

    The CombiConnect partner number the assignment was issued under. Together with the assignment number it is what resolves the notification to an assignment, so it must match the partner number we have stored for it; a mismatch drops the notification and nothing is fetched.

    minLength
    1
    example
    11143
  • scanId string | integer

    The provider’s scan identifier. Recorded so a notification can be correlated with a scan.

    example
    45503
  • scannedAt string

    When the scan was taken. Recorded for correlation.

    example
    2025-06-11T09:52:00.000Z
ScanNotificationSuccessResponse
  • status string
    const
    ok
ScanNotificationErrorResponse
  • status string
    const
    error
AuthenticationErrorResponse

Error response when a bearer token is rejected.

  • success boolean
    const
    false
  • error string
    one of
    UnauthorizedForbidden
CreateRequestDirect

Data schema for direct type requests

  • vision_mode string required

    The mode to use for Vision

    one of
    express_linkmanual
    example
    manual
  • vision_app_mode string

    The Vision app mode to use. Defaults to “regular” when not provided.

    default
    regular
    one of
    regularsimplified
    example
    regular
  • send_express_link boolean

    A flag that decides whether to automatically send an express link or not

    default
    false
    example
    false
  • start_vision_request boolean

    A flag that triggers the vision calculation for manual direct requests automatically. Only works for manual direct requests (when vision_mode is “manual”).

    default
    false
    example
    true
  • enable_insurer_wbw boolean

    A flag that decides whether to automatically run the insurer WBW valuation.

    default
    true
    example
    true
  • enable_customer_wbw boolean

    A flag that decides whether to automatically run the customer WBW valuation.

    default
    true
    example
    true
  • insurer_vehicle_location_zip_code string

    Location of the car of the insurer (zip code)

    example
    10115
  • insurer_vehicle_location_country string

    Location of the car of the insurer (country code, ISO 3166-1 alpha-2)

    default
    DE
    example
    DE
  • insurer_estimated_mileage boolean

    Whether the mileage of the insurer is estimated

    default
    false
    example
    false
  • insurer_calculation_parameters_preset string

    The insurer calculation parameters preset to use

    one of
    comprehensivecomprehensive_with_bindingthird_party_liability
    example
    comprehensive
  • insurer_labor_rates object

    Labor rates for different types of work for the insurer

    • body number required

      Labor rate for body work

      format
      float
      example
      45.5
    • electrical number required

      Labor rate for electrical work

      format
      float
      example
      55.0
    • hail_damage number required

      Labor rate for hail damage repair

      format
      float
      example
      40.0
    • mechanical number required

      Labor rate for mechanical work

      format
      float
      example
      50.0
    • paint number required

      Labor rate for paint work

      format
      float
      example
      48.75
  • customer_vehicle_location_zip_code string

    Location of the car of the customer (zip code)

    example
    10115
  • customer_vehicle_location_country string

    Location of the car of the customer (country code, ISO 3166-1 alpha-2)

    default
    DE
    example
    DE
  • customer_estimated_mileage boolean

    Whether the mileage of the customer is estimated

    default
    false
    example
    false
  • customer_calculation_parameters_preset string

    The customer calculation parameters preset to use

    one of
    comprehensivecomprehensive_with_bindingthird_party_liability
    example
    comprehensive_with_binding
  • customer_labor_rates object

    Labor rates for different types of work for the customer

    • body number required

      Labor rate for body work

      format
      float
      example
      45.5
    • electrical number required

      Labor rate for electrical work

      format
      float
      example
      55.0
    • hail_damage number required

      Labor rate for hail damage repair

      format
      float
      example
      40.0
    • mechanical number required

      Labor rate for mechanical work

      format
      float
      example
      50.0
    • paint number required

      Labor rate for paint work

      format
      float
      example
      48.75
  • customer_type string

    Type of customer

    one of
    insurance_customerexternal_customer
    example
    insurance_customer
  • customer object

    Customer (Express Link recipient) information for the request

    • email_address string

      Customer’s email address

      format
      email
      example
      customer@example.com
    • phone_number string

      Customer’s phone number. Used to receive SMS notifications.

      example
      +49 171 12345678
    • mobile_phone_number string

      Customer’s mobile phone number. Used to receive SMS notifications.

      example
      +49 171 12345678
DamagedPart
  • type string required

    The type of damage detected on the part.

    one of
    missingbrokenscratchdentdent_with_scratchtearchiphail
    example
    dent
  • part string required

    The FIASCO part ID of the damaged part.

    example
    2300