API Reference
Provider PortalHome

Begins the customer's journey through our Easy Application Process.

post
https://sandbox-api.gohfd.com/app/v0/start

Start your application journey with our Easy API. We require minimal information to get your customers into our system. This is an easy way for your customers to receive financing with our platform. Expected Format: application/json

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The Session Object

Represents a session

string | null

An arbitrary string that can be used to store your system’s unique identifier for the applicant. This field can serve as a way to link our Applicant entity in our system back to its corresponding entity in your system.

string | null

A field that is used internally. No need to provide any information here.

date-time

The time the request was created

string
required
length ≥ 1

The unique identifier for you (the provider of goods or services). If you are a multi-location partner, this field will need to represent which specific location the applicant is applying for financing at. HFD will issue this identifier to you during the onboarding process.

Application
object

Represents the incoming application for the patient

Meta
object | null

Dynamic Meta Object

Options
object

Represents the options for an application session

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago