General Information

Version 1.7.2

Schemes

https

Host & base path

{customer_site}/api/v1/

Terms of Service

In using this API you agree to be bound by our Terms of Service

OpenAPI specification

OpenAPI specification for partly of this APIs can be accessible here: http://apidocs.lexly.com/v1/swagger.yaml

The Lexly API uses HTTPS methods and RESTful endpoints to create, edit, and manage meetings with lawyers at a customer site. JSON is the data interchange format, but we also use query parameters.

The API is accessed through a versioned URL. This allows users to clearly identify which API they are using, and to make it easier to upgrade to any newer versions. It also avoids having to use version codes in HTTP headers.

Any breaking changes to the API will be introduced through a new version number. We aim to keep these changes to a minimum, and when we do so, will support the current API until it is phased out.

Changelog

We will list any changes to the current version of the API here.

To get started using our API it is recommended to first read the Introduction, this will give you an overview of some key concepts in use by the Lexly system.

Lexlys API is a system for identifying clients, booking meetings with lawyers and receiving customer information and conveying purchased contracts.

Partner Access Credentials

Auth Workflow using cURL

Here we provide some examples using the cURL command.

1. Authorization for via cURL:

$ curl 'https://${host}/api/v1/${api}' \
      -H 'Auth: user=${username},password=${password},partner=${partner_id}

Instead of OAuth, partners can access certain APIs with authentication based on relayed login information.

You as a partner can get the authorization information. Once you have it, you can access the APIs by sending the authorization information in the header regardless of whether you are using POST or GET. It should be written in the following format:

Auth: user=${username},password=${password},partner=${partner_id}

The following APIs can be accessed in this way:

GET /api/v1/meeting/{date}/{dealid}

GET /api/v1/partnerform

GET /api/v1/pricelist

POST /api/v1/partnerform

Error responses will contain a JSON response body, structured as follows:

{
      "error_type": "${error_type}", 
      "error_message": "${error_type}", 
      "http_code": ${http_code}
    }
    

For example:

{
      "error_type": "invalid_client", 
      "error_message": "The client id supplied is invalid", 
      "http_code": 400
    }
    

Lexly uses HTTP status codes to indicate the success or failure of an API request.

HTTP response codes in the 2xx range indicate that the API call completed successfully. The 4xx range indicates an error, either due to missing, incomplete, or not applicable information (e.g. missing or invalid parameters, invalid authorisation, etc.).

When a request is well formed, but does not satisfy necessary conditions, then we will return a 409 code. For example, when trying to book a meeting that's already booked.

Codes in the 5xx range suggest an error with Lexlys booking system, they could also indicate planned system downtime, and will be rare.

The following table of error responses applies to all API calls, there may be additional errors which are specific to the respective API calls, but will follow the same structure.

Get

GET /api/v1/image

GET /api/v2/image

GET /api/v1/meeting/{date}/{dealid}

GET /api/v1/partnerform

GET /api/v1/pricelist

Post

POST /api/v1/partnerform

Get image v1

Example of a returned image:

Code: <img src="https://api.lexly.se/api/v1/image/housing-situation/tomorrow?situation=bought-before&gender=man&gender-partner=woman">

Code: <img src="https://api.lexly.se/api/v1/image/inheritance-analysis/i-die?situation=married&gender=man&gender-partner=woman&children=1,6&orphan-children=5">

Code: <img src="https://api.lexly.se/api/v1/image/life-insurance/with/partner-die?gender=man&gender-partner=woman&children=1,6&orphan-children=5">

GET https://api.lexly.se/api/v1/image/housing-situation/{today|tomorrow}?<situation={married|partner|bought-before}>&<gender={man|woman}>&<gender-partner={man|woman}>

GET https://api.lexly.se/api/v1/image/inheritance-analysis/{today|i-die|partner-die}?<situation={single|married|partner}>&<gender={man|woman}>&<gender-partner={man|woman}>&<children={age,age,...}>&<orphan-children={age,age,...}>&<bonus-children={age,age,...}>

GET https://api.lexly.se/api/v1/image/life-insurance/{with|without}/{i-die|partner-die}?<gender={man|woman}>&<gender-partner={man|woman}>&<children={age,age,...}>&<orphan-children={age,age,...}>&<bonus-children={age,age,...}>

With this API, SVG images can be generated based on specified parameters in different situations in life. The tool has support for creating images for life situations housing situation, inheritance analysis and life insurance.

Header

Parameters

When generating an image for housing situation. Potential URL /api/v1/image/housing-situation/today and /api/v1/image/housing-situation/tomorrow. All parameters below should be send in the QUERY_STRING.
Please note: If it's a partner relation and the house was bought before the partners moved together, set the situation to "bought-before".

Dimention: 4:3

When generating an image for life insurance. Potential URL /api/v1/image/inheritance-analysis/today, /api/v1/image/inheritance-analysis/i-die and /api/v1/image/inheritance-analysis/partner-die. All parameters below should be send in the QUERY_STRING.

Dimention: 1:1

When generating an image for inheritance analysis. Potential URL /api/v1/image/life-insurance/without/i-die, /api/v1/image/inheritance-analysis/without/partner-die, /api/v1/image/life-insurance/with/i-die and /api/v1/image/inheritance-analysis/with/partner-die. All parameters below should be send in the QUERY_STRING.

Dimention: 3:2

Responses

An image is always returned from this API. If the parameters are not set correctly, the answer will be just an empty house image.

Get image v2

Example of a returned image:

Code: <img src="https://api.lexly.se/api/v2/image/housing-situation/tomorrow?situation=bought-before&gender=man&gender-partner=woman">

Code: <img src="https://api.lexly.se/api/v2/image/housing-situation/alone?gender=woman">

GET https://api.lexly.se/api/v2/image/housing-situation/{alone|today|tomorrow}?<situation={married|partner|bought-before}>&<gender={man|woman|neutral}>&<gender-partner={man|woman|neutral}>

GET https://api.lexly.se/api/v2/image/inheritance-analysis/{today|i-die|partner-die}?<situation={single|married|partner}>&<gender={man|woman|neutral}>&<gender-partner={man|woman|neutral}>&<children={age,age,...}>&<orphan-children={age,age,...}>&<bonus-children={age,age,...}>

GET https://api.lexly.se/api/v2/image/life-insurance/{with|without}/{i-die|partner-die}?<gender={man|woman|neutral}>&<gender-partner={man|woman|neutral}>&<children={age,age,...}>&<orphan-children={age,age,...}>&<bonus-children={age,age,...}>

GET https://api.lexly.se/api/v2/image/coins/{two|four|down}

GET https://api.lexly.se/api/v2/image/carries-house/{woman|man|neutral}

With this API, SVG images can be generated based on specified parameters in different situations in life. The tool has support for creating images for life situations housing situation, inheritance analysis and life insurance.

Header

Parameters

When generating an image for housing situation. Potential URL /api/v2/image/housing-situation/today and /api/v2/image/housing-situation/tomorrow. All parameters below should be send in the QUERY_STRING.
Please note: If it's a partner relation and the house was bought before the partners moved together, set the situation to "bought-before".
For generating an image with just one person and a house use /api/v2/image/housing-situation/alone?gender={man|woman|neutral}

Dimention: 82:37

Code: <img src="https://api.lexly.se/api/v2/image/inheritance-analysis/i-die?situation=married&gender=man&gender-partner=woman&children=1,6&orphan-children=5">

When generating an image for inheritance analysis. Potential URL /api/v2/image/inheritance-analysis/today, /api/v2/image/inheritance-analysis/i-die and /api/v2/image/inheritance-analysis/partner-die. All parameters below should be send in the QUERY_STRING.

Dimention: 55:43

Code: <img src="https://api.lexly.se/api/v2/image/life-insurance/with/partner-die?gender=man&gender-partner=woman&children=1,6&orphan-children=5">

When generating an image for life insurance. Potential URL /api/v2/image/life-insurance/without/i-die, /api/v2/image/inheritance-analysis/without/partner-die, /api/v2/image/life-insurance/with/i-die and /api/v2/image/inheritance-analysis/with/partner-die. All parameters below should be send in the QUERY_STRING.

Dimention: 3:2

Code: <img src="https://api.lexly.se/api/v2/image/coins/two">
<img src="https://api.lexly.se/api/v2/image/coins/four">
<img src="https://api.lexly.se/api/v2/image/coins/down">

For generating images of coins there are three different potential images: /api/v2/image/coins/two, /api/v2/image/coins/four and /api/v2/image//coins/down.

Code: <img src="https://api.lexly.se/api/v2/image/carries-house?gender=woman">

For generating images of a human wearing a house the input should be in the following format: /api/v2/image/carries-house?gender={woman|man|neutral}

Dimention: 2:3

Responses

An image is always returned from this API. If the parameters are not set correctly, the answer will be just an empty house image.

Get free meeting slots

Example of returned data (day):

{
  "date": "2019-03-20",
  "open_time": "8-20",
  "slot_length": 30,
  "partner": "testab",
  "deal_id": "100",
  "slots": [
    {
      "starttime": "0800",
      "length": "30",
      "lawyer": "116767"
    },
    {
      "starttime": "0830",
      "length": "30",
      "lawyer": "97940"
    }
  ]
}

Example of returned data (month):

{
  "category": "business",
  "freeslots": [
    "2021-12-01",
    "2021-12-06",
    "2021-12-17",
    "2021-12-30"
  ]
}

GET /api/v1/meeting/{date or month}/{dealid}?<partner={partner_shortname}>&&&<product={product_id}>&<category={private|business}>&<type={1 or 2}> (Partner Access Credentials)

GET /api/v1/meeting/{date or month}/{dealid}?<partner={partner_shortname}>&&&<product={product_id}>&<category={private|business}>&<type={1 or 2}> (Partner Access Credentials)

GET /api/v1/meeting/{date or month}?<product={product_id}>&<category={private|business}>&<type={1 or 2}> (Oauth or CID)

GET /api/v1/meeting/{date or month}?<product={product_id}>&&<category={private|business}>&<type={1 or 2}> (Oauth or CID)

This API can be used for receiving two different kind of data. If just a month (YYYY-MM) is sent sent in the URL all dates in the month with free slots will be returned. If a specific date is sent all free meeting slots for a given date will be returned. This function can be requested either by CID, Partner Access Credentials or Oauth. Required parameters depends on if it's accessed with CID, Partner Access Credentials or Oauth. The output is in JSON format.

In the swedish version you can send product category instead of product_id. The available categories are "business" and "private".

Header

Parameters

Responses

Get partner form structure

Example of returned data:

{
  "customer_segments": [
    {
       "name": "Privatkund",
       "deal_id": 32,
    },
    ...
  ],
  "legal_areas": [
    {
       "name": "Familjejuridik",
       "value": "family-law",
       "form_type": "flexible_form",
       "category": "private",
    },
    ...
  ],
  "form_types": [
    "flexible_form": {
      "contact_form": {
        "meeting_type": "Mail",
        "form_type": [
          "contact_form"
        ]
      },
      ...
    },
    "contact_form": {
      "preferred_meeting_type": [
        {
          "name": "Telefon",
          "value": "phone",
        },
        ...
      ],
      "return_fields": {
        "deal_id": required,
        "legal_area": "required",
        "preferred_meeting_type": "required",
        "customer": {
          "ssn": "required",
          "name": "required",
          "email": "required",
          "phone": "required"
        },
        "advisor": {
          "email": "required",
          "group": "required",
          "subgroup": "optional"
        }
      }
    },
    ...
  ],
}

GET /api/v1/partnerform/

Get the structure for a partner form for the partner that's specified in the authorization header. It will return info about the customer_segments, the current legal_areas and the fields that should be returned for the different legal areas for the current partner. The form type "flexible_form" lists which different form setups that should be returned for the different potential selections.

Header

Parameters

Responses

Get pricelist

Example of returned data:

{
  "business_agreements": [
    {
      "id": "9761",
      "product_name": "Aktieägaravtal",
      "product_description": "Kompanjonsavtal mellan ägarna i ett aktiebolag",
      "vat": 25,
      "slug": "aktieagaravtal",
      "translation_price": 2800,
      "online": {
        "product_number": 2071,
        "price": 2995,
        "temp_price": 2750
      },
      "lawyer": {
        "product_number": 2571,
        "price": 9999,
        "temp_price": 9500
      }
    },
    ...
  ]
}

GET /api/v1/pricelist

GET /api/v1/pricelist/{deal_id}

Get the pricelist for the current deal_id. If deal_id isn't included in the request the general pricelist will be returned. The data is returned in JSON format.

Header

Parameters

Responses

Response data

The data will be returned organized in four different categories - "business_agreements", "offers", "private_agreements", "addons".

Send partner form info

Example of posted data (with Partner Access Credentials authorisation):

{
  "deal_id": 100,
  "legal_area": family-law,
  "customer": {
    "name": "Lars Nilsson",
    "email": "lars@nilsson.eu",
    "phone": "0732220825",
    "ssn": "196503080291" }
  "calendar": {
    "type": "phone",
    "date": "2022-07-15",
    "time": "1400",
    "lawyer": "85494" }
  "advisor": {
    "name": "Nils Bankir",
    "email": "a12342@banken.se",
    "phone": "0771121212",
    "group": "Stockholm",
    "subgroup": "Norrmalmstorg" }
}

Example of returned data if all went well:

{
  "status": "true"
}

POST /api/v1/partnerform

An API for sending a partner leads. This can only be done with a Partner Access Credentials. The different setup of returned values depends of selected form type - see Get partner form structure.

Header

Parameters

Responses