# Perch Developer Platform

## Docs

- [Submitting & Tracking Leads](https://docs.myperch.io/api-reference/submitting-and-tracking-leads.md): Complete walkthrough of using the Perch API to submit leads and monitor their progress through the mortgage application lifecycle
- [Leads and Plans](https://docs.myperch.io/core-concepts/leads-and-plans.md): The two foundational objects that play a critical role in the Core API
- [Authenticated Embeds](https://docs.myperch.io/embeds/authenticated-embeds.md): User-authenticated embeds with customizable widgets for partner workflows and client management
- [Customization](https://docs.myperch.io/embeds/customization.md): Learn how to customize Perch's embeddable tools with pre-filled data and styling options
- [Implementation Guide](https://docs.myperch.io/embeds/implementation.md): Step-by-step instructions for implementing Perch embeddable tools across different platforms and frameworks
- [Lead Management](https://docs.myperch.io/embeds/lead-management.md): Submit client referrals and track their mortgage progress with Perch’s authenticated embed.
- [Overview](https://docs.myperch.io/embeds/overview.md): Live demonstrations and implementation guide for Perch embeddable mortgage calculators, rate displays, and financial tools
- [Authentication](https://docs.myperch.io/getting-started/authentication.md): Learn how to authenticate with the Perch Core API using API keys
- [Errors and response codes](https://docs.myperch.io/getting-started/errors-and-response-codes.md): Understanding error handling and HTTP status codes in the Perch Core API
- [Integration Options](https://docs.myperch.io/getting-started/integration-options.md): Choose from Perch's three core integration models - from simple referrals to full API control.
- [Overview](https://docs.myperch.io/getting-started/overview.md): Getting started with the Perch Core API - partner and realtor endpoints, domains, and best practices
- [Pagination and query parameters](https://docs.myperch.io/getting-started/pagination.md): Understanding pagination, filtering, ordering, and query parameters in the Perch Core API
- [Postman Setup Guide](https://docs.myperch.io/getting-started/postman-setup.md): Step-by-step guide to import and configure the Perch API in Postman for instant testing
- [Rate limits](https://docs.myperch.io/getting-started/rate-limits.md): Understanding rate limiting policies and best practices for the Perch Core API
- [Terms of Use](https://docs.myperch.io/getting-started/terms-of-use.md): Terms of Service for using the Perch Core API
- [Introduction](https://docs.myperch.io/index.md): Welcome to the Perch Developer Platform - APIs and tools for integrating digital mortgage solutions
- [Overview](https://docs.myperch.io/lending-services/overview.md): A dedicated API powering auto-adjudication, real-time rate retrieval, and mortgage search
- [Create Lead for Firm](https://docs.myperch.io/partner-api/lead/create-lead-for-firm.md): Creates a record in the Lead table based on passed parameters and implicit access controls.
- [Delete Lead](https://docs.myperch.io/partner-api/lead/delete-lead.md): Deletes a record from the Lead table based on passed parameters and implicit access controls.
- [List Leads for Firm](https://docs.myperch.io/partner-api/lead/list-leads-for-firm.md): Gets a list of records from the Lead table based on passed parameters and implicit access controls.
- [Read Lead](https://docs.myperch.io/partner-api/lead/read-lead.md): Gets a record from the Lead table based on passed parameters and implicit access controls.
- [Update Lead](https://docs.myperch.io/partner-api/lead/update-lead.md): Updates a record in the Lead table based on passed parameters and implicit access controls.
- [List Plans for ReferralCode](https://docs.myperch.io/partner-api/plan/list-plans-for-referralcode.md): Gets a list of records from the Plan table based on passed parameters and implicit access controls.
- [Read Plan](https://docs.myperch.io/partner-api/plan/read-plan.md): Gets a record from the Plan table based on passed parameters and implicit access controls.
- [/workflows/firm-member-realtor-find-or-create](https://docs.myperch.io/partner-api/workflows:-firm-member/workflowsfirm-member-realtor-find-or-create.md): Finds or creates a RealtorProfile and FirmMember for the given email address and firm ID.
- [Create Lead for Firm](https://docs.myperch.io/realtor-api/lead/create-lead-for-firm.md): Creates a record in the Lead table based on passed parameters and implicit access controls.
- [Create Lead for FirmMember](https://docs.myperch.io/realtor-api/lead/create-lead-for-firmmember.md): Creates a record in the Lead table based on passed parameters and implicit access controls.
- [Delete Lead](https://docs.myperch.io/realtor-api/lead/delete-lead.md): Deletes a record from the Lead table based on passed parameters and implicit access controls.
- [List Leads for Firm](https://docs.myperch.io/realtor-api/lead/list-leads-for-firm.md): Gets a list of records from the Lead table based on passed parameters and implicit access controls.
- [List Leads for FirmMember](https://docs.myperch.io/realtor-api/lead/list-leads-for-firmmember.md): Gets a list of records from the Lead table based on passed parameters and implicit access controls.
- [Read Lead](https://docs.myperch.io/realtor-api/lead/read-lead.md): Gets a record from the Lead table based on passed parameters and implicit access controls.
- [Update Lead](https://docs.myperch.io/realtor-api/lead/update-lead.md): Updates a record in the Lead table based on passed parameters and implicit access controls.
- [List Plans for FirmMember](https://docs.myperch.io/realtor-api/plan/list-plans-for-firmmember.md): Gets a list of records from the Plan table based on passed parameters and implicit access controls.
- [Read Plan](https://docs.myperch.io/realtor-api/plan/read-plan.md): Gets a record from the Plan table based on passed parameters and implicit access controls.

## OpenAPI Specs

- [perch-partner.spec](https://perch-api-docs.s3.ca-central-1.amazonaws.com/perch-partner.spec.json)
- [perch-realtor.spec](https://perch-api-docs.s3.ca-central-1.amazonaws.com/perch-realtor.spec.json)