Prefill flow

Create a draft, hand off to the homeowner, and track financing.

1. Choose the merchant

Call List Merchants with your property token. Use the merchant’s appID as merchantAppID. Check readyForFinancing; if false, send the merchant administrator to actionLink. You can still create a draft before setup is complete.

2. Create the draft

Call Create Prefill from your server. Use a new Idempotency-Key for each intended operation.

curl --request POST \
  --url https://app.getmatchifi.com/api/prequalification/prefill \
  --header "x-apptracker-property-token: ${MATCHIFI_PROPERTY_TOKEN}" \
  --header "Idempotency-Key: example-job-0042-create" \
  --header "Content-Type: application/json" \
  --data '{"merchantAppID":"EXAMPLEHVAC","externalReference":"JOB-0042","primaryApplicant":{"firstName":"Jordan","lastName":"Example","email":"[email protected]"},"projectDetails":{"service":"equipment","requestAmount":8500}}'

A 201 response contains projectID and continuationURL. Store both. A new POST key always creates a new Project; externalReference is not a deduplication key.

Prefill only saves suggestions. It does not run credit, submit financing, accept consent, select a lender, or send messages.

3. Hand off to the homeowner

Send the returned continuationURL to the intended homeowner. Treat it as an access-bearing link; do not build it from the numeric Project ID. It is reusable and has no time-based expiry, subject to Project and domain availability.

The homeowner reviews and completes prequalification, provides consent, sees lender matches, chooses Apply Now, and completes the lender application. Existing readiness and lender checks still apply. Secondary-applicant suggestions apply only after the homeowner chooses to add one.

4. Update and track

Use Update Prefill to patch selected suggestions or replace the draft. Saved/submitted homeowner values take precedence; updates do not change an open form or restart financing.

Retry an uncertain request with the same key and body. Idempotency records last at least 24 hours; see the endpoint references before retrying older operations. Cleanup does not expire continuation links.

Use Get Project for current status. Configure Project Webhooks for signed lifecycle updates, and fetch current state when notifications conflict or are missing. Keep your property API token on your server.


Did this page help you?