API Reference

Create Prefill

post
https://app.getmatchifi.com/api/prequalification/prefill

Saves draft suggestions only. Does not run credit, submit applications, accept consent/signatures, or send messages. Unknown fields are rejected at every level. Body limit: 64 KB. Saved/submitted records and already-open forms are not overwritten. SSN, income/employment, banking, consent/signature, selected-offer and equipment-specification fields are rejected.

Idempotency keys are scoped to property + HTTP method. Equivalent retries return the original success without applying again. Keys are retained at least 24 hours, normally 24–48 hours; retries do not extend retention. After expiration, key reuse executes again.

Every new POST key creates a new Project.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255

Merchant appID owned by this property.

string | null

Optional, non-unique Project metadata, trimmed only. Never an upsert or deduplication key. Omission and null both mean no reference. Use the same representation when retrying a key.

primaryApplicant
object | null
secondaryApplicant
object | null

Applied only after homeowner opts into adding a secondary applicant.

projectDetails
object | null
Headers
string
required
length between 1 and 255
^[!-~]+$

Exact, case-sensitive visible ASCII. New key per intended operation; same key and input on retry.

Responses

Updated 13 days ago

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

Updated 13 days ago

Did this page help you?