Skip to navigation

Fetch Eligibility Results

Bring the borrower’s eligibility assessment into view, with an overall journey result and a separate decision from each participating lender.

Where available, eligible lender results include an indicative loan amount, interest rate, annual percentage rate and repayment term. These provisional terms help the borrower understand the possibilities before exploring available offers; they are not a final loan approval.

Continue with Create A Journey using the same journey ID to discover offers for the borrower.

Authentication

AuthorizationBearer

Send Authorization: Bearer <PLATFORM_API_KEY> from a trusted back-end.

Path parameters

borrowerProviderIDstringRequired1-128 characters

Stable borrower identity from the partner system. Keep a 1:1 mapping between the borrower and borrowerProviderID across sessions and application attempts to preserve resume, history, and post-disbursal continuity.

Headers

x-correlation-idstringOptional1-128 characters

Optional caller-supplied trace identifier. When omitted, the API generates one and mirrors it as correlation_id.

Query parameters

journeyIDstringRequiredformat: "uuid"=36 characters

Business Loan journey ID. Supply this parameter exactly once on Dedupe polling or Eligibility; additional query parameters are not accepted.

Response

Current operation progress and lender results.
request_idstring
correlation_idstring
timestampdatetime
dataobject
errorany

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error