List legal-entities

GET

lucca-api

legal-entities

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/lucca-api/legal-entities \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

{
  "type": "legal-entities",
  "url": "https://example.ilucca.net/lucca-api/legal-entities?page=2qs1dqsd45&limit=1",
  "totalCount": 11,
  "items": [
    {
      "id": "123",
      "type": "legal-entity",
      "url": "https://example.ilucca.net/lucca-api/legal-entities/123",
      "legalName": "Lucca S.A.S.",
      "remoteId": "LE:83.2938",
      "isArchived": false,
      "countryCode": "FRA",
      "currencyCode": "EUR",
      "taxIdentificationNumber": {
        "format": "frenchSIREN",
        "value": "44163769100128"
      },
      "industryCode": {
        "format": "frenchAPE",
        "value": "7022Z"
      },
      "createdAt": "2024-01-01T08:34:23.0001Z",
      "lastUpdatedAt": "2024-01-01T08:34:23.0001Z",
      "lastArchivedAt": "null",
      "links": {
        "businessEstablishments": {
          "href": "https://example.ilucca.net/lucca-api/business-establishments?legalEntity.id=123"
        }
      }
    }
  ],
  "embedded": null,
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/{resource-type}?page=!sdk87Sdh&limit=25"
    }
  }
}

Authorizations

Authorization

string

header

required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

Api-Version

enum<string>

required

Set the API version.

Available options:

2024-11-01

Example:

"2024-11-01"

If-None-Match

string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

If-Match

string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

Accept-Encoding

string

List of compression algorithms you support.

Query Parameters

include

enum<string>[]

Include metadata:

embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Response

200

application/json

A collection of legal-entity resources.

type

string

required

Allowed value: "legal-entities"

url

string

required

items

object[]

required

Paginated list of legal-entity objects.

Representation of a legal entity, i.e. an organization that is subject to legal responsibilities in a given jurisdiction (country).

A legal-entity may be comprised of several business-establishments which represent geographically localized structures where the actual work is done. One of which is marked as the legal-entity headquarters.

items.id

string

required

Minimum length: 1

items.type

string

required

Allowed value: "legal-entity"

items.url

string

required

items.legalName

string

required

Must be unique. Legal name of the legal-entity.

Required string length: 1 - 255

items.countryCode

enum<string>

required

Three letters ISO 3166-1 alpha-3 country code.

Available options:

FRA,

ESP,

DEU,

CHE,

ITA,

GBR,

USA,

BEL,

CAN,

AFG,

ALA,

ALB,

DZA,

ASM,

AND,

AGO,

AIA,

ATA,

ATG,

ARG,

ARM,

ABW,

AUS,

AUT,

AZE,

BHS,

BHR,

BGD,

BRB,

BLR,

BLZ,

BEN,

BMU,

BTN,

BOL,

BIH,

BWA,

BVT,

BRA,

VGB,

IOT,

BRN,

BGR,

BFA,

BDI,

KHM,

CMR,

CPV,

CYM,

CAF,

TCD,

CHL,

CHN,

HKG,

MAC,

CXR,

CCK,

COL,

COM,

COG,

COD,

COK,

CRI,

CIV,

HRV,

CUB,

CYP,

CZE,

DNK,

DJI,

DMA,

DOM,

ECU,

EGY,

SLV,

GNQ,

ERI,

EST,

ETH,

FLK,

FRO,

FJI,

FIN,

GUF,

PYF,

ATF,

GAB,

GMB,

GEO,

GHA,

GIB,

GRC,

GRL,

GRD,

GLP,

GUM,

GTM,

GGY,

GIN,

GNB,

GUY,

HTI,

HMD,

VAT,

HND,

HUN,

ISL,

IND,

IDN,

IRN,

IRQ,

IRL,

IMN,

ISR,

JAM,

JPN,

JEY,

JOR,

KAZ,

KEN,

KIR,

PRK,

KOR,

KWT,

KGZ,

LAO,

LVA,

LBN,

LSO,

LBR,

LBY,

LIE,

LTU,

LUX,

MKD,

MDG,

MWI,

MYS,

MDV,

MLI,

MLT,

MHL,

MTQ,

MRT,

MUS,

MYT,

MEX,

FSM,

MDA,

MCO,

MNG,

MNE,

MSR,

MAR,

MOZ,

MMR,

NAM,

NRU,

NPL,

NLD,

NCL,

NZL,

NIC,

NER,

NGA,

NIU,

NFK,

MNP,

NOR,

OMN,

PAK,

PLW,

PSE,

PAN,

PNG,

PRY,

PER,

PHL,

PCN,

POL,

PRT,

PRI,

QAT,

REU,

ROU,

RUS,

RWA,

BLM,

SHN,

KNA,

LCA,

MAF,

SXM,

SPM,

VCT,

WSM,

SMR,

STP,

SAU,

SEN,

SRB,

SYC,

SLE,

SGP,

SVK,

SVN,

SLB,

SOM,

ZAF,

SGS,

SSD,

LKA,

SDN,

SUR,

SJM,

SWZ,

SWE,

SYR,

TWN,

TJK,

TZA,

THA,

TLS,

TGO,

TKL,

TON,

TTO,

TUN,

TUR,

TKM,

TCA,

TUV,

UGA,

UKR,

ARE,

UMI,

URY,

UZB,

VUT,

VEN,

VNM,

VIR,

WLF,

ESH,

YEM,

ZMB,

ZWE

Example:

"FRA"

items.currencyCode

enum<string>

required

ISO-4217 currency code

Available options:

EUR,

CHF,

GBP,

USD,

CAD,

JPY,

BBD,

XAF,

AUD,

PLN,

STN,

NOK,

XBA,

XBB,

ADP,

GWP,

ITL,

IEP,

ILR,

LUC,

LUL,

ROL,

RUR,

VEF,

ZWN,

DKK,

PEN,

XCD,

XSU,

TND,

VUV,

PEI,

PLZ,

ESA,

BOB,

KPW,

MGA,

OMR,

RWF,

SLL,

SGD,

XPF,

RON,

ZAL,

ESP,

VEB,

VNC,

BTN,

CNY,

SVC,

HKD,

LSL,

MUR,

ZAR,

NZD,

XAU,

HRK,

LAJ,

BGN,

GEL,

KES,

MNT,

SHP,

UAH,

YUD,

DJF,

GTQ,

ANG,

BUK,

FRF,

MXP,

NLG,

UGW,

YUN,

BHD,

CLF,

ERN,

GYD,

PAB,

XOF,

XTS,

ARP,

LTT,

MZM,

PTE,

CSD,

ZMK,

BZD,

FKP,

MXV,

SBD,

CHW,

TWD,

TTD,

TRY,

UYU,

BEC,

BEL,

GRD,

IDR,

ZRZ,

BYN,

ISK,

LRD,

ARA,

DDM,

GHC,

SDP,

UAK,

BSD,

LAK,

MDL,

MZN,

SSP,

UYI,

BYR,

CSJ,

GWE,

LUF,

HTG,

KRW,

QAR,

NIC,

SIT,

SDG,

CHC,

AOA,

PHP,

WST,

BAD,

BRN,

BRR,

CYP,

GNS,

LTL,

MTP,

UYN,

DZD,

AWG,

KYD,

SYP,

TZS,

FIM,

MVQ,

SUR,

USS,

ZRN,

KHR,

CRC,

INR,

NIO,

LKR,

SRD,

UYW,

XAG,

DEM,

XFU,

CVE,

CLP,

CDF,

CUC,

CHE,

XBD,

ALK,

BGK,

EEK,

GEK,

LVR,

TRL,

AZN,

CZK,

UGX,

USN,

XPT,

BRB,

BGL,

LSM,

PEH,

UYP,

XRE,

BMD,

BOV,

BWP,

BIF,

DOP,

KZT,

RSD,

ZMW,

BEF,

BRC,

CSK,

GQE,

GHP,

ISJ,

LVL,

TPE,

UGS,

XFO,

MVR,

PGK,

AED,

UZS,

AYM,

BOP,

BGJ,

SKK,

AFN,

KMF,

GMD,

IRR,

ILS,

KGS,

NPR,

SAR,

VES,

XXX,

HRD,

ROK,

ALL,

GNF,

JOD,

MWK,

SEK,

XPD,

BRE,

ECV,

STD,

TMM,

CUP,

MAD,

NGN,

AFA,

ECS,

PES,

COU,

KWD,

LBP,

ATS,

BYB,

ZWD,

AMD,

GIP,

MKD,

MYR,

MXN,

RUB,

THB,

TOP,

TMT,

ARY,

XEU,

ARS,

ETB,

XDR,

IQD,

XUA,

NAD,

PKR,

TJS,

YER,

ZWL,

AOK,

RHD,

YUM,

BND,

GHS,

SOS,

ZWR,

BAM,

COP,

HUF,

JMD,

LYD,

XBC,

MLF,

SDD,

ZWC,

EGP,

SZL,

MOP,

MMK,

VND,

AON,

MTL,

MRO,

MZE,

SRG,

YDD,

BDT,

BRL,

FJD,

HNL,

MRU,

PYG,

SCR,

AOR,

AZM,

GNE,

ILP,

MGF,

ESB,

TJR

items.remoteId

string | null

The third-party API ID of the matching object.

Required string length: 1 - 50

items.isArchived

boolean

If this legal-entity is archived. Only possible if there are no more business-establishment attached.

items.taxIdentificationNumber

object | null

Identifier of the legal-entity in its local jurisdiction.

items.industryCode

object | null

The industry (classification) code identifies the main type of activity of this legal-entity.

France: APE or NAF code.
Spain: CNAE.
Germany: WZ (Die Klassifikation der Wirtschaftszweige).
U.S.A.: NAICS (North American Industry Classification System).

items.createdAt

string

Read-only. UTC timestamp of the moment this object was created.

Example:

"2023-01-23T12:45:23.1234Z"

items.lastUpdatedAt

string

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

Example:

"2023-01-23T12:45:23.1234Z"

items.lastArchivedAt

string | null

Read-only. UTC timestamp of the moment this object was last archived through its isArchived property.

Example:

"2023-01-23T12:45:23.1234Z"

items.links

object

totalCount

integer | null

Total number of legal-entity resources across all pages that satisfy query parameters.

Required range: x >= 0

embedded

null

links

object | null

Links to related resources

Was this page helpful?

The legal-entity resource

Retrieve a legal-entity

curl --request GET \
  --url https://{account}-{sandboxName}.sandbox.{server}.luccasoftware.com/lucca-api/legal-entities \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

{
  "type": "legal-entities",
  "url": "https://example.ilucca.net/lucca-api/legal-entities?page=2qs1dqsd45&limit=1",
  "totalCount": 11,
  "items": [
    {
      "id": "123",
      "type": "legal-entity",
      "url": "https://example.ilucca.net/lucca-api/legal-entities/123",
      "legalName": "Lucca S.A.S.",
      "remoteId": "LE:83.2938",
      "isArchived": false,
      "countryCode": "FRA",
      "currencyCode": "EUR",
      "taxIdentificationNumber": {
        "format": "frenchSIREN",
        "value": "44163769100128"
      },
      "industryCode": {
        "format": "frenchAPE",
        "value": "7022Z"
      },
      "createdAt": "2024-01-01T08:34:23.0001Z",
      "lastUpdatedAt": "2024-01-01T08:34:23.0001Z",
      "lastArchivedAt": "null",
      "links": {
        "businessEstablishments": {
          "href": "https://example.ilucca.net/lucca-api/business-establishments?legalEntity.id=123"
        }
      }
    }
  ],
  "embedded": null,
  "links": {
    "prev": null,
    "next": {
      "href": "https://example.ilucca.net/lucca-api/{resource-type}?page=!sdk87Sdh&limit=25"
    }
  }
}

Overview

Organization

Employee Records

List legal-entities

Authorizations

Headers

Query Parameters

Response