Choose how you want to integrate HFD financing into your patient experience, then follow the documentation for your integration.
Choose your integration
HFD offers two API solutions: the Easy API and the Origination API, listed as Full Integration in the sidebar.
| Easy API | Origination API — Full Integration | |
|---|---|---|
| Choose this if… | You want a low-code integration and want HFD to handle the rest of the patient journey after you submit the patient data you’ve collected. | You want to build HFD financing into your existing workflows and manage the patient experience yourself. |
| Your responsibility | Send HFD the patient data you’ve collected. | Build and maintain your patient-facing interface and manage each step, from application creation through agreement activation. |
| Where to find the docs | Easy API in the sidebar. | Full Integration in the sidebar. |
Start building
- Choose your integration using the comparison above.
- Review its environment and authentication requirements:
- Easy API: Environments · Authentication
- Full Integration: Environments · Authentication
- Explore the application endpoints:
- Easy API: Start with Application and review the available Test Data.
- Full Integration: Start with Create a new application.
Find your way around the reference
- API Format: Review JSON, Responses, Errors, HTTP Codes, and Rate Limits.
- Easy API: Find the authentication, environment, test data, and endpoint documentation for the low-code integration.
- Full Integration: Find the Origination API endpoints for applications, agreements, addendums, payment methods, and finance offers.
- Accounts Api: Find endpoints for retrieving account details.
Plan for publishing approval
Both integrations use REST (an approach to accessing resources through HTTP requests). Before you publish your integration, arrange a review of your implementation with an HFD engineer. This approval is required because your integration handles sensitive personal healthcare information.