> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usecroma.com/llms.txt
> Use this file to discover all available pages before exploring further.
# GLEIF (LEI)
> Todos os Legal Entity Identifiers do mundo, cerca de 3,4 milhões: os nomes da entidade, seus endereços, jurisdição, forma jurídica, número no registro empresarial, situação e eventos, as controladoras que informa (consolidação direta e final, gestor de fundos, fundo guarda-chuva, matriz) e por que não informa nenhuma quando não o faz.
Um Legal Entity Identifier é o código de 20 caracteres que identifica uma
entidade jurídica em transações financeiras e relatórios regulatórios no mundo
todo. Bancos, fundos, emissores, suas subsidiárias e cada vez mais empresas
comuns têm um. Cada registro LEI diz quem é a entidade (nomes, endereços,
jurisdição e forma jurídica), onde está registrada e com qual número, e quais
entidades a controlam: as controladoras direta e final que a consolidam em suas
contas, o gestor ou o fundo guarda-chuva de um fundo, a matriz de uma filial.
Quando uma entidade não informa controladora, o registro diz por quê
(controlada por pessoas, não consolidada, nenhuma pessoa conhecida).
Todos os registros LEI, relações e exceções de reporte, atualizados três vezes
ao dia. O número de registro é o que une um LEI a um registro empresarial: um
file number de Delaware, um document number da Sunbiz, um NIT.
| `registration_authority` | Registro | `registered_as` |
| ------------------------ | --------------------------------------------------------- | ---------------------------------------- |
| `RA000602` | Delaware Division of Corporations | O file number, p. ex. `2758229` |
| `RA000603` | Florida Division of Corporations (Sunbiz) | O document number, p. ex. `L09000050533` |
| `RA999999` | Nenhum registro informado | |
| `RA888888` | Outro registro, nomeado em `other_registration_authority` | |
Dados LEI da GLEIF, a Global Legal Entity Identifier Foundation, sob CC0 1.0.
A Croma não é afiliada à GLEIF, e a GLEIF não endossa nem fornece este
serviço.
A fonte inteira, organizada e pronta para consultar: cada endpoint desta página responde em milissegundos. Cada resposta traz `as_of`: o quão atuais são os dados. [Como funcionam os datasets](/pt/datasets).
## Buscar entidades
`POST /global/gleif/entities-search/v1` Dataset
Busca em todos os registros LEI por qualquer combinação de nome, lugar, número
de registro, categoria e situação.
| Campo | Tipo | Notas |
| ------------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `query` | string | Opcional. Palavras do nome legal ou de qualquer outro nome do registro. Todas devem coincidir; sem stemming. |
| `country` | string | Opcional. O país de duas letras do endereço legal, p. ex. `US`, `CO`, `KY`. |
| `jurisdiction` | string | Opcional. A jurisdição legal: um país (`GB`) ou uma subdivisão (`US-DE`, `US-FL`). |
| `registration_authority` | string | Opcional. O registro empresarial, pelo código da GLEIF (a tabela acima). |
| `registered_as` | string | Opcional. O número da entidade no seu registro, p. ex. um file number de Delaware. Use com `registration_authority` para achar o LEI de uma empresa que você conhece pelo registro. |
| `category` | enum | Opcional. `GENERAL`, `FUND`, `BRANCH`, `SOLE_PROPRIETOR`, `RESIDENT_GOVERNMENT_ENTITY` ou `INTERNATIONAL_ORGANIZATION`. |
| `entity_status` | enum | Opcional. `ACTIVE` ou `INACTIVE`. |
| `registration_status` | enum | Opcional. A situação do LEI: `ISSUED` (em dia), `LAPSED` (não renovado), `RETIRED`, `DUPLICATE`, `ANNULLED`, `MERGED`, `PENDING_TRANSFER` ou `PENDING_ARCHIVAL`. |
| `page` | integer | Opcional. Página, começa em 1. Por padrão `1`. |
| `per_page` | integer | Opcional. Resultados por página, 1-50. Por padrão `20`. |
```bash theme={"dark"}
curl https://api.croma.run/global/gleif/entities-search/v1 \
-H "Authorization: Bearer $CROMA_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "query": "bancolombia" }'
```
Retorna `as_of`, os filtros aplicados, `total`, `page`, `per_page`, `total_pages`, `count` e `entities[]`, por nome legal.
Cada entidade traz `lei`, `legal_name`, `legal_name_language`, `other_names[]` e `transliterated_names[]` (`{ name, language, type }`), `all_names[]`, `legal_address` e `headquarters_address` (`{ first_line, number, number_within_building, mail_routing, additional_lines[], city, region, country, postal_code, language }`), `other_addresses[]` e `transliterated_addresses[]` (o mesmo, com um `type`), `country`, `jurisdiction`, `registration_authority`, `other_registration_authority`, `registered_as`, `category`, `sub_category`, `legal_form_code` (ISO 20275), `other_legal_form`, `associated_entity`, `entity_status`, `creation_date`, `expiration_date`, `expiration_reason`, `successor_entities[]`, `events[]` (eventos da entidade: mudanças de nome, fusões, dissoluções, com os campos que cada um afetou), `initial_registration_date`, `last_update_date`, `registration_status`, `next_renewal_date`, `managing_lou`, `validation_sources`, `validation_authority`, `other_validation_authorities[]` e `conformity_flag`.
Os campos vazios são `null`. As datas estão em UTC, ISO 8601.
## Uma entidade e suas controladoras
`POST /global/gleif/entity/v1` Dataset
Resolve um LEI e retorna o registro, suas controladoras e suas controladas.
| Campo | Tipo | Notas |
| ----- | ------ | ---------------------------------------- |
| `lei` | string | **Obrigatório.** O LEI de 20 caracteres. |
```bash theme={"dark"}
curl https://api.croma.run/global/gleif/entity/v1 \
-H "Authorization: Bearer $CROMA_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "lei": "HWUPKR0MPOU8FGXBT394" }'
```
Retorna `found`, `lei`, `as_of`, `entity` (null quando não encontrado), `direct_parent` e `ultimate_parent` (cada uma uma relação com `parent_name`, ou null), `other_parents[]` (gestor de fundos, fundo guarda-chuva, fundo master, matriz), `reporting_exceptions[]` (`{ category, reasons[], exception_references[] }`: por que não se informa controladora), `children[]` (até 100 relações que nomeiam esta entidade como controladora, com `child_name`, as vigentes primeiro) e `children_total`.
Cada entidade traz `lei`, `legal_name`, `legal_name_language`, `other_names[]` e `transliterated_names[]` (`{ name, language, type }`), `all_names[]`, `legal_address` e `headquarters_address` (`{ first_line, number, number_within_building, mail_routing, additional_lines[], city, region, country, postal_code, language }`), `other_addresses[]` e `transliterated_addresses[]` (o mesmo, com um `type`), `country`, `jurisdiction`, `registration_authority`, `other_registration_authority`, `registered_as`, `category`, `sub_category`, `legal_form_code` (ISO 20275), `other_legal_form`, `associated_entity`, `entity_status`, `creation_date`, `expiration_date`, `expiration_reason`, `successor_entities[]`, `events[]` (eventos da entidade: mudanças de nome, fusões, dissoluções, com os campos que cada um afetou), `initial_registration_date`, `last_update_date`, `registration_status`, `next_renewal_date`, `managing_lou`, `validation_sources`, `validation_authority`, `other_validation_authorities[]` e `conformity_flag`.
Os campos vazios são `null`. As datas estão em UTC, ISO 8601.
Cada relação traz `id`, `child_lei`, `parent_lei`, `relationship_type`, `relationship_status`, `periods[]` (`{ start_date, end_date, type }`), `qualifiers[]` (o padrão contábil), `quantifiers[]` (o percentual de consolidação), `initial_registration_date`, `last_update_date`, `registration_status`, `next_renewal_date`, `managing_lou`, `validation_sources`, `validation_documents`, `validation_reference`, `current` e `withdrawn_at` (quando a GLEIF a retirou, se o fez).
## Buscar relações
`POST /global/gleif/relationships-search/v1` Dataset
Lista as relações de uma controlada, de uma controladora ou de um tipo.
| Campo | Tipo | Notas |
| ------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `child_lei` | string | Opcional. O LEI da entidade que informa a relação. |
| `parent_lei` | string | Opcional. O LEI da controladora, para listar tudo o que a informa. |
| `relationship_type` | enum | Opcional. `IS_DIRECTLY_CONSOLIDATED_BY`, `IS_ULTIMATELY_CONSOLIDATED_BY`, `IS_INTERNATIONAL_BRANCH_OF`, `IS_FUND-MANAGED_BY`, `IS_SUBFUND_OF` ou `IS_FEEDER_TO`. |
| `include_inactive` | boolean | Opcional. `true` para incluir as relações que a GLEIF retirou. Por padrão `false`. |
| `page` | integer | Opcional. Página, começa em 1. Por padrão `1`. |
| `per_page` | integer | Opcional. Resultados por página, 1-50. Por padrão `20`. |
```bash theme={"dark"}
curl https://api.croma.run/global/gleif/relationships-search/v1 \
-H "Authorization: Bearer $CROMA_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "parent_lei": "HWUPKR0MPOU8FGXBT394" }'
```
Retorna `as_of`, os filtros aplicados, `total`, `page`, `per_page`, `total_pages`, `count` e `relationships[]`.
Cada relação traz `id`, `child_lei`, `parent_lei`, `relationship_type`, `relationship_status`, `periods[]` (`{ start_date, end_date, type }`), `qualifiers[]` (o padrão contábil), `quantifiers[]` (o percentual de consolidação), `initial_registration_date`, `last_update_date`, `registration_status`, `next_renewal_date`, `managing_lou`, `validation_sources`, `validation_documents`, `validation_reference`, `current` e `withdrawn_at` (quando a GLEIF a retirou, se o fez).
Esquemas, todos os campos de resposta e um playground interativo.