> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Juridiq as a data source
> Bring data from Juridiq to your Lakehouse.
Juridiq is a Brazilian legal practice management platform for law firms. It covers cases (processos), court publications and notices, deadlines and tasks, hearings, clients and parties, electronic signatures and time tracking. The connector extracts data from the Juridiq REST API (api.juridiq.com.br) so you can analyse your firm's operation in your Lakehouse.
## Configuring Juridiq as a Source
In the [Sources](https://app.nekt.ai/sources) tab, click on the "Add source" button located on the top right of your screen. Then, select the Juridiq option from the list of connectors.
Click **Next** and you'll be prompted to add your access.
### 1. Add account access
You'll need a Juridiq API key so Nekt can access your data. Sign in to the Juridiq panel, open **Settings > API** and generate a new key. The key belongs to the law office, so a single key covers all the data of your firm.
The Juridiq API is a paid add-on of the product. If the API section is not available in your panel, contact Juridiq to enable the API plan for your office before setting up this source.
The following configurations are available:
* **API key**: your Juridiq API key. It is sent in the `x-juridiq-api-key` header on every request. This field is required.
* **Initial sync date**: (Optional) the earliest date to read for the streams that accept a date filter — **Publications** and **Events**. All other streams always return your office's full history, regardless of this setting.
* **Fetch full details**: (Optional, enabled by default) reads the complete record of every case and person with one extra request each. Turn it off on very large offices to make the extraction faster — the trade-off is that the columns only the detail endpoint returns stay empty: case value, phase, parties, custom field values, document, address and timestamps.
Once you're done, click **Next**.
### 2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
> Tip: The stream can be found more easily by typing its name.
The **Law suit movements** stream reads the docket entries of one case per request, so it is by far the slowest stream on offices with many cases. Select it only when you need the case timeline.
Select the streams and click **Next**.
### 3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
* **Layer**: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
* **Folder**: a folder can be created inside the selected layer to group all tables being created from this new data source.
* **Table name**: we suggest a name, but feel free to customize it. You have the option to add a **prefix** to all tables at once and make this process faster!
* **Sync Type**: the Juridiq API does not expose a "last updated" filter on its list endpoints, so every stream of this connector is extracted as **FULL\_TABLE** — each run brings the current state of the data.
Once you are done configuring, click **Next**.
### 4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters.
To define your [Trigger](https://docs.nekt.com/get-started/core-concepts/triggers), consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times).
Optionally, you can define some additional settings:
* Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource [here](https://docs.nekt.com/get-started/core-concepts/resource-control).
* Determine when to execute an **Additional [Full Sync](https://docs.nekt.com/get-started/core-concepts/types-of-sync#additional-full-sync)**.
Once you are ready, click **Next** to finalize the setup.
### 5. Check your new source
You can view your new source on the [Sources](https://app.nekt.ai/sources) page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.
## Good to know
* **Permissions follow the API key.** If a module is not enabled for your office — electronic signatures, for example — the corresponding stream is skipped with a warning in the run log instead of failing the whole extraction.
* **Nested data is stored as JSON text.** Fields that hold an object or a list of objects (parties of a case, participants of a hearing, signatories of a document, custom field values) are stored as JSON strings, so you can parse them in a Query without your table schema changing between runs.
* **Date fields keep the API's own format.** Fields the Juridiq API documents as timestamps are typed as DateTime. Fields the API returns as plain text dates are kept exactly as received, so nothing is misread.
* **The gov.br password of a person is never extracted.** The Juridiq API returns it on the person record; the connector drops it so it never reaches your Lakehouse.
## Streams and Fields
Below you'll find all available data streams from Juridiq and their corresponding fields:
Cases handled by the office. Each listed case is completed with one extra request to the case detail endpoint, which adds the case value, phase, parties and custom field values.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :----------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id` | String | Unique identifier of the law suit in Juridiq. |
| `process_number` | String | Case number in the Brazilian CNJ format (e.g. 0012345-67.2026.8.26.0100). |
| `value_of_cause` | String | Monetary value assigned to the case, as returned by the API. |
| `status` | String | Current status of the case in the office's workflow. |
| `current_instance` | Integer | Court instance (grau) the case is currently in. |
| `court` | String | Court where the case is filed (e.g. TJSP). |
| `service_step` | String | Phase of the case within the office's service flow. |
| `is_private` | Boolean | Whether the case is restricted to specific users of the office. |
| `is_secret` | Boolean | Whether the case runs under judicial secrecy (segredo de justiça). |
| `office_id` | String | Identifier of the law office that owns the case. |
| `custom_fields` | String | Values of the office's custom case fields (JSON array of objects with field\_id, name, type, options, value and is\_archived). |
| `persons` | String | Parties of the case (JSON array of objects with id, name and person\_origin, where person\_origin is 'Cliente' for the represented party and 'Requerida' for the opposing one). |
Docket entries (movimentações) of every case. Read one case at a time, so this stream is the slowest one on offices with many cases.
**Primary key:** `law_suit_id`, `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :------------------ | :------ | :------------------------------------------------------------------------------------------ |
| `id` | String | Identifier of the docket entry. |
| `law_suit_id` | String | Identifier of the law suit the docket entry belongs to. |
| `conteudo` | String | Full text of the docket entry. |
| `data` | String | Date of the docket entry, kept exactly as returned by the API. |
| `instance` | Integer | Court instance (grau) the docket entry originated from. |
| `law_suit_instance` | String | Case instance the entry is attached to (JSON object with id, process\_number and instance). |
| `tags` | Array | Identifiers of the tags applied to the docket entry. |
| `tags_details` | String | Tags applied to the docket entry (JSON array of objects with id, name and color). |
Definitions of the custom case fields your office created, useful to interpret the `custom_fields` column of Law suits.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :------------ | :------- | :------------------------------------------------------------------------------------------- |
| `id` | String | Unique identifier of the custom field definition. |
| `name` | String | Label of the custom field as shown in Juridiq. |
| `type` | String | Data type of the field: text, longText, date, time, dateTime, number, select or multiSelect. |
| `options` | Array | Allowed values, for select and multiSelect fields. |
| `is_archived` | Boolean | Whether the field was archived and is no longer offered on new cases. |
| `created_at` | DateTime | Timestamp when the field was created. |
| `updated_at` | DateTime | Timestamp when the field was last updated. |
Clients, opposing parties and other contacts. Each listed person is completed with one extra request to the person detail endpoint, which adds the document, address and timestamps.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :----------------------- | :------- | :-------------------------------------------------------------------- |
| `id` | String | Unique identifier of the person in Juridiq. |
| `name` | String | Full name of the person or company. |
| `email` | String | Primary email address. |
| `phone` | String | Primary phone number. |
| `document` | String | Brazilian tax document, CPF or CNPJ. |
| `rg` | String | Brazilian identity card number (RG). |
| `person_origin` | String | Role of the person in the office (e.g. cliente, parte). |
| `person_type` | String | Whether the record is an individual or a company (física / jurídica). |
| `marital_status` | String | Marital status of the person. |
| `nationality` | String | Nationality of the person. |
| `profession` | String | Occupation of the person. |
| `birth_date` | String | Date of birth, kept exactly as returned by the API. |
| `zip_code` | String | Postal code (CEP) of the address. |
| `state` | String | State of the address. |
| `city` | String | City of the address. |
| `neighborhood` | String | Neighborhood of the address. |
| `street_and_number` | String | Street and number of the address. |
| `address_complement` | String | Additional address information. |
| `image_url` | String | URL of the person's picture. |
| `client_discover_office` | String | How the client found the office, used for acquisition analysis. |
| `annotation` | String | Free-form notes about the person. |
| `is_private` | Boolean | Whether the record is restricted to specific users of the office. |
| `owner_id` | String | Identifier of the office user responsible for the person. |
| `legal_representant` | String | Legal representative of the person. |
| `corretor` | String | Broker associated with the person. |
| `code` | String | Internal code the office assigned to the person. |
| `office_id` | String | Identifier of the law office that owns the record. |
| `created_at` | DateTime | Timestamp when the person was created. |
| `updated_at` | DateTime | Timestamp when the person was last updated. |
Tasks and deadlines (prazos) tracked by the office.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :------------- | :------ | :------------------------------------------------------------------ |
| `id` | String | Unique identifier of the task. |
| `title` | String | Title of the task. |
| `priority` | String | Priority assigned to the task. |
| `status` | String | Current status of the task. |
| `has_sheet` | Boolean | Whether the task has time entries (apontamentos) logged against it. |
| `initial_date` | String | Start date of the task, kept exactly as returned by the API. |
| `final_date` | String | Due date of the task, kept exactly as returned by the API. |
| `is_archived` | Boolean | Whether the task was archived. |
| `is_private` | Boolean | Whether the task is restricted to specific users of the office. |
| `owner_id` | String | Identifier of the user who created the task. |
| `points` | Number | Effort points assigned to the task. |
Columns of the task kanban, with the board and folder they belong to.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :---------------- | :------- | :----------------------------------------------------------- |
| `id` | String | Unique identifier of the kanban column. |
| `name` | String | Name of the kanban column. |
| `index` | Integer | Position of the column inside its board. |
| `office_id` | String | Identifier of the law office that owns the board. |
| `board_id` | String | Identifier of the kanban board. |
| `board_name` | String | Name of the kanban board. |
| `folder_id` | String | Identifier of the folder holding the board. |
| `folder_name` | String | Name of the folder holding the board. |
| `hex_color` | String | Color of the column, in hexadecimal notation. |
| `is_done_column` | Boolean | Whether tasks moved to this column are considered completed. |
| `is_first_column` | Boolean | Whether this is the entry column of the board. |
| `created_at` | DateTime | Timestamp when the column was created. |
| `updated_at` | DateTime | Timestamp when the column was last updated. |
Court publications and notices captured for the office, including the AI-generated summary.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :------------------ | :------- | :------------------------------------------------------------------------------------------- |
| `id` | String | Unique identifier of the publication. |
| `title` | String | Title of the publication. |
| `content` | String | Full text of the publication. |
| `description_small` | String | Short summary of the publication, generated by Juridiq's AI. |
| `official_diary` | String | Official gazette (diário oficial) the publication came from. |
| `availability_date` | String | Date the publication was made available in the gazette, kept exactly as returned by the API. |
| `publication_date` | String | Date the publication took legal effect, kept exactly as returned by the API. |
| `location` | String | Location the publication refers to. |
| `process_number` | String | Case number (CNJ format) the publication refers to. |
| `law_suit_id` | String | Identifier of the law suit the publication was matched to, when matched. |
| `is_handled` | Boolean | Whether the office already processed the publication. |
| `read_at` | DateTime | Timestamp when the publication was read. |
| `read_by` | String | User who read the publication (JSON object with id, name and image\_url). |
| `has_similarity` | Boolean | Whether Juridiq found other publications similar to this one. |
Court hearings scheduled by the office.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :--------------- | :------- | :--------------------------------------------------------------------------------- |
| `id` | String | Unique identifier of the hearing. |
| `title` | String | Title of the hearing. |
| `date` | String | Date the hearing takes place, kept exactly as returned by the API. |
| `initial_hour` | String | Time the hearing starts. |
| `final_hour` | String | Time the hearing ends. |
| `modality` | String | Whether the hearing is online or in person. |
| `type` | String | Type of the hearing, as classified by Juridiq. |
| `audience_link` | String | Link to the hearing, for online hearings. |
| `description` | String | Free-form description of the hearing. |
| `process_number` | String | Case number (CNJ format) the hearing belongs to. |
| `law_suit_id` | String | Identifier of the related law suit. |
| `person_id` | String | Identifier of the related person. |
| `completed_at` | DateTime | Timestamp when the hearing was marked as completed. |
| `is_private` | Boolean | Whether the hearing is restricted to specific users of the office. |
| `has_sheet` | Boolean | Whether the hearing has time entries (apontamentos) logged against it. |
| `location` | String | Place where the hearing takes place. |
| `participants` | String | People taking part in the hearing (JSON array of objects with id, name and email). |
| `owner_id` | String | Identifier of the office user responsible for the hearing. |
| `created_at` | DateTime | Timestamp when the hearing was created. |
| `updated_at` | DateTime | Timestamp when the hearing was last updated. |
Calendar events. Tasks and hearings are excluded here because they have their own streams.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :----------------- | :------ | :------------------------------------------------------------------------- |
| `id` | String | Unique identifier of the event. |
| `title` | String | Title of the event. |
| `start` | String | Start of the event, kept exactly as returned by the API. |
| `end` | String | End of the event, kept exactly as returned by the API. |
| `all_day` | Boolean | Whether the event spans the whole day. |
| `date` | String | Date the event happens, kept exactly as returned by the API. |
| `initial_hour` | String | Time the event starts. |
| `final_hour` | String | Time the event ends. |
| `type` | String | Type of the calendar item. |
| `status` | String | Current status of the event. |
| `priority` | String | Priority of the event. |
| `is_private` | Boolean | Whether the event is restricted to specific users of the office. |
| `tags` | String | Tags applied to the event (JSON array of objects with id, name and color). |
| `link` | String | External link of the event, for Google entries. |
| `text_color` | String | Text color used to render the event. |
| `background_color` | String | Background color used to render the event. |
| `border_color` | String | Border color used to render the event. |
| `class_names` | String | CSS classes used to render the event. |
Time logged by the office's users against tasks, subtasks and hearings.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :----------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------- |
| `id` | String | Unique identifier of the time entry. |
| `title` | String | Title of the time entry. |
| `module` | String | What the time was logged against: TASK, AUDIENCE, SUBTASK or GENERAL. |
| `is_done` | Boolean | Whether the time entry was completed. |
| `status` | String | Current status: PENDING, IN\_PROGRESS, PAUSED, COMPLETED or CANCELLED. |
| `office_id` | String | Identifier of the law office. |
| `user_id` | String | Identifier of the user who logged the time. |
| `task_id` | String | Identifier of the related task. |
| `audience_id` | String | Identifier of the related hearing. |
| `subtask_id` | String | Identifier of the related subtask. |
| `estimated_time_minutes` | Integer | Time estimated for the work, in minutes. |
| `time_spent_seconds` | Integer | Total time actually spent, in seconds, summed across the status history. |
| `cancel_reason` | String | Reason given when the entry was cancelled. |
| `completed_at` | DateTime | Timestamp when the entry was completed or cancelled. |
| `vinculate_item` | String | Task, subtask or hearing the time was logged against (JSON object with id, name and process\_number). |
| `user_detail` | String | User who logged the time (JSON object with name and url\_image). |
| `status_histories` | String | Status transitions of the entry (JSON array of objects with id, description, status, started\_at, ended\_at and time\_spent). |
| `this_user_can_edit` | Boolean | Whether the API key's user owns the entry and may edit it. |
| `created_at` | DateTime | Timestamp when the entry was created. |
| `updated_at` | DateTime | Timestamp when the entry was last updated. |
Documents sent for electronic signature through PlugSign.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :--------------------- | :------- | :---------------------------------------------------------------------------------- |
| `id` | String | Unique identifier of the signature request. |
| `document_name` | String | File name of the document sent to sign. |
| `sign_name` | String | Display name of the signature request. |
| `document_key` | String | Key identifying the document in PlugSign. |
| `signing_key` | String | Key identifying the signing session in PlugSign. |
| `status` | String | Current status of the request (e.g. pending, signed, cancelled). |
| `signatories` | String | People asked to sign the document (JSON, as returned by the API). |
| `responsible_id` | String | Identifier of the office user responsible for the request. |
| `responsible` | String | Office user responsible for the request (JSON object with id, name and image\_url). |
| `person_on_signatures` | String | People from the office's CRM linked to the request (JSON, as returned by the API). |
| `is_private` | Boolean | Whether the document is restricted to specific users of the office. |
| `created_at` | DateTime | Timestamp when the request was created. |
| `updated_at` | DateTime | Timestamp when the request was last updated. |
Batches grouping several documents sent for signature at once.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :------------------ | :------- | :-------------------------------------------------------------------------------------------------------------------- |
| `id` | String | Unique identifier of the signature batch. |
| `name` | String | Name given to the batch. |
| `plugsign_lote_id` | String | Identifier of the batch in PlugSign. |
| `status` | String | Current status of the batch. |
| `signatories` | String | People asked to sign the batch (JSON, as returned by the API). |
| `office_id` | String | Identifier of the law office that owns the batch. |
| `responsible_id` | String | Identifier of the office user responsible for the batch. |
| `responsible` | String | Office user responsible for the batch (JSON object with id, name and image\_url). |
| `person_on_batches` | String | People from the office's CRM linked to the batch (JSON, as returned by the API). |
| `signatures` | String | Documents that make up the batch (JSON array of objects with id, status, document\_name, sign\_name and created\_at). |
| `is_private` | Boolean | Whether the batch is restricted to specific users of the office. |
| `expire_date` | DateTime | Timestamp when the batch expires. |
| `created_at` | DateTime | Timestamp when the batch was created. |
| `updated_at` | DateTime | Timestamp when the batch was last updated. |
Members of the law office, with their role and permission profile.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :------------------------ | :------- | :-------------------------------------------------------------------- |
| `id` | String | Unique identifier of the user. |
| `name` | String | Full name of the user. |
| `email` | String | Email address used to sign in. |
| `document` | String | Brazilian tax document, CPF or CNPJ. |
| `contact` | String | Phone or other contact information. |
| `role` | String | Role of the user inside the office. |
| `profile` | String | Permission profile of the user (JSON object with id and name). |
| `oab_number` | String | Brazilian bar association number (OAB). |
| `ctps_number` | String | Brazilian work card number (CTPS). |
| `person_type` | String | Whether the user is registered as an individual or a company. |
| `salary` | String | Salary registered for the user. |
| `admission_date` | String | Date the user joined the office, kept exactly as returned by the API. |
| `resignation_date` | String | Date the user left the office, kept exactly as returned by the API. |
| `date_of_birth` | String | Date of birth, kept exactly as returned by the API. |
| `postal_code` | String | Postal code (CEP) of the user's address. |
| `address_number` | String | Street number of the user's address. |
| `image_url` | String | URL of the user's picture. |
| `office_id` | String | Identifier of the law office. |
| `first_login` | Boolean | Whether the user has not signed in for the first time yet. |
| `has_password` | Boolean | Whether the user has a password set. |
| `has_google_linked` | Boolean | Whether the user linked a Google account to Juridiq. |
| `google_email` | String | Email of the linked Google account. |
| `google_integration_type` | String | How the Google calendar is synchronized for this user. |
| `created_at` | DateTime | Timestamp when the user was created. |
| `updated_at` | DateTime | Timestamp when the user was last updated. |
Tags used to classify cases, tasks and other records.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :----------- | :------- | :----------------------------------------------- |
| `id` | String | Unique identifier of the tag. |
| `name` | String | Label of the tag. |
| `color` | String | Color used to render the tag. |
| `modules` | Array | Modules of Juridiq where the tag can be applied. |
| `office_id` | String | Identifier of the law office that owns the tag. |
| `created_at` | DateTime | Timestamp when the tag was created. |
| `updated_at` | DateTime | Timestamp when the tag was last updated. |
Action types (tipos de ação) used to classify cases.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :------------------ | :------- | :-------------------------------------------------- |
| `id` | String | Unique identifier of the action type. |
| `name` | String | Name of the action type. |
| `action_group_id` | String | Identifier of the action group the type belongs to. |
| `action_group_name` | String | Name of the action group. |
| `office_id` | String | Identifier of the law office. |
| `created_at` | DateTime | Timestamp when the action type was created. |
| `updated_at` | DateTime | Timestamp when the action type was last updated. |
Action groups that organize the action types.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :----------- | :------- | :------------------------------------------------ |
| `id` | String | Unique identifier of the action group. |
| `name` | String | Name of the action group. |
| `office_id` | String | Identifier of the law office. |
| `created_at` | DateTime | Timestamp when the action group was created. |
| `updated_at` | DateTime | Timestamp when the action group was last updated. |
Risk levels the office assigns to its cases.
**Primary key:** `id` · **Sync type:** FULL\_TABLE
| Field | Type | Description |
| :---------- | :----- | :----------------------------------- |
| `id` | String | Unique identifier of the risk level. |
| `name` | String | Name of the risk level. |
| `office_id` | String | Identifier of the law office. |