canonical: https://jentic.com/apis/scarlettnetwork.net/scarlettnetwork

# Scarlett Network Mortgage Connect API

Mortgage processing and lead management API for the Scarlett Network platform. The API exposes 17 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically create lead, get lead by id. Covers 17 operations with oauth2 authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Create lead
- Get lead by ID
- Search leads
- Update lead
- Add mortgage inquiry

## Use cases

### CRM Operations

Use the Scarlett Network Mortgage Connect API to perform crm operations programmatically. The API provides 17 endpoints covering core functionality including create lead, get lead by id, search leads.

Example prompt: Call POST `/leads/create` to create lead

### Automated Authentication Management

Automate authentication operations by combining multiple Scarlett Network Mortgage Connect API endpoints. Agents can get lead by id and then search leads in a single workflow.

Example prompt: Call GET `/leads/{leadId}` to get lead by id, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Scarlett Network Mortgage Connect API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.

Example prompt: Search Jentic for 'create lead', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/leads/create` | Create lead |
| GET | `/leads/{leadId}` | Get lead by ID |
| POST | `/leads/search` | Search leads |
| POST | `/leads/update` | Update lead |
| POST | `/leads/mortgage-inquires/add` | Add mortgage inquiry |
| POST | `/leads/mortgage-inquires/update` | Update mortgage inquiry |
| POST | `/leads/applicants/add` | Add applicant |
| POST | `/leads/applicants/update` | Update applicant |

## Key resources

- **Authentication** — Operations related to Authentication
- **DOSConnect** — Operations related to DOSConnect
- **Leads** — Operations related to Leads

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 75 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 55 / 100
  - Agent Usability: 94 / 100
  - Security: 85 / 100
  - AI Discoverability: 100 / 100
- **View full report:** https://jentic.com/apis/scarlettnetwork.net/scarlettnetwork/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Scarlett Network Mortgage Connect API by hand means running its OAuth2 client-credentials flow for a token and coordinating lead, mortgage-inquiry, and applicant calls yourself. Through Jentic you install once, import the Scarlett Network Mortgage Connect API from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** Scarlett Network puts the lead id in the URL path (`/leads/{leadId}`), so a rule can pin your agent to reading one lead. You choose the operations it may call, so writes like creating or updating a lead, or adding an applicant, are not included unless you add them.
- **Credential handling:** Your Scarlett Network credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a lead' or 'search leads', and Jentic returns the matching Scarlett Network Mortgage Connect API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Scarlett Network Mortgage Connect API use?

The Scarlett Network Mortgage Connect API uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create lead with the Scarlett Network Mortgage Connect API?

Yes. Use the POST `/leads/create` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Scarlett Network Mortgage Connect API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create lead through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create lead'. Jentic returns the matching Scarlett Network Mortgage Connect API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Scarlett Network Mortgage Connect API have?

The Scarlett Network Mortgage Connect API exposes 17 endpoints covering authentication, dosconnect, leads operations.

### Can I limit what my agent is allowed to do with the Scarlett Network Mortgage Connect API?

Yes. Jentic One runs on your own infrastructure, and your rules decide which operations and credentials the agent may use. Because Scarlett Network puts the lead ID in the URL path (GET `/leads/{leadId}`), you can pin the agent to reading a single lead and keep write operations such as POST `/leads/create`, POST `/leads/update`, and POST `/leads/applicants/add` off the allowed list unless you add them. Only the operations you approve are callable, so the agent cannot create leads or add applicants beyond the scope you set.