Choose from Perch’s three core integration models - from simple referrals to full API control.
Perch offers three core integration models, grouped by reporting capabilities and technical requirements. These models help partners understand the trade-offs between simplicity and control, with each offering progressively deeper insights into client mortgage journeys. While partners can combine approaches or customize beyond these models, these represent our primary integration paradigms. Choose the model that best fits your business needs and technical capabilities.Before choosing your integration option, it may be beneficial to learn about how Perch has structured our core API resources (Leads & Plans) to help facilitate your decision.
Aggregate ReportingDrive referrals to Perch by sharing your Referral Link on your website, social media, in your email signature, etc., or by embedding one of Perch’s embeddable tools to earn a commission on each funded deal.
Best for: Partners who want to earn commissions, but don’t need intimate insights into client deal progress and tracking.
Referral Links & Widgets direct users to Perch’s customizable signup page with your referral code, company logo (or photo), and a customizable welcome message.
2
Client Signs Up
Users sign up and are automatically tagged with your referral attribution. You’re notified via email when a client signs up and when their deal funds. In addition to email alerts, you can also track your referrals via API and through our lead submission tools.
Referral Tracking Tool - List deals where you're tagged as the referral source (no PII)
When users simply click through widgets or referral links, there’s no established data sharing relationship. The client hasn’t explicitly consented to share their personal information with the referring partner beyond basic attribution.
Light Reporting, Control & InsightsPerch’s Lead Submission tools can be accessed via URL or embedded directly into your CRM for a more seamless submission experience.
Best for: Non-technical partners who need deeper insights into client deal progress.
Submit client details and financing needs through the lead submission form
3
Track Progress
Monitor the client’s mortgage journey from pre-approval through funding
4
Earn Commission
Receive commission payments on successfully funded deals
The Key Difference: Unlike referral codes where clients sign up independently, submitting structured lead data establishes you as the originating partner with explicit consent. This creates a direct business relationship that grants you ongoing access to client information and deal progress through our authenticated tools and the API.
Simplified data submission - provide the basics like name, email, deal purpose and notes (to submit a richer client profile (assets, debts, employment, etc.), consider using our API integration)
Full lead tracking - monitor conversion from referral to funding
Application status visibility - see where clients are in the mortgage process
Plan details access - view pre-approval amounts, application stages
Email notifications - get alerts when leads convert and reach milestones
Deep Reporting, Control & InsightOur direct API integration gives you full control over your lead submission and monitoring experience. Unlike simpler integration options, the API allows you to submit a complete client profile including items like assets, debts, residence history, employment details, and more—helping your clients expedite their mortgage journey to get pre-approved faster.
Best for: Technical partners who need deeper insights and want full control over their client experience. Check out our quick-start guide to learn how to submit and track leads through the Perch API.
Perch’s Zapier integration (available via invite only) enables automated lead submission from your Zapier-compatible CRM systems directly to our platform. Use Zapier’s visual workflow builder to create automated workflows that sync leads without writing any code, while maintaining full access to Perch’s lead tracking and management tools.
Zapier Workflow - Automated lead submission from CRM to Perch
Note: Zapier integration enables one-way lead submission from your Zapier-compatible CRM to Perch. Contact your Perch representative to request access to our lead submission Zap.
While it might seem logical that referring a client should grant full data access, privacy regulations and client expectations require explicit consent for data sharing. Simply clicking a referral link doesn’t establish this consent—submitting a structured lead with client details does.
Learn about the foundational objects that power the Perch platform.
Start with Lead Submission
Begin your integration journey with structured lead submission.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Perch Developer Platform","colors":{"primary":"#327766","light":"#4A9B8E","dark":"#225544"},"logo":{"light":"https://mintcdn.com/perch/aarm0-0z3T7Cpqsa/logo/light.svg?fit=max\u0026auto=format\u0026n=aarm0-0z3T7Cpqsa\u0026q=85\u0026s=9888bee08d7235bfc8b62134afbbcd38","dark":"https://mintcdn.com/perch/aarm0-0z3T7Cpqsa/logo/dark.svg?fit=max\u0026auto=format\u0026n=aarm0-0z3T7Cpqsa\u0026q=85\u0026s=3581a78d9a09760d968114a698c5d1ab"},"favicon":"https://mintcdn.com/perch/aarm0-0z3T7Cpqsa/favicon.svg?fit=max\u0026auto=format\u0026n=aarm0-0z3T7Cpqsa\u0026q=85\u0026s=23972ee76b34e87f01ac89a6b0d2bfe4","api":{"examples":{"prefill":true}},"navbar":{"links":[{"href":"mailto:support@myperch.io","label":"Contact Support"}],"primary":{"type":"button","label":"Client Portal","href":"https://app.myperch.io"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/perchcanada","facebook":"https://www.facebook.com/PerchCanada"}},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"perch","hasAudioNarration":false,"actualSubdomain":"perch","customDomains":["docs.myperch.io"],"gitSource":{"type":"github","owner":"myperch","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a91bd89ef81b33a53331a04","collectionId":"43308cb4-8866-450d-bb72-dbb772d24f85","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a91bd89ef81b33a53331a04"},"entitlements":{},"buildId":"6a91bd89ef81b33a53331a04","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Get Started","count":17},{"language":"default","tag":"Lead","count":12},{"language":"default","tag":"Realtor API","count":9},{"language":"default","tag":"Realtor API Reference","count":9},{"language":"default","tag":"Core API","count":8},{"language":"default","tag":"Partner API","count":8},{"language":"default","tag":"Partner API Reference","count":8},{"language":"default","tag":"Embeds","count":5},{"language":"default","tag":"Plan","count":4},{"language":"default","tag":"Welcome","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"getting-started/integration-options","slug":"/getting-started/integration-options","pageMetadata":{"title":"Integration Options","description":"Choose from Perch's three core integration models - from simple referrals to full API control.","href":"/getting-started/integration-options"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Choose from Perch’s three core integration models - from simple referrals to full API control.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,li:`li`,ol:`ol`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Card,CardGroup,Frame,Heading,Info,OptimizedImage,Step,Steps,Table,Tip}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Step)_missingMdxReference(`Step`,true);if(!Steps)_missingMdxReference(`Steps`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Perch offers three core integration models, grouped by reporting capabilities and technical requirements. These models help partners understand the trade-offs between simplicity and control, with each offering progressively deeper insights into client mortgage journeys. While partners can combine approaches or customize beyond these models, these represent our primary integration paradigms. Choose the model that best fits your business needs and technical capabilities.`}),`\n`,_jsxs(_components.p,{children:[`Before choosing your integration option, it may be beneficial to learn about how Perch has structured our `,_jsx(_components.a,{href:`/core-concepts/leads-and-plans`,children:`core API resources (Leads \u0026 Plans)`}),` to help facilitate your decision.`]}),`\n`,_jsx(Heading,{level:`2`,id:`integration-options-overview`,children:`Integration Options Overview`}),`\n`,_jsxs(CardGroup,{cols:3,children:[_jsxs(Card,{title:`Referrals \u0026 Widgets`,icon:`browsers`,href:`#referrals--widgets`,children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Aggregate Reporting`})}),_jsx(_components.p,{children:`Best for partners who want to earn commissions, but don’t need intimate insights into progress and tracking.`})]}),_jsxs(Card,{title:`Lead Management`,icon:`laptop-code`,href:`#lead-management-tools`,children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Medium Control + Insights`})}),_jsx(_components.p,{children:`Best for non-technical partners who need deeper insights into client progress.`})]}),_jsxs(Card,{title:`API Integration`,icon:`code`,href:`#api-integration`,children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Full Control + Insights`})}),_jsx(_components.p,{children:`Best for technical partners who need deeper insights and want full control over their client experience.`})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`referrals-\u0026-widgets`,children:`Referrals \u0026 Widgets`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`Aggregate Reporting`})}),`\n`,_jsxs(_components.p,{children:[`Drive referrals to Perch by sharing your `,_jsx(_components.strong,{children:`Referral Link`}),` on your website, social media, in your email signature, etc., or by embedding one of Perch’s `,_jsx(_components.a,{href:`/embeds/overview`,children:`embeddable tools`}),` to earn a commission on each funded deal.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Best for:`}),` Partners who want to earn commissions, but don’t need intimate insights into client deal progress and tracking.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`how-it-works`,children:`How It Works`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Drive Traffic`,children:_jsxs(_components.p,{children:[`Referral Links \u0026 Widgets direct users to Perch’s customizable `,_jsx(_components.a,{href:`https://app.myperch.io/auth/sign-up?referralCode=EXAMPLE`,children:`signup page`}),` with your referral code, company logo (or photo), and a customizable welcome message.`]})}),_jsxs(Step,{title:`Client Signs Up`,children:[_jsxs(_components.p,{children:[`Users sign up and are automatically tagged with your referral attribution. You’re notified via email when a client signs up and when their deal funds. In addition to email alerts, you can also track your referrals `,_jsx(_components.a,{href:`/getting-started/overview`,children:`via API`}),` and through our `,_jsx(_components.a,{href:`/embeds/lead-management`,children:`lead submission tools`}),`.`]}),_jsx(Frame,{caption:`Referral Tracking Tool - List deals where you're tagged as the referral source (no PII)`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/perch/UH7gC-rNQhRtFjdR/images/referral-tracking-list.png?fit=max\u0026auto=format\u0026n=UH7gC-rNQhRtFjdR\u0026q=85\u0026s=7559f4969a10bd797319e92c4a8b39bb`,alt:`Screenshot of the referral tracking tool`,\"data-og-width\":`2694`,width:`2694`,\"data-og-height\":`1318`,height:`1318`,\"data-path\":`images/referral-tracking-list.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/perch/UH7gC-rNQhRtFjdR/images/referral-tracking-list.png?w=280\u0026fit=max\u0026auto=format\u0026n=UH7gC-rNQhRtFjdR\u0026q=85\u0026s=537f4afee7cacd89a60d55d1ff69bb2f 280w, https://mintcdn.com/perch/UH7gC-rNQhRtFjdR/images/referral-tracking-list.png?w=560\u0026fit=max\u0026auto=format\u0026n=UH7gC-rNQhRtFjdR\u0026q=85\u0026s=d1e31bc27c8d9c752038ef024aec66e5 560w, https://mintcdn.com/perch/UH7gC-rNQhRtFjdR/images/referral-tracking-list.png?w=840\u0026fit=max\u0026auto=format\u0026n=UH7gC-rNQhRtFjdR\u0026q=85\u0026s=03150b24a1dd93f293403d20022496d3 840w, https://mintcdn.com/perch/UH7gC-rNQhRtFjdR/images/referral-tracking-list.png?w=1100\u0026fit=max\u0026auto=format\u0026n=UH7gC-rNQhRtFjdR\u0026q=85\u0026s=342d0489849e6a2c028eff531cc53049 1100w, https://mintcdn.com/perch/UH7gC-rNQhRtFjdR/images/referral-tracking-list.png?w=1650\u0026fit=max\u0026auto=format\u0026n=UH7gC-rNQhRtFjdR\u0026q=85\u0026s=df47427ca11e507ca93a25904c1e690b 1650w, https://mintcdn.com/perch/UH7gC-rNQhRtFjdR/images/referral-tracking-list.png?w=2500\u0026fit=max\u0026auto=format\u0026n=UH7gC-rNQhRtFjdR\u0026q=85\u0026s=98d3cfebf5e3383264c72f7d0c9ad05d 2500w`})})]}),_jsx(Step,{title:`Earn Commission`,children:_jsx(_components.p,{children:`Perch pays a commission on each funded deal.`})})]}),`\n`,_jsx(Heading,{level:`3`,id:`data-access-capabilities`,children:`Data Access Capabilities`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Aggregate reporting only`}),` - conversion emails and referral counts`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`No PII access`}),` - deal details are provided in aggregate and do not disclose client PII`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`why-limited-access`,children:`Why Limited Access?`}),`\n`,_jsx(_components.p,{children:`When users simply click through widgets or referral links, there’s no established data sharing relationship. The client hasn’t explicitly consented to share their personal information with the referring partner beyond basic attribution.`}),`\n`,_jsx(Heading,{level:`3`,id:`getting-started`,children:`Getting Started`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Explore available `,_jsx(_components.a,{href:`/embeds/overview`,children:`embeddable widgets`}),` for your website`]}),`\n`,_jsxs(_components.li,{children:[`Implement widgets following our `,_jsx(_components.a,{href:`/embeds/implementation`,children:`implementation guide`})]}),`\n`,_jsx(_components.li,{children:`Contact your Perch representative to get your referral code or setup a widget`}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`lead-management-tools`,children:`Lead Management Tools`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`Light Reporting, Control \u0026 Insights`})}),`\n`,_jsxs(_components.p,{children:[`Perch’s Lead Submission tools can be `,_jsx(_components.a,{href:`/embeds/lead-management`,children:`accessed via URL`}),` or `,_jsx(_components.a,{href:`/embeds/implementation`,children:`embedded directly`}),` into your CRM for a more seamless submission experience.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Best for:`}),` Non-technical partners who need deeper insights into client deal progress.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`how-it-works-2`,children:`How It Works`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Access Tools`,children:_jsxs(_components.p,{children:[`Access lead submission tools `,_jsx(_components.a,{href:`/embeds/lead-management`,children:`directly`}),` or `,_jsx(_components.a,{href:`/embeds/implementation`,children:`embed them`}),` into your CRM`]})}),_jsx(Step,{title:`Submit Leads`,children:_jsx(_components.p,{children:`Submit client details and financing needs through the lead submission form`})}),_jsx(Step,{title:`Track Progress`,children:_jsx(_components.p,{children:`Monitor the client’s mortgage journey from pre-approval through funding`})}),_jsx(Step,{title:`Earn Commission`,children:_jsx(_components.p,{children:`Receive commission payments on successfully funded deals`})})]}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`The Key Difference:`}),` Unlike referral codes where clients sign up independently, submitting structured lead data establishes you as the originating partner with explicit consent. This creates a direct business relationship that grants you ongoing access to client information and deal progress through our authenticated tools and the API.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`data-access-capabilities-2`,children:`Data Access Capabilities`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Simplified data submission`}),` - provide the basics like name, email, deal purpose and notes (to submit a richer client profile (assets, debts, employment, etc.), consider using our `,_jsx(_components.a,{href:`#api-integration`,children:`API integration`}),`)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Full lead tracking`}),` - monitor conversion from referral to funding`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Application status visibility`}),` - see where clients are in the mortgage process`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Plan details access`}),` - view pre-approval amounts, application stages`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Email notifications`}),` - get alerts when leads convert and reach milestones`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`getting-started-2`,children:`Getting Started`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Review our `,_jsx(_components.a,{href:`/embeds/lead-management`,children:`lead management tool guide`}),` for implementation details`]}),`\n`,_jsxs(_components.li,{children:[`Read about `,_jsx(_components.a,{href:`/embeds/overview`,children:`embeds`}),` to explore how you can embed our tools into your CRM`]}),`\n`,_jsx(_components.li,{children:`Contact your Perch representative to set up custom or branded versions of lead management tools`}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`api-integration`,children:`API Integration`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`Deep Reporting, Control \u0026 Insight`})}),`\n`,_jsx(_components.p,{children:`Our direct API integration gives you full control over your lead submission and monitoring experience. Unlike simpler integration options, the API allows you to submit a complete client profile including items like assets, debts, residence history, employment details, and more—helping your clients expedite their mortgage journey to get pre-approved faster.`}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Best for:`}),` Technical partners who need deeper insights and want full control over their client experience. Check out our `,_jsx(_components.a,{href:`/api-reference/submitting-and-tracking-leads`,children:`quick-start guide`}),` to learn how to submit and track leads through the Perch API.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`how-it-works-3`,children:`How It Works`}),`\n`,_jsxs(Steps,{children:[_jsx(Step,{title:`Integrate Platform`,children:_jsx(_components.p,{children:`Integrate your platform with Perch’s API through a direct code integration or via Zapier`})}),_jsx(Step,{title:`Track Leads`,children:_jsxs(_components.p,{children:[`Use our `,_jsx(_components.code,{children:`/leads`}),` endpoint to track leads, make updates and monitor for conversion (sign-up)`]})}),_jsx(Step,{title:`Monitor Deals`,children:_jsxs(_components.p,{children:[`Use the API to include `,_jsx(_components.code,{children:`Plans`}),` in your request (e.g. `,_jsx(_components.code,{children:`GET /leads?include=Plans`}),`) to access key insights like deal status`]})}),_jsx(Step,{title:`Take Action`,children:_jsx(_components.p,{children:`Use deep plan insights to follow up with your clients, automate various actions`})}),_jsx(Step,{title:`Earn a Commission`,children:_jsx(_components.p,{children:`Earn commission when your deals fund`})})]}),`\n`,_jsx(Heading,{level:`3`,id:`data-access-capabilities-3`,children:`Data Access Capabilities`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Complete API access`}),` - full `,_jsx(_components.code,{children:`CRUD`}),` permissions on `,_jsx(_components.code,{children:`Leads`}),` and `,_jsx(_components.code,{children:`Read`}),` permission on associated `,_jsx(_components.code,{children:`Plans`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Custom integrations`}),` - build tailored workflows for your business needs`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Bulk operations`}),` - efficiently manage large volumes of leads`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`zapier-integration`,children:`Zapier Integration`}),`\n`,_jsx(_components.p,{children:`Perch’s Zapier integration (available via invite only) enables automated lead submission from your Zapier-compatible CRM systems directly to our platform. Use Zapier’s visual workflow builder to create automated workflows that sync leads without writing any code, while maintaining full access to Perch’s lead tracking and management tools.`}),`\n`,_jsx(Frame,{caption:`Zapier Workflow - Automated lead submission from CRM to Perch`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/perch/llFSkHVEJEB6dziG/images/lead-submission-zapier.png?fit=max\u0026auto=format\u0026n=llFSkHVEJEB6dziG\u0026q=85\u0026s=98ab3f83281dfd74a0d5a0d15640b74a`,alt:`Screenshot showing Zapier workflow connecting CRM to Perch API for automated lead submission`,\"data-og-width\":`1996`,width:`1996`,\"data-og-height\":`1590`,height:`1590`,\"data-path\":`images/lead-submission-zapier.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/perch/llFSkHVEJEB6dziG/images/lead-submission-zapier.png?w=280\u0026fit=max\u0026auto=format\u0026n=llFSkHVEJEB6dziG\u0026q=85\u0026s=940fabc9961768066f02f0e7f79fd446 280w, https://mintcdn.com/perch/llFSkHVEJEB6dziG/images/lead-submission-zapier.png?w=560\u0026fit=max\u0026auto=format\u0026n=llFSkHVEJEB6dziG\u0026q=85\u0026s=4da12099b0e1024a17d1e3606be8bb61 560w, https://mintcdn.com/perch/llFSkHVEJEB6dziG/images/lead-submission-zapier.png?w=840\u0026fit=max\u0026auto=format\u0026n=llFSkHVEJEB6dziG\u0026q=85\u0026s=e7d4ef8f96d9c21a774bb12b6af8dd7d 840w, https://mintcdn.com/perch/llFSkHVEJEB6dziG/images/lead-submission-zapier.png?w=1100\u0026fit=max\u0026auto=format\u0026n=llFSkHVEJEB6dziG\u0026q=85\u0026s=e066cc0976ebade0cca1a84c3b7ae193 1100w, https://mintcdn.com/perch/llFSkHVEJEB6dziG/images/lead-submission-zapier.png?w=1650\u0026fit=max\u0026auto=format\u0026n=llFSkHVEJEB6dziG\u0026q=85\u0026s=2494b43a6b5490749a483ab1084fdb8a 1650w, https://mintcdn.com/perch/llFSkHVEJEB6dziG/images/lead-submission-zapier.png?w=2500\u0026fit=max\u0026auto=format\u0026n=llFSkHVEJEB6dziG\u0026q=85\u0026s=7cb7fcab54f4730e4848e761aac4c5f4 2500w`})}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Note:`}),` Zapier integration enables one-way lead submission from your Zapier-compatible CRM to Perch. Contact your Perch representative to request access to our lead submission Zap.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`getting-started-3`,children:`Getting Started`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Review `,_jsx(_components.a,{href:`/getting-started/authentication`,children:`API authentication`}),` requirements`]}),`\n`,_jsxs(_components.li,{children:[`Explore the `,_jsx(_components.a,{href:`/api-reference/submitting-and-tracking-leads`,children:`lead submission guide`})]}),`\n`,_jsx(_components.li,{children:`Contact your Perch representative for API credentials access to our Zaiper integration or book an API discussion with our integration team`}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`choosing-your-integration-option`,children:`Choosing Your Integration Option`}),`\n`,_jsx(Heading,{level:`3`,id:`ask-yourself`,children:`Ask Yourself:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.strong,{children:`Do you need detailed client information and application status?`})}),`\n`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Yes → Medium or High Integration`}),`\n`,_jsx(_components.li,{children:`No → Low Integration may be sufficient`}),`\n`]}),`\n`,_jsxs(_components.ol,{start:`2`,children:[`\n`,_jsx(_components.li,{children:_jsx(_components.strong,{children:`Do you have technical resources for API integration?`})}),`\n`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Yes → Consider High Integration for maximum flexibility`}),`\n`,_jsx(_components.li,{children:`No → Medium Integration provides great capability without development`}),`\n`]}),`\n`,_jsxs(_components.ol,{start:`3`,children:[`\n`,_jsx(_components.li,{children:_jsx(_components.strong,{children:`Is your business involved during a certain point of the mortgage application (e.g. once a client is pre-approved, you need to take a certain action)?`})}),`\n`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Not involved → Low Integration may meet your needs`}),`\n`,_jsx(_components.li,{children:`Involved → You likely need Medium or High Integration`}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`migration-path`,children:`Migration Path`}),`\n`,_jsx(_components.p,{children:`You can always start with a lower integration option and upgrade:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Low → Medium`}),`: Begin submitting leads through our tools`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Medium → High`}),`: Add API integration while keeping existing lead tools`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Any Level`}),`: Add referral widgets alongside other integration methods`]}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`access-policies-\u0026-privacy-protection`,children:`Access Policies \u0026 Privacy Protection`}),`\n`,_jsx(Heading,{level:`3`,id:`lead-ownership-model`,children:`Lead Ownership Model`}),`\n`,_jsx(_components.p,{children:`Our data access policies are built around a simple ownership model:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`You submit a lead`}),` → `,_jsx(_components.strong,{children:`You own the relationship`}),` → `,_jsx(_components.strong,{children:`You’ll maintain access to the data`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`You deployed a referral link`}),` → `,_jsx(_components.strong,{children:`No ownership established`}),` → `,_jsx(_components.strong,{children:`Limited to aggregate reporting`})]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`privacy-boundaries`,children:`Privacy Boundaries`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`PII Protection`}),`: Client personally identifiable information is only shared when there’s an established business relationship through lead submission`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Retroactive Access`}),`: Plans created by clients after sign-up (without lead submission) remain private unless manually linked by Perch support`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Consent-Based Sharing`}),`: All data sharing is based on the initial consent established through lead submission`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`why-we-can’t-share-all-referral-data`,children:`Why We Can’t Share All Referral Data`}),`\n`,_jsx(_components.p,{children:`While it might seem logical that referring a client should grant full data access, privacy regulations and client expectations require explicit consent for data sharing. Simply clicking a referral link doesn’t establish this consent—submitting a structured lead with client details does.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`summary`,children:`Summary`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Integration Option`}),_jsx(_components.th,{children:`Data Access`}),_jsx(_components.th,{children:`Client PII`}),_jsx(_components.th,{children:`Application Status`}),_jsx(_components.th,{children:`Technical Requirements`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Referrals \u0026 Widgets`})}),_jsx(_components.td,{children:`Aggregate only`}),_jsx(_components.td,{children:`❌ No`}),_jsx(_components.td,{children:`❌ No`}),_jsx(_components.td,{children:`Minimal`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Perch Tools`})}),_jsx(_components.td,{children:`Submitted leads only`}),_jsx(_components.td,{children:`✅ Yes`}),_jsx(_components.td,{children:`✅ Yes`}),_jsx(_components.td,{children:`None`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`API Integration`})}),_jsx(_components.td,{children:`Full programmatic`}),_jsx(_components.td,{children:`✅ Yes`}),_jsx(_components.td,{children:`✅ Yes`}),_jsx(_components.td,{children:`Development`})]})]})]}),`\n`,_jsx(_components.p,{children:`Choose the option that matches your business needs and technical capabilities. You can always upgrade as your requirements evolve.`}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next Steps`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Understand Leads \u0026 Plans`,icon:`lightbulb`,href:`/core-concepts/leads-and-plans`,arrow:`true`,children:_jsx(_components.p,{children:`Learn about the foundational objects that power the Perch platform.`})}),_jsx(Card,{title:`Start with Lead Submission`,icon:`user-plus`,href:`/api-reference/submitting-and-tracking-leads`,arrow:`true`,children:_jsx(_components.p,{children:`Begin your integration journey with structured lead submission.`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Integration Options","description":"Choose from Perch's three core integration models - from simple referrals to full API control.","href":"/getting-started/integration-options"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Integration Options Overview","slug":"integration-options-overview","depth":2,"children":[]},{"title":"Referrals \u0026 Widgets","slug":"referrals-\u0026-widgets","depth":2,"children":[{"title":"How It Works","slug":"how-it-works","depth":3,"children":[]},{"title":"Data Access Capabilities","slug":"data-access-capabilities","depth":3,"children":[]},{"title":"Why Limited Access?","slug":"why-limited-access","depth":3,"children":[]},{"title":"Getting Started","slug":"getting-started","depth":3,"children":[]}]},{"title":"Lead Management Tools","slug":"lead-management-tools","depth":2,"children":[{"title":"How It Works","slug":"how-it-works-2","depth":3,"children":[]},{"title":"Data Access Capabilities","slug":"data-access-capabilities-2","depth":3,"children":[]},{"title":"Getting Started","slug":"getting-started-2","depth":3,"children":[]}]},{"title":"API Integration","slug":"api-integration","depth":2,"children":[{"title":"How It Works","slug":"how-it-works-3","depth":3,"children":[]},{"title":"Data Access Capabilities","slug":"data-access-capabilities-3","depth":3,"children":[]},{"title":"Zapier Integration","slug":"zapier-integration","depth":3,"children":[]},{"title":"Getting Started","slug":"getting-started-3","depth":3,"children":[]}]},{"title":"Choosing Your Integration Option","slug":"choosing-your-integration-option","depth":2,"children":[{"title":"Ask Yourself:","slug":"ask-yourself","depth":3,"children":[]},{"title":"Migration Path","slug":"migration-path","depth":3,"children":[]}]},{"title":"Access Policies \u0026 Privacy Protection","slug":"access-policies-\u0026-privacy-protection","depth":2,"children":[{"title":"Lead Ownership Model","slug":"lead-ownership-model","depth":3,"children":[]},{"title":"Privacy Boundaries","slug":"privacy-boundaries","depth":3,"children":[]},{"title":"Why We Can’t Share All Referral Data","slug":"why-we-can’t-share-all-referral-data","depth":3,"children":[]}]},{"title":"Summary","slug":"summary","depth":2,"children":[]},{"title":"Next Steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"perch","siteName":"Perch Developer Platform","title":"Integration Options - Perch Developer Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-30T22:53:15.043Z","originalFileLocation":"getting-started/integration-options.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Choose from Perch\u0026#x27;s three core integration models - from simple referrals to full API control.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Perch Developer Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/perch/3EQlvaVh22sc_HAM/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/perch/3EQlvaVh22sc_HAM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/perch/3EQlvaVh22sc_HAM/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/perch/3EQlvaVh22sc_HAM/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/perch/3EQlvaVh22sc_HAM/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/perch/3EQlvaVh22sc_HAM/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/perch/3EQlvaVh22sc_HAM/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/perch/3EQlvaVh22sc_HAM/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/perch/3EQlvaVh22sc_HAM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Integration Options - Perch Developer Platform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Choose from Perch\u0026#x27;s three core integration models - from simple referrals to full API control.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Perch Developer Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.myperch.io/getting-started/integration-options\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://perch.mintlify.app/_mintlify/api/og/v2?division=Welcome\u0026amp;title=Integration+Options\u0026amp;description=Choose+from+Perch%27s+three+core+integration+models+-+from+simple+referrals+to+full+API+control.\u0026amp;theme=765fa53beba12088a07aaa23\u0026amp;signature=5be654fb92d4878ff9cf0607f28ff65547702d6b8ea924b5032493aeec9c585a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Integration Options - Perch Developer Platform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Choose from Perch\u0026#x27;s three core integration models - from simple referrals to full API control.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://perch.mintlify.app/_mintlify/api/og/v2?division=Welcome\u0026amp;title=Integration+Options\u0026amp;description=Choose+from+Perch%27s+three+core+integration+models+-+from+simple+referrals+to+full+API+control.\u0026amp;theme=765fa53beba12088a07aaa23\u0026amp;signature=5be654fb92d4878ff9cf0607f28ff65547702d6b8ea924b5032493aeec9c585a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/perch/3EQlvaVh22sc_HAM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Perch Developer Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#327766\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.myperch.io/getting-started/integration-options\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/getting-started/integration-options.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.myperch.io/#organization\",\"name\":\"Perch Developer Platform\",\"url\":\"https://docs.myperch.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/perch/aarm0-0z3T7Cpqsa/logo/light.svg?fit=max\u0026auto=format\u0026n=aarm0-0z3T7Cpqsa\u0026q=85\u0026s=9888bee08d7235bfc8b62134afbbcd38\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.myperch.io#website\",\"name\":\"Perch Developer Platform\",\"url\":\"https://docs.myperch.io\",\"publisher\":{\"@id\":\"https://docs.myperch.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.myperch.io/getting-started/integration-options#webpage\",\"url\":\"https://docs.myperch.io/getting-started/integration-options\",\"name\":\"Integration Options\",\"description\":\"Choose from Perch's three core integration models - from simple referrals to full API control.\",\"dateModified\":\"2026-03-30T22:53:15.043Z\",\"isPartOf\":{\"@id\":\"https://docs.myperch.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.myperch.io/getting-started/integration-options#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.myperch.io/getting-started/integration-options#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Welcome\",\"item\":\"https://docs.myperch.io/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Integration Options\",\"item\":\"https://docs.myperch.io/getting-started/integration-options\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.myperch.io/getting-started/integration-options#article\",\"headline\":\"Integration Options\",\"name\":\"Integration Options\",\"description\":\"Choose from Perch's three core integration models - from simple referrals to full API control.\",\"url\":\"https://docs.myperch.io/getting-started/integration-options\",\"mainEntityOfPage\":{\"@id\":\"https://docs.myperch.io/getting-started/integration-options#webpage\"},\"dateModified\":\"2026-03-30T22:53:15.043Z\",\"publisher\":{\"@id\":\"https://docs.myperch.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.myperch.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Perch Developer Platform\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Perch Developer Platform","nav":{"global":{},"tabs":[{"tab":"Get Started","groups":[{"group":"Welcome","pages":[{"title":"Introduction","description":"Welcome to the Perch Developer Platform - APIs and tools for integrating digital mortgage solutions","href":""},{"title":"Integration Options","href":"/getting-started/integration-options"},{"title":"Terms of Use","description":"Terms of Service for using the Perch Core API","href":"/getting-started/terms-of-use"}]},{"group":"Core API","pages":[{"title":"Overview","href":"/getting-started/overview"},{"title":"Leads and Plans","href":"/core-concepts/leads-and-plans"},{"title":"Authentication","href":"/getting-started/authentication"},{"title":"Postman Setup Guide","href":"/getting-started/postman-setup"},{"title":"Errors and response codes","href":"/getting-started/errors-and-response-codes"},{"title":"Rate limits","href":"/getting-started/rate-limits"},{"title":"Pagination and query parameters","href":"/getting-started/pagination"},{"title":"Submitting \u0026 Tracking Leads","href":"/api-reference/submitting-and-tracking-leads"}]},{"group":"Lending API","pages":[{"title":"Overview","href":"/lending-services/overview"}]},{"group":"Embeds","pages":[{"title":"Overview","href":"/embeds/overview"},{"title":"Implementation Guide","href":"/embeds/implementation"},{"title":"Customization","href":"/embeds/customization"},{"title":"Authenticated Embeds","href":"/embeds/authenticated-embeds"},{"title":"Lead Management","href":"/embeds/lead-management"}]}]},{"tab":"Partner API","pages":[{"title":"Partner API","href":"/partner-api/workflows:-firm-member/workflowsfirm-member-realtor-find-or-create"}]},{"tab":"Realtor API","pages":[{"title":"Realtor API","href":"/realtor-api/lead/list-leads-for-firmmember"}]}]},"title":"Integration Options - Perch Developer Platform","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-COGkNuA6.js","DynamicMarkdown-85clUA0i.js","zoom-image-lightbox-BZxD9MAj.js","lightbox-handle-r17bVUz3.js"]}
