API v2

FincheckEngine API

Send loan applicants to FincheckEngine. Let it match and deliver each lead for you, or show applicants the partners that qualify and commit to the one they choose.

Quickstart API Reference

Choose your integration

The two flows are separate. Use one or the other for each applicant.

Direct

Choose this if FincheckEngine should pick the partners and deliver the lead for you.

1POST/leadSend the applicant, or many with /lead/batch
2FincheckEngine matches and sends the lead in the background
3GET/lead/{hashid}Track the lead's state

You get: A lead id straight away, then the lead's state as it moves.

Start the Direct guide

Comparisons

Choose this if the applicant should see their offers and pick a partner themselves.

1POST/offerGet the partners that qualify
2The applicant chooses one
3POST/acceptCommit the lead to that partner

You get: A list of matches, then a redirect or link for the chosen partner.

Start the Comparisons guide

Compare the flows

	Direct	Comparisons
Who chooses the partner	FincheckEngine	The applicant
Applicant sees partners	No	Yes, from the offer
When the lead is sent	In the background after POST /lead	When you call POST /accept
What you get back	A lead id	Matches, then a redirect or link
How you follow up	GET /lead/{hashid} or a batch webhook	The accept response

Connection details

Base URL: https://api.engine-v2.uat.fincheck.co.za/api/v2
Authentication: Authorization: Bearer fce_…
Send the key in the header on every request. Tokens in the body or URL are ignored.
Environments: UAT for building and testing with fictional applicants; Production for live applicants. Each has its own keys. Compare environments