API keys

Last updated: 2025–03-11

API keys let external systems authenticate with LendAPI (e.g. to submit applications or read data). Create and manage API keys from the tenant settings.

---

Viewing API keys

1. Go to Tenant (or Settings) and open API keys.
2. The list shows each key’s name, key value (often partially masked), status (active/inactive), created date, and last used (if available).

Never share full key values. If a key is exposed, deactivate it and create a new one.

---

Creating an API key

1. On the API keys page, click Create or Add API key.
2. Enter a name (e.g. “Production integration” or “Partner X”).
3. Save. The system generates a new key and usually shows the full value once—copy and store it securely; you may not be able to see it again.

Use the key in your integration (e.g. in the Authorization header or as specified in the developer docs).

---

Activating and deactivating

• Deactivate: To revoke access without deleting the key, turn the key off or set status to Inactive. You can reactivate it later if needed.
• Activate: Set status back to Active so the key can be used again.

Deactivating is safer than deleting if you might need to restore access or audit which key was used.

---

Deleting an API key

Permanently remove a key when it’s no longer needed (e.g. after rotating to a new key). Deactivate it first to ensure nothing is using it, then delete. Deleted keys cannot be recovered.

Draft update (automation)

Summary: Expand this existing page to the Field Guide contract: what it is, how it works, a worked example, a use case, and best practices. Only describe behavior already present in the product. Feature area: tenant-and-workspace (modified) Evidence: lend-frontend-repo:src/features/settings/pages/index.ts, lend-frontend-repo:src/features/settings/types/index.ts, lend-frontend-repo:src/features/settings/pages/api/index.ts, lend-frontend-repo:src/features/settings/components/index.ts, lend-frontend-repo:src/features/settings/pages/users/index.ts, lend-frontend-repo:src/features/settings/pages/stages/index.ts, lend-frontend-repo:src/features/settings/pages/profile/index.ts, lend-frontend-repo:src/features/settings/pages/webhook/index.ts, lend-frontend-repo:src/features/settings/pages/security/index.ts, lend-frontend-repo:src/features/settings/pages/workspace/index.ts, lend-frontend-repo:src/features/settings/components/profile/index.ts, lend-frontend-repo:src/features/settings/components/security/index.ts Confidence: medium

• [ ] Verify UI labels and navigation match the current build
• [ ] Update screenshots if layout changed
• [ ] Confirm role/permission notes with PM