# {py:mod}`arelle.LeiUtil`

```{py:module} arelle.LeiUtil
```

```{autodoc2-docstring} arelle.LeiUtil
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`LEIValidationResult <arelle.LeiUtil.LEIValidationResult>`
  -
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`checkLei <arelle.LeiUtil.checkLei>`
  - ```{autodoc2-docstring} arelle.LeiUtil.checkLei
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`LEI_VALID <arelle.LeiUtil.LEI_VALID>`
  - ```{autodoc2-docstring} arelle.LeiUtil.LEI_VALID
    :summary:
    ```
* - {py:obj}`LEI_INVALID_LEXICAL <arelle.LeiUtil.LEI_INVALID_LEXICAL>`
  - ```{autodoc2-docstring} arelle.LeiUtil.LEI_INVALID_LEXICAL
    :summary:
    ```
* - {py:obj}`LEI_INVALID_CHECKSUM <arelle.LeiUtil.LEI_INVALID_CHECKSUM>`
  - ```{autodoc2-docstring} arelle.LeiUtil.LEI_INVALID_CHECKSUM
    :summary:
    ```
````

### API

`````{py:class} LEIValidationResult
:canonical: arelle.LeiUtil.LEIValidationResult

Bases: {py:obj}`enum.Enum`

````{py:attribute} VALID
:canonical: arelle.LeiUtil.LEIValidationResult.VALID
:value: >
   'auto(...)'

```{autodoc2-docstring} arelle.LeiUtil.LEIValidationResult.VALID
```

````

````{py:attribute} INVALID_LEXICAL
:canonical: arelle.LeiUtil.LEIValidationResult.INVALID_LEXICAL
:value: >
   'auto(...)'

```{autodoc2-docstring} arelle.LeiUtil.LEIValidationResult.INVALID_LEXICAL
```

````

````{py:attribute} INVALID_CHECKSUM
:canonical: arelle.LeiUtil.LEIValidationResult.INVALID_CHECKSUM
:value: >
   'auto(...)'

```{autodoc2-docstring} arelle.LeiUtil.LEIValidationResult.INVALID_CHECKSUM
```

````

````{py:method} description() -> str
:canonical: arelle.LeiUtil.LEIValidationResult.description

```{autodoc2-docstring} arelle.LeiUtil.LEIValidationResult.description
```

````

````{py:method} name()
:canonical: arelle.LeiUtil.LEIValidationResult.name

````

````{py:method} value()
:canonical: arelle.LeiUtil.LEIValidationResult.value

````

`````

````{py:data} LEI_VALID
:canonical: arelle.LeiUtil.LEI_VALID
:value: >
   None

```{autodoc2-docstring} arelle.LeiUtil.LEI_VALID
```

````

````{py:data} LEI_INVALID_LEXICAL
:canonical: arelle.LeiUtil.LEI_INVALID_LEXICAL
:value: >
   None

```{autodoc2-docstring} arelle.LeiUtil.LEI_INVALID_LEXICAL
```

````

````{py:data} LEI_INVALID_CHECKSUM
:canonical: arelle.LeiUtil.LEI_INVALID_CHECKSUM
:value: >
   None

```{autodoc2-docstring} arelle.LeiUtil.LEI_INVALID_CHECKSUM
```

````

````{py:function} checkLei(lei: str) -> arelle.LeiUtil.LEIValidationResult
:canonical: arelle.LeiUtil.checkLei

```{autodoc2-docstring} arelle.LeiUtil.checkLei
```
````