This endpoint is used to access the status of the current Offer or Funding, as well as the embedding link for the Capital iframe.

Depending on the presence and status of the current Offer and Funding, Platforms can communicate different details to the Business in their UI. For example, a new available Offer might be highlighted with a different display.

📘

finmid API supports capital_offer.created webhook to communicate when a new Offer is available for the Business.

The optional auth_context query parameter lets a Platform declare, per embedding session, how strongly the user was authenticated, overriding the default finmid 2FA policy for the returned embedding link. The decision applies to the whole session - (1) offer acceptance and (2) the merchant dashboard. This is only honored for Platforms finmid has explicitly enabled auth context override for.