↩️ Webhooks

What's it for

Flow utilizes webhooks in the origination process to inform the originator from mainly 2 types of events:

  • Documents Events: In some cases the documents of a person or a business may go through a manual inspection, resulting in an async result.
  • Application Events: After an application is submitted it passes from different status and every time this change happens a webhook is triggered so the originator can keep control of the underwriting process. The application statuses are described in the Application page.

What to expect

Documents request example

{
  "payload": {
    "person_id": "5755ec32-f663-4d2d-9674-3d05031dac61",
    "document_id": "bd39dac3-9528-42a0-ae03-2c84c7c8007e",
    "status": "OK"
  },
  "createdAt": "2021-11-02T16:11:37.196941Z",
  "type": "PERSON_DOCUMENT_STATUS_UPDATED"
}
{
  "payload": {
    "business_id": "5755ec32-f663-4d2d-9674-3d05031dac61",
    "document_id": "bd39dac3-9528-42a0-ae03-2c84c7c8007e",
    "status": "OK"
  },
  "createdAt": "2021-11-02T16:11:37.196941Z",
  "type": "BUSINESS_DOCUMENT_STATUS_UPDATED"
}

Application request example

{
 "type": "APPLICATION_STATUS_UPDATED",
 "application_id": "APPLICATION_ID",
 "status": "STATUS"
}