Webhooks
The webhooks Figure sends as inquiries and applications move forward, and how to receive them
On this page· 6 sections
Partner endpoint requirements#
Webhooks are delivered via HTTP POST to the URL you provide during onboarding.
Your endpoint should return a 200 OK status to acknowledge receipt of the message. If it returns anything other than a 2xx status, or can't be reached, Figure retries delivery several times with exponential backoff.
Encryption#
Figure can deliver webhooks encrypted or unencrypted, whichever you prefer. Encryption is optional, but your endpoint must use HTTPS.
Only RSA encryption is supported. To receive encrypted webhooks, give Figure a public key to encrypt them with. Each payload then arrives as a string that you decrypt with your matching private key, as described in Decrypting a JWE.
Show an example encrypted payload
Default inquiry webhooks #
Inquiries move through several processing steps. During onboarding, Figure can set up a webhook that notifies you at the key points. When processing finishes and the next nextInquiryStepType is ready, Figure sends a POST to your URL with the payload below. It tells you the next action to take, or that the inquiry has moved to the borrower.
When a webhook arrives, call Inquiry details to get the updated inquiry, then move the borrower forward in your system.
Examples#
Default application webhooks #
As the application progresses, your webhook endpoint receives these status updates. It can be the same endpoint as your inquiry webhooks or a different one.
Note
Once an inquiry transitions to an application, the webhook payload will have this schema. Instead of nextInquiryStepType, the payload includes a status field with the application's current status.
Custom webhooks #
If your systems need a different payload, Figure can configure one: anything in the Inquiry details response can go in it.