# Login

Fetches Finxact `login` records — the current credential/identity **posture** for each login on the tenant. Each record includes the `loginId`, the associated `userId` and `partyId`, the `domainId`, the configured knowledge-based authentication questions (`kbaStatics`), enrolled `biometrics`, and secret metadata (`secrets` — type, expiry, one-use flags; secret values are the tenant's stored hashes). Use this input to inventory login/credential posture.

Login has **no incremental cursor**: every run re-fetches the full set of logins so that posture changes on existing logins (rotated secrets, added KBA questions, new biometrics) are always captured.

**Sync Type: Full snapshot**

## Prerequisites

- A provisioned Finxact tenant with access to the Finxact Console.
  - Production: `https://console.finxact.io`
  - Sandbox: `https://console-sandbox-server.dev-<pool>.finxact.io` (e.g. `dev-10`).
- An API client registered under the tenant with a role that grants **read** access to the `login` resource.
- The tenant subdomain (e.g. `acmebank`) and, for non-production tenants, the environment pool suffix (e.g. `dev-10`).
- The Monad worker's egress IP address must be added to the Finxact tenant's IP allowlist (or reachable via the required VPN). Finxact enforces network-level access control on the core-banking API — see [Networking](#networking) below.

### Obtain credentials in the Finxact Console

1. Sign in to the Finxact Console at `https://console.finxact.io` (production) or `https://console-sandbox-server.dev-<pool>.finxact.io` (sandbox).
2. Navigate to **Settings → API Clients**.
3. **Create** a new API client (or select an existing one dedicated to Monad).
4. Assign the client a role that grants **read** permission on the `login` resource.
5. Copy the generated **Client ID** and **Secret** — the secret is shown once at creation time.
6. Note the tenant subdomain (e.g. `acmebank`) and, for non-production, the environment pool (e.g. `dev-10`). Together they form the base URL: `https://<tenant>.<pool>.finxact.io` (sandbox) or `https://<tenant>.finxact.io` (production).

## Configuration

### Settings

| Setting | Type | Required | Description |
| ------- | ---- | -------- | ----------- |
| Tenant | string | Yes | Finxact tenant subdomain (e.g. `acmebank`). Forms the base URL host. |
| Environment Pool | string | No | Environment pool suffix (e.g. `dev-10` for sandbox). Leave empty for production. |
| User Roles | array of strings | Yes | At least one role must grant read access to `login`. |
| Client ID | string | Yes | Tenant API `client_id`, sent as the `client_id` HTTP header. |
| Use Synthetic Data | bool | No | Generate synthetic demo records instead of connecting to Finxact. Useful for pipeline testing. |

> **Note:** Login has no Backfill Start Time setting — it takes a full snapshot on every run rather than advancing a timestamp cursor.

### Secrets

| Secret | Type | Required | Description |
| ------ | ---- | -------- | ----------- |
| Client Secret | string | Yes | Tenant API client secret, sent as the `secret` HTTP header. |

## Networking

Finxact enforces network-level access control on the core-banking API. If the Monad worker cannot reach the tenant, or its egress IP is not on the allowlist, requests fail with **HTTP 403 Forbidden**. To resolve:

1. Identify the Monad worker's egress IP.
   - For Monad SaaS: see [Monad egress IP addresses](../../guides/egress-ip-addresses.mdx).
   - For self-hosted deployments: use your own cluster's outbound IP.
2. Add that IP to your Finxact tenant's allowlist via the Finxact Console (or coordinate with your Finxact deployment engineer).
3. If your tenant sits behind a required VPN, ensure the Monad worker is on the VPN.

## Troubleshooting

**`finxact authentication failed` (HTTP 401)**
The `client_id` / `secret` are wrong, or the role listed in **User Roles** does not grant read on `login`. Regenerate credentials in the Finxact Console and confirm the assigned role covers `login` read.

**`finxact rejected the request at the network layer` (HTTP 403)**
Finxact's edge is refusing the connection before authentication runs. Confirm the Monad worker's egress IP is allowlisted at the tenant and that any required VPN is connected. See [Networking](#networking).

**The same logins are re-emitted every run**
This is expected. Login is a full-snapshot input — it re-fetches every login on each sync so posture changes are never missed. Deduplicate or take the latest per `loginId` downstream if you only want current state.

**`finxact 429` or repeated `finxact 5xx` errors**
Retryable — the input surfaces these so the framework retries on the next scheduled run. Persistent 429s indicate the tenant's contracted throughput is being exceeded; reduce sync frequency, or coordinate an increase with your Finxact account team.

## Related Articles

- [Finxact — login API](https://finxact.io/apis/detail-page/api_library/login/)
- [Finxact — Authentication](https://finxact.io/apis/detail-page/document/authentication/)
- [Finxact — Pagination, ordering, and limits](https://finxact.io/apis/detail-page/document/pagination-ordering-and-limits-filters/)
- [Finxact — Core and model API endpoints](https://finxact.io/apis/detail-page/document/core-and-model-api-endpoints/)
- [Finxact — API response codes](https://finxact.io/docs/document-detail/document/api-response-codes/)