Welcome to the FileInvite for Lending API Guide. This guide helps you connect FileInvite’s API with your existing lending systems—whether you're streamlining client onboarding or handling document collection throughout the loan process.
\nIf you have additional use cases you’d like the API to support, please reach out to your Customer Success Representative. Your feedback helps us prioritize enhancements that best serve your needs.
\nFollow the steps below in the recommended order to integrate FileInvite’s API into your workflows.
\nAuthentication
FileInvite uses OAuth 2.0 (Client Credentials grant type) for secure access. See the Authentication Guide for token generation and user attribution.
Invites
Use the Invites API to automate document requests. Create, send, edit, and track invites to streamline your document collection process.
Contacts
Sync your customer, client, or borrower records with FileInvite. Use the Contacts API to create, update, or retrieve contact details.
Webhooks
Subscribe to real-time event notifications from FileInvite. Use Webhooks to receive instant updates on contacts, invites, and document submissions.
The FileInvite API uses OAuth2 authentication, specifically the Client Credentials grant type. This ensures secure access to the API.
\nTo use the FileInvite API, your organization needs its own set of API credentials.
\nStep 1: Contact your FileInvite account manager.
\nStep 2: Request the following unique ids from your account manager
- Client ID
- Client Secret
- Organisation id (code) A short hash unique identifier of the organization
- Account id (code) A short hash unique identifier of the account. There can be multiple accounts under a single organisation.
Once you have your Client ID and Secret:
\nYou need to generate an Access Token to make API requests.
\nAccess tokens are required to use any API endpoints.
\nYou can find technical documentation on how to get an access token and refresh token in our Authentication API Reference.
\nNo, the API client is not linked to a specific user but directly linked to the organisation. But the API calls are recorded as the Organisation owner made them.
\nYes, if you pass a custom header triggered-by-user-email with the user's email, the API request will be recorded as if the specific user has made the API calls.
This guide walks you through creating an Invite using the FileInvite API. Invites allow you to request documents, signatures, and other information from your Contacts.
\nBefore creating an Invite, ensure the following are set up in your FileInvite app:
\nTemplates
Templates streamline the Invite creation process by preloading a list of Request (documents to upload, forms to sign etc.). Learn how to create and manage Templates in our Templates Help Articles.
Use the Get Templates endpoint to retrieve available Templates.
\nThe API will return up to 25 Templates by default, sorted by the most recently created.
Allow the user to select a Template ID that matches the required requests.
Calling the Dispatch Invite endpoint automatically:
\nCreates the Invite.
\nGenerates the Portal for each Contact.
\nSends the Invite email to the specified Contacts (unless explicitly disabled).
\nRequired Parameters:
\nContact’s Email: Specify up to 10 Contact Emails.
\nTemplate ID: Provide the Template ID to use for the Invite.
\nThere are three ways to handle Invite creation, depending on whether you want to send the email immediately or review it first.
\nThis is the standard flow, where the Invite email is sent as soon as the Invite is created.
\nSteps:
\nCall the Dispatch Invite endpoint with the required parameters.
\nThe API responds with a 200 status, confirming that:
The Portal is created for each Contact.
\nThe Invite email is sent automatically to the specified Contacts.
\nNo further action is needed to send the Invite email in this scenario.
\nIf you prefer to send the Invite email using your own email engine instead of FileInvite:
\nSteps:
\nCall the Dispatch Invite endpoint.
\nSet the notify to false in your request.
The API responds with a 200 status, confirming that:
The Portal is created for each Contact.
\nThe Invite email is NOT sent by FileInvite.
\nThe Portal link is returned in the response.
\nYou can now use the returned Portal link to send your custom email.
\nIf you want to review the Invite details before sending the email, follow this process:
\nSteps:
\nCall the Dispatch Invite endpoint with notify to false in your request.
The API responds with a 200 status, confirming that:
The Portal is created for each Contact.
\nThe Invite email is NOT sent by FileInvite.
\nThe Portal link is returned in the response.
\nRetrieve the Invite details using the Get Invite endpoint to review:
\nContacts
\nSubject & Message
\nRequests
\nDue Dates & Reminder Settings
\nIf modifications are needed, follow the Edit Invite Guide.
\nOnce finalized, call the Resend Invite endpoint with the Invite ID and the Contact ID (or IDs) for the customers you want to resend the email to.
Edit an Invite: Modify an Invite after creation (e.g., add Contacts, update details).
\nAdd More Request Items: Learn how to include additional items in an Invite.
\nIf you need to make changes to an Invite, this guide covers the following use cases:
\nUpdating basic Invite details, such as the Subject, Message, Due Date, or Point of Contact.
\nDeleting a redundant request.
\nAdding or removing Contacts from the Invite.
\nTo update details of an existing Invite:
\nPass the Invite ID and the updated value for the parameter(s) you want to modify to the Update Invite API.
Examples of editable parameters:
\nSubject
Message
Due Date
Point of Contact
If a request on an Invite is no longer needed:
\nPass the Invite ID and the Request ID of the request you want to delete to the Get Invite Request endpoint.
This action removes the redundant request from the Invite.
\nPass the Invite ID and the Contact ID(s) to the Add Contact to an Invite endpoint.
Note: An Invite can have a maximum of 10 Contacts.
\nPass the Invite ID and the Contact ID(s) to the Remove Contact From an Invite endpoint.
Important: Every Invite must have at least one Contact. Ensure you do not remove the last Contact.
\nAdd More Request Items: Learn how to include additional items in an Invite.
\nRetrieve Files and Documents: Access files submitted through the Invite.
\nThis guide walks you through creating a Follow-up using the FileInvite API. A Follow-up allows you to request additional documents, signatures, or information from your Contacts after an Invite has already been sent.
\nBefore creating a Follow-up, ensure the following are set up in your FileInvite app:
\nTemplates
Follow-ups must use Templates to predefine the additional requests. Learn how to create and manage Templates in our Templates Help Articles.
Invite ID
Since Follow-ups are appended to an existing Invite, you must have a valid Invite ID to associate the Follow-up with an Invite.
Note: The Create Follow-up API endpoint is not yet available, but this guide illustrates how it will behave once implemented.
\nCalling the Create Follow-up endpoint will:
\nAppend additional requests to the existing Invite.
\nGenerate the Follow-up Name for tracking.
\nAutomatically send the Follow-up email to the Contacts (unless explicitly disabled).
\nRequired Parameters:
\nInvite ID: The ID of the existing Invite.
\nTemplate ID: The ID of the Template that contains the predefined request items.
\nFollow-up Name: A label for the Follow-up (e.g., \"Underwriting Documents\").
\nThere are three ways to handle Follow-ups, depending on whether you want to send the email immediately or review it first.
\nThis is the standard flow, where the Follow-up email is sent as soon as the Follow-up is created.
\nSteps:
\nCall the Create Follow-up endpoint with the required parameters.
\nThe API responds with a 200 status, confirming that:
The Follow-up is created and linked to the Invite.
\nThe Follow-up email is sent automatically to the specified Contacts.
\nIf you prefer to send the Follow-up email using your own email engine instead of FileInvite:
\nSteps:
\nCall the Create Follow-up endpoint.
\nSet the email_flag to 0 in your request.
The API responds with a 200 status, confirming that:
The Follow-up is created and linked to the Invite.
\nThe Follow-up email is NOT sent by FileInvite.
\nThe Portal link remains the same as the original Invite.
\nIf you want to review the Follow-up details before sending the email, follow this process:
\nSteps:
\nCall the Create Follow-up endpoint with email_flag: 0.
The API responds with a 200 status, confirming that:
The Follow-up is created and linked to the Invite.
\nThe Follow-up email is NOT sent by FileInvite.
\nThe Portal link remains unchanged (same as the original Invite).
\nRetrieve the Follow-up details using the Get Invite Requests endpoint to review:
\nContacts
\nFollow-up Name
\nReminder Settings
\nIf modifications are needed, follow the Edit Invite Guide.
\nOnce finalized, call the Resend Invite endpoint with the Invite ID to manually trigger the Follow-up email.
Retrieve Files & Documents: Learn how to access submitted files through the Invite.
\nArchive an Invite: Close the Invite when all requests are completed.
\nWhen your customers begin submitting documents or completing forms, you can access these files through the Invite. The Download API allows you to retrieve all files and forms that have been uploaded or completed at a given time.
\nRetrieve File IDs
\nPass the Invite ID to the Get Invite Requests endpoint.
This endpoint will return a list of File IDs.
\nDownload File
\nPass each File ID to the Download File endpoint.
\nThis endpoint will return a File URL, which expires in 5 minutes.
\nIn future updates, we plan to introduce a webhook that will notify you when new files or completed forms are ready for download. This will eliminate the need for frequent polling.
\nWhen an Invite is complete, and you’ve downloaded all the documents submitted through it, you may want to close the Portal to prevent further submissions. Archiving the Invite allows you to finalize and close the workflow.
\nTo archive an Invite:
\nPass the Invite ID of the Invite you wish to archive to the Archive Invite endpoint.
Once archived, the Portal will be closed, and no further submissions will be allowed.
\nKey Notes:
\nEnsure all required documents have been downloaded before archiving, as the Portal will no longer be accessible to Contacts once archived.
\nArchived Invites are still available for reference and reporting purposes in the system.
\nIn FileInvite, an Invite is the primary tool for collecting documents or information from your customers, clients, or applicants. It simplifies document requests by combining all required items (called Requests) into a single, streamlined workflow.
\nRequests: Individual tasks within an Invite that you are asking your customers to fulfill, such as uploading files, completing forms, or signing documents.
\nWhen an Invite is sent, your Contacts will receive an email containing a link to the Portal, where they can complete the requested tasks. For example:
\nUpload documents like bank statements or identification.
\nFill out and sign forms.
\nInvites eliminate manual follow-ups by automating document collection and tracking in one place, ensuring a seamless experience for both your team and your clients.
\nWe recommend that you have Templates already set up in the FileInvite app. Templates is a convenient way to streamlime the Invite creation process by preloading an exisitng list of requests that you would need to have on the Invite. The Templates help article explains how to create and set up Templates.
\nThe FileInvite API allows you to integrate Invites into your existing tools and workflows, so your team doesn’t have to switch between multiple systems. Below is a step-by-step guide for using the Invites API:
\nCreate and Send Invite
Set up a new Invite by specifying the Contact(s), Request items, and any additional details (e.g., deadlines, instructions) and dispatch the Invite to your Contacts.
Update an Invite
Modify an existing Invite to update details like due dates, or add more contacts to the Invite.
Adding Additional Request Items (Follow-Up)
Include new tasks or document requests in an already-sent Invite to keep the process flexible.
Retrieving Returned Files, Documents, or Signed Forms
Access the files, forms, or other items submitted by your Contacts through the Invite.
Archiving an Invite
Mark an Invite as completed and archive it for future reference or record-keeping.
Invite status transition can be used to build workflows on your end. Following are the different invite statuses and their description
\nIndicators are used visual indication of the progress of an Invite. Use the indicators to build a UI to display a view at an Invite level.
\n","_postman_id":"8f1b7f7a-e317-46ef-9f3f-4d8fd4ea07c3"},{"name":"Contacts","item":[],"id":"0fac8f29-67ac-4b3a-8599-d9eb35d7097c","description":"Contacts in FileInvite represent your customers, clients, or borrowers—the individuals who will interact with the Portal when an Invite is sent. Managing Contacts is a crucial first step before you can send Invites or collect documents.
\nIf you’re just starting out with FileInvite (welcome!), you’ll need to import your customer contact information into the system. Here’s how you can do it:
\nUsing the FileInvite UI
Export your contacts as a CSV file and upload them via the FileInvite user interface. Learn how to import contacts via the UI.
Using the API
Use the Import Contact endpoint to programmatically upload your contacts as a CSV or TXT file.
After importing your contacts, you can manage changes to ensure your contact list stays up to date.
\nFor Existing Contacts:
\nUpdate a Contact: Modify contact details as needed using the Update Contact endpoint.
\nDelete a Contact: Remove a contact from the system when they are no longer needed using the Delete Contact endpoint.
\nFor New Contacts:
\nWhen you need to work with your contact list, the following endpoints will help:
\nList Contacts: Retrieve a complete list of all contacts using the List Contact endpoint.
\nGet Contact: Fetch details for a specific contact using the Get Contact endpoint.
\nContact-related actions depend on user roles and permissions. Refer to this article for details on which roles can perform specific actions with Contacts.
\nNow that you’ve set up and managed your Contacts, you’re ready to:
\nCreate, send, and edit Invites to collect documents.
\nWebhooks allow you to receive real-time notifications when key events occur in FileInvite, eliminating the need to poll the API for updates. When a subscribed event is triggered, FileInvite sends an HTTP POST request with a JSON payload to your configured endpoint.
\nWhen a subscribed event is triggered in FileInvite, a POST request is automatically sent to the endpoint URL you provide. Each delivery includes a standard JSON envelope:
\n{\n \"event\": \"<event name>\",\n \"fired_at\": \"<ISO-8601 timestamp>\",\n \"data\": {}\n}\n\nevent — identifies what happened (e.g. contactCreated, requestCompleted)
\nfired_at — when the event occurred
\ndata — the full details of the affected resource
\nYour endpoint must return any 2xx response to confirm successful delivery. If FileInvite receives a non-2xx response or encounters a transport failure, it will retry delivery up to 3 times with backoff.
\nTo confirm a webhook delivery was sent by FileInvite, you can enable webhook signing. When active, FileInvite includes a signature header with each request—an HMAC-SHA256 hash computed from the timestamp, content-length, and raw request body. Validate this on your end to protect against spoofed requests.
\nKey Notes:
\nProcess webhook payloads asynchronously if your endpoint needs more time—acknowledge receipt immediately and handle the logic in the background.
\nEnsure your endpoint is publicly accessible and can receive POST requests.
\nNow that you're receiving real-time notifications via Webhooks, you're ready to:
\nDownload submitted documents as soon as a requestCompleted event fires.
\nArchive completed Invites to close the Portal once all submissions are in.
\nIf your customers didn’t receive the Invite email or need the link sent again, this endpoint allows you to resend the Invite email to them.
\nRequired Parameters:
Specify the Invite ID and the Contact ID (or IDs) for the customers you want to resend the Invite email to.
Optional Parameter:
Include an optional custom message to appear in the resent Invite email.
Webhook payload content type.
\n"},{"key":"timestamp","value":"1779965040","description":"Unix timestamp generated at delivery time.
\n"},{"key":"User-Agent","value":"FileInvite-Webhook/1.0","description":"FileInvite webhook delivery user agent.
\n"},{"key":"signature","value":"sha256=example-hmac-signature","description":"Only present when webhook signing is enabled.
\n"}],"body":{"mode":"raw","raw":"{\n \"event\": \"inviteDispatched\",\n \"fired_at\": \"2026-05-28T14:44:00+12:00\",\n \"data\": {\n \"invite\": {\n \"id\": \"b7d6b6e3-6f7d-4e1a-9d65-9ad4c2c6d671\",\n \"reference\": \"INV-2026-0001\",\n \"subject\": \"Home Loan Documents\",\n \"message\": \"Please complete the requested documents.\",\n \"url\": \"https://app.fileinvite.com/invites/b7d6b6e3-6f7d-4e1a-9d65-9ad4c2c6d671\",\n \"sent_at\": \"2026-05-28T14:44:00+12:00\",\n \"archived_at\": null,\n \"due_at\": \"2026-06-11T23:59:59+12:00\",\n \"status\": \"sent\",\n \"type\": \"standard\",\n \"indicator\": \"inProgress\",\n \"progression_percentage\": 25,\n \"almost_due_reminder\": true,\n \"ongoing_reminder\": false,\n \"ongoing_reminder_sent_at\": null,\n \"ongoing_reminder_stopped_at\": null,\n \"additional_data\": null,\n \"from_user\": {\n \"id\": \"7f6f7db5-26b7-4f5d-a9f6-f1af980d144e\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Smith\",\n \"email\": \"alex.smith@example.com\",\n \"avatar_url\": null,\n \"created_at\": \"2026-01-15T09:00:00+12:00\"\n },\n \"creator\": {\n \"id\": \"7f6f7db5-26b7-4f5d-a9f6-f1af980d144e\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Smith\",\n \"email\": \"alex.smith@example.com\",\n \"avatar_url\": null,\n \"created_at\": \"2026-01-15T09:00:00+12:00\"\n },\n \"sender\": null,\n \"assignee_user\": null,\n \"contact_groups\": [],\n \"contacts\": [\n {\n \"id\": \"6a732d73-6975-47de-9059-452d4a951cbb\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"company\": \"Example Lending\",\n \"position\": \"Applicant\",\n \"language\": \"en\",\n \"phone\": null,\n \"created_at\": \"2026-05-01T10:00:00+12:00\",\n \"completed_at\": null\n }\n ],\n \"team\": null,\n \"apryse\": null,\n \"general_access\": null,\n \"shareables\": [],\n \"created_at\": \"2026-05-28T14:30:00+12:00\",\n \"last_activity_at\": null,\n \"completed_at\": null,\n \"scheduled_at\": null,\n \"due_days_after\": null,\n \"rrule\": null,\n \"start_at\": null,\n \"next_scheduled_at\": null,\n \"last_sent_at\": null,\n \"recurring_status\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{webhook_receiver_url}}","description":"Sample outbound webhook delivery sent by FileInvite Gen2 to the configured customer webhook endpoint.
\nUse this request as documentation or to replay a representative webhook payload against your own receiver.
\nEvent: inviteDispatched
This event is fired when an invite is dispatched. The data.invite object follows InviteResource from the Laravel API.
Webhook payload content type.
\n"},{"key":"timestamp","value":"1779965040","description":"Unix timestamp generated at delivery time.
\n"},{"key":"User-Agent","value":"FileInvite-Webhook/1.0","description":"FileInvite webhook delivery user agent.
\n"},{"key":"signature","value":"sha256=example-hmac-signature","description":"Only present when webhook signing is enabled.
\n"}],"body":{"mode":"raw","raw":"{\n \"event\": \"integrationIllionFileUploaded\",\n \"fired_at\": \"2026-05-28T03:00:32+00:00\",\n \"data\": {\n \"request\": {\n \"id\": \"11111111-1111-4111-8111-111111111111\",\n \"title\": \"BS\",\n \"description\": null,\n \"type\": \"illion-bankstatement\",\n \"order\": 1,\n \"status\": \"progressing\",\n \"indicator\": \"progressing\",\n \"meta\": null,\n \"creator\": {\n \"id\": \"33333333-3333-4333-8333-333333333333\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Taylor\",\n \"email\": \"alex.taylor@example.com\",\n \"position\": null,\n \"avatar_url\": null,\n \"created_at\": \"2024-03-17T20:56:42+00:00\",\n \"role\": null,\n \"status\": null,\n \"last_login_at\": null\n },\n \"files\": [\n {\n \"id\": \"55555555-5555-4555-8555-555555555501\",\n \"original_name\": \"TL-jane_doe-transaction_account-bank_of_statements-456789-1779937226.pdf\",\n \"mime_type\": \"application/pdf\",\n \"size\": 38314,\n \"type\": \"illion_bankstatement\",\n \"data_retention_deleted_at\": null,\n \"created_at\": \"2026-05-28T03:00:31+00:00\",\n \"creator\": {\n \"id\": \"44444444-4444-4444-8444-444444444444\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"type\": \"contact\",\n \"avatar_url\": null\n }\n },\n {\n \"id\": \"55555555-5555-4555-8555-555555555507\",\n \"original_name\": \"bank_of_statements-9807-v2.csv\",\n \"mime_type\": \"text/csv\",\n \"size\": 54596,\n \"type\": \"illion_bankstatement\",\n \"data_retention_deleted_at\": null,\n \"created_at\": \"2026-05-28T03:00:31+00:00\",\n \"creator\": {\n \"id\": \"44444444-4444-4444-8444-444444444444\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"type\": \"contact\",\n \"avatar_url\": null\n }\n },\n {\n \"id\": \"55555555-5555-4555-8555-555555555508\",\n \"original_name\": \"V3--bank_of_statements-5102.html\",\n \"mime_type\": \"text/html\",\n \"size\": 1389485,\n \"type\": \"illion_bankstatement\",\n \"data_retention_deleted_at\": null,\n \"created_at\": \"2026-05-28T03:00:31+00:00\",\n \"creator\": {\n \"id\": \"44444444-4444-4444-8444-444444444444\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"type\": \"contact\",\n \"avatar_url\": null\n }\n },\n {\n \"id\": \"55555555-5555-4555-8555-555555555509\",\n \"original_name\": \"bank_of_statements-3642-v2.json\",\n \"mime_type\": \"application/json\",\n \"size\": 307090,\n \"type\": \"illion_bankstatement\",\n \"data_retention_deleted_at\": null,\n \"created_at\": \"2026-05-28T03:00:32+00:00\",\n \"creator\": {\n \"id\": \"44444444-4444-4444-8444-444444444444\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"type\": \"contact\",\n \"avatar_url\": null\n }\n }\n ],\n \"contacts\": [\n {\n \"id\": \"44444444-4444-4444-8444-444444444444\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"company\": null,\n \"position\": null,\n \"language\": null,\n \"phone\": null,\n \"status\": \"returned\",\n \"indicator\": \"awaitingReview\",\n \"created_at\": \"2025-06-02T22:35:25+00:00\",\n \"completed_at\": null\n }\n ],\n \"pdf_redactions\": [],\n \"revision_notes\": [],\n \"follow_up\": null,\n \"created_at\": \"2026-05-28T02:59:32+00:00\",\n \"follow_up_id\": null,\n \"request_group_id\": null,\n \"request_group\": null\n },\n \"invite\": {\n \"id\": \"22222222-2222-4222-8222-222222222222\",\n \"reference\": \"BS illion hook\",\n \"subject\": \"BS illion hook\",\n \"message\": \"Test
\",\n \"url\": \"https://preprod.fileinvite.info/invite-listing/22222222-2222-4222-8222-222222222222\",\n \"sent_at\": \"2026-05-28T02:59:56+00:00\",\n \"archived_at\": null,\n \"due_at\": null,\n \"status\": \"progressing\",\n \"type\": \"single\",\n \"indicator\": \"progressing\",\n \"progression_percentage\": 0,\n \"almost_due_reminder\": 0,\n \"ongoing_reminder\": 0,\n \"ongoing_reminder_sent_at\": null,\n \"ongoing_reminder_stopped_at\": null,\n \"additional_data\": null,\n \"from_user\": {\n \"id\": \"33333333-3333-4333-8333-333333333333\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Taylor\",\n \"email\": \"alex.taylor@example.com\",\n \"position\": null,\n \"avatar_url\": null,\n \"created_at\": \"2024-03-17T20:56:42+00:00\",\n \"role\": null,\n \"status\": null,\n \"last_login_at\": null\n },\n \"creator\": {\n \"id\": \"33333333-3333-4333-8333-333333333333\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Taylor\",\n \"email\": \"alex.taylor@example.com\",\n \"position\": null,\n \"avatar_url\": null,\n \"created_at\": \"2024-03-17T20:56:42+00:00\",\n \"role\": null,\n \"status\": null,\n \"last_login_at\": null\n },\n \"contacts\": [\n {\n \"id\": \"44444444-4444-4444-8444-444444444444\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"company\": null,\n \"position\": null,\n \"language\": null,\n \"created_at\": \"2025-06-02T22:35:25+00:00\",\n \"completed_at\": null\n }\n ],\n \"apryse\": false,\n \"general_access\": \"account\",\n \"created_at\": \"2026-05-28T02:59:31+00:00\",\n \"last_activity_at\": \"2026-05-28T03:00:26+00:00\",\n \"completed_at\": null,\n \"scheduled_at\": null,\n \"due_days_after\": null,\n \"rrule\": null,\n \"start_at\": null,\n \"next_scheduled_at\": null,\n \"last_sent_at\": null,\n \"recurring_status\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{webhook_receiver_url}}","description":"Sample outbound webhook delivery sent by FileInvite Gen2 to the configured customer webhook endpoint.
\nUse this request as documentation or to replay a representative webhook payload against your own receiver.
\nEvent: integrationIllionFileUploaded
This event is fired after Illion Bank Statements files are uploaded for an invite request. The data.request object follows RequestResource; data.invite is appended for invite-backed requests.
Anonymised captured manual testing payload from preprod on 2026-05-28. The sample body is intentionally close to the real outbound event, including multiple Illion-generated files and the invite appended by WebhookListener.
All user names, UUIDs, emails, and file-name person names are fake documentation values.
\n","urlObject":{"host":["{{webhook_receiver_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9ed93f7-326d-429e-a2ea-53835750b25c"},{"name":"Contact Created","id":"42488aa5-2f92-4f82-b163-4ac2b5512b51","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"Webhook payload content type.
\n"},{"key":"timestamp","value":"1779965040","description":"Unix timestamp generated at delivery time.
\n"},{"key":"User-Agent","value":"FileInvite-Webhook/1.0","description":"FileInvite webhook delivery user agent.
\n"},{"key":"signature","value":"sha256=example-hmac-signature","description":"Only present when webhook signing is enabled.
\n"}],"body":{"mode":"raw","raw":"{\n \"event\": \"contactCreated\",\n \"fired_at\": \"2026-05-28T14:44:00+12:00\",\n \"data\": {\n \"contact\": {\n \"id\": \"6a732d73-6975-47de-9059-452d4a951cbb\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"company\": \"Example Lending\",\n \"position\": \"Applicant\",\n \"language\": \"en\",\n \"phone\": {\n \"id\": \"3a8cdd1a-478d-491a-8c99-2dcb6b91c60a\",\n \"number\": \"211234567\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2026-05-01T10:00:00+12:00\",\n \"completed_at\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{webhook_receiver_url}}","description":"Sample outbound webhook delivery sent by FileInvite Gen2 to the configured customer webhook endpoint.
\nUse this request as documentation or to replay a representative webhook payload against your own receiver.
\nEvent: contactCreated
This event is fired when a contact is created. The data.contact object follows ContactResource.
Webhook payload content type.
\n"},{"key":"timestamp","value":"1779965040","description":"Unix timestamp generated at delivery time.
\n"},{"key":"User-Agent","value":"FileInvite-Webhook/1.0","description":"FileInvite webhook delivery user agent.
\n"},{"key":"signature","value":"sha256=example-hmac-signature","description":"Only present when webhook signing is enabled.
\n"}],"body":{"mode":"raw","raw":"{\n \"event\": \"contactUpdated\",\n \"fired_at\": \"2026-05-28T14:44:00+12:00\",\n \"data\": {\n \"contact\": {\n \"id\": \"6a732d73-6975-47de-9059-452d4a951cbb\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"company\": \"Example Finance\",\n \"position\": \"Co-borrower\",\n \"language\": \"en\",\n \"phone\": {\n \"id\": \"3a8cdd1a-478d-491a-8c99-2dcb6b91c60a\",\n \"number\": \"211234567\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2026-05-01T10:00:00+12:00\",\n \"completed_at\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{webhook_receiver_url}}","description":"Sample outbound webhook delivery sent by FileInvite Gen2 to the configured customer webhook endpoint.
\nUse this request as documentation or to replay a representative webhook payload against your own receiver.
\nEvent: contactUpdated
This event is fired when a contact is updated. The data.contact object contains the current contact values after the update.
Webhook payload content type.
\n"},{"key":"timestamp","value":"1779965040","description":"Unix timestamp generated at delivery time.
\n"},{"key":"User-Agent","value":"FileInvite-Webhook/1.0","description":"FileInvite webhook delivery user agent.
\n"},{"key":"signature","value":"sha256=example-hmac-signature","description":"Only present when webhook signing is enabled.
\n"}],"body":{"mode":"raw","raw":"{\n \"event\": \"contactDeleted\",\n \"fired_at\": \"2026-05-28T14:44:00+12:00\",\n \"data\": {\n \"contact\": {\n \"id\": \"6a732d73-6975-47de-9059-452d4a951cbb\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"company\": \"Example Lending\",\n \"position\": \"Applicant\",\n \"language\": \"en\",\n \"phone\": {\n \"id\": \"3a8cdd1a-478d-491a-8c99-2dcb6b91c60a\",\n \"number\": \"211234567\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2026-05-01T10:00:00+12:00\",\n \"completed_at\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{webhook_receiver_url}}","description":"Sample outbound webhook delivery sent by FileInvite Gen2 to the configured customer webhook endpoint.
\nUse this request as documentation or to replay a representative webhook payload against your own receiver.
\nEvent: contactDeleted
This event is fired when a contact is deleted. The data.contact object represents the contact resource available at deletion time.
Webhook payload content type.
\n"},{"key":"timestamp","value":"1779965040","description":"Unix timestamp generated at delivery time.
\n"},{"key":"User-Agent","value":"FileInvite-Webhook/1.0","description":"FileInvite webhook delivery user agent.
\n"},{"key":"signature","value":"sha256=example-hmac-signature","description":"Only present when webhook signing is enabled.
\n"}],"body":{"mode":"raw","raw":"{\n \"event\": \"requestCompleted\",\n \"fired_at\": \"2026-05-28T15:10:00+12:00\",\n \"data\": {\n \"request\": {\n \"id\": \"41df7089-33ad-48b3-a1bb-831f674f083e\",\n \"title\": \"Proof of income\",\n \"description\": \"Upload your latest payslip.\",\n \"type\": \"file\",\n \"order\": 2,\n \"status\": \"completed\",\n \"indicator\": \"completed\",\n \"meta\": null,\n \"creator\": {\n \"id\": \"7f6f7db5-26b7-4f5d-a9f6-f1af980d144e\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Smith\",\n \"email\": \"alex.smith@example.com\",\n \"avatar_url\": null,\n \"created_at\": \"2026-01-15T09:00:00+12:00\"\n },\n \"files\": [\n {\n \"id\": \"a4c8df95-cf57-4898-9651-363d389c8b07\",\n \"original_name\": \"latest-payslip.pdf\",\n \"mime_type\": \"application/pdf\",\n \"size\": 153428,\n \"type\": \"request\",\n \"data_retention_deleted_at\": null,\n \"url\": \"https://files.example.com/latest-payslip.pdf\",\n \"created_at\": \"2026-05-28T15:08:00+12:00\",\n \"parent_fileable_id\": null\n }\n ],\n \"contacts\": [\n {\n \"id\": \"6a732d73-6975-47de-9059-452d4a951cbb\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"company\": \"Example Lending\",\n \"position\": \"Applicant\",\n \"language\": \"en\",\n \"phone\": {\n \"id\": \"3a8cdd1a-478d-491a-8c99-2dcb6b91c60a\",\n \"number\": \"211234567\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2026-05-01T10:00:00+12:00\",\n \"completed_at\": \"2026-05-28T15:10:00+12:00\",\n \"status\": \"completed\",\n \"indicator\": \"completed\"\n }\n ],\n \"pdf_redactions\": [],\n \"revision_notes\": [],\n \"follow_up\": null,\n \"created_at\": \"2026-05-28T14:30:00+12:00\",\n \"follow_up_id\": null,\n \"request_group_id\": null,\n \"request_group\": null\n },\n \"invite\": {\n \"id\": \"b7d6b6e3-6f7d-4e1a-9d65-9ad4c2c6d671\",\n \"reference\": \"INV-2026-0001\",\n \"subject\": \"Home Loan Documents\",\n \"message\": \"Please complete the requested documents.\",\n \"url\": \"https://app.fileinvite.com/invites/b7d6b6e3-6f7d-4e1a-9d65-9ad4c2c6d671\",\n \"sent_at\": \"2026-05-28T14:44:00+12:00\",\n \"archived_at\": null,\n \"due_at\": \"2026-06-11T23:59:59+12:00\",\n \"status\": \"sent\",\n \"type\": \"standard\",\n \"indicator\": \"inProgress\",\n \"progression_percentage\": 50,\n \"contacts\": [\n {\n \"id\": \"6a732d73-6975-47de-9059-452d4a951cbb\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"company\": \"Example Lending\",\n \"position\": \"Applicant\",\n \"language\": \"en\",\n \"phone\": {\n \"id\": \"3a8cdd1a-478d-491a-8c99-2dcb6b91c60a\",\n \"number\": \"211234567\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2026-05-01T10:00:00+12:00\",\n \"completed_at\": null\n }\n ],\n \"created_at\": \"2026-05-28T14:30:00+12:00\",\n \"last_activity_at\": \"2026-05-28T15:10:00+12:00\",\n \"completed_at\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{webhook_receiver_url}}","description":"Sample outbound webhook delivery sent by FileInvite Gen2 to the configured customer webhook endpoint.
\nUse this request as documentation or to replay a representative webhook payload against your own receiver.
\nEvent: requestCompleted
This event is fired when an invite request is completed. The data.request object follows RequestResource; data.invite is appended for invite-backed requests.
Webhook payload content type.
\n"},{"key":"timestamp","value":"1779965040","description":"Unix timestamp generated at delivery time.
\n"},{"key":"User-Agent","value":"FileInvite-Webhook/1.0","description":"FileInvite webhook delivery user agent.
\n"},{"key":"signature","value":"sha256=example-hmac-signature","description":"Only present when webhook signing is enabled.
\n"}],"body":{"mode":"raw","raw":"{\n \"event\": \"requestStatusChanged\",\n \"fired_at\": \"2026-05-28T15:05:00+12:00\",\n \"data\": {\n \"request\": {\n \"id\": \"41df7089-33ad-48b3-a1bb-831f674f083e\",\n \"title\": \"Proof of income\",\n \"description\": \"Upload your latest payslip.\",\n \"type\": \"file\",\n \"order\": 2,\n \"status\": \"in_progress\",\n \"indicator\": \"inProgress\",\n \"meta\": null,\n \"creator\": {\n \"id\": \"7f6f7db5-26b7-4f5d-a9f6-f1af980d144e\",\n \"first_name\": \"Alex\",\n \"last_name\": \"Smith\",\n \"email\": \"alex.smith@example.com\",\n \"avatar_url\": null,\n \"created_at\": \"2026-01-15T09:00:00+12:00\"\n },\n \"files\": [],\n \"contacts\": [\n {\n \"id\": \"6a732d73-6975-47de-9059-452d4a951cbb\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"company\": \"Example Lending\",\n \"position\": \"Applicant\",\n \"language\": \"en\",\n \"phone\": {\n \"id\": \"3a8cdd1a-478d-491a-8c99-2dcb6b91c60a\",\n \"number\": \"211234567\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2026-05-01T10:00:00+12:00\",\n \"completed_at\": null,\n \"status\": \"in_progress\",\n \"indicator\": \"inProgress\"\n }\n ],\n \"pdf_redactions\": [],\n \"revision_notes\": [],\n \"follow_up\": null,\n \"created_at\": \"2026-05-28T14:30:00+12:00\",\n \"follow_up_id\": null,\n \"request_group_id\": null,\n \"request_group\": null\n },\n \"invite\": {\n \"id\": \"b7d6b6e3-6f7d-4e1a-9d65-9ad4c2c6d671\",\n \"reference\": \"INV-2026-0001\",\n \"subject\": \"Home Loan Documents\",\n \"message\": \"Please complete the requested documents.\",\n \"url\": \"https://app.fileinvite.com/invites/b7d6b6e3-6f7d-4e1a-9d65-9ad4c2c6d671\",\n \"sent_at\": \"2026-05-28T14:44:00+12:00\",\n \"archived_at\": null,\n \"due_at\": \"2026-06-11T23:59:59+12:00\",\n \"status\": \"sent\",\n \"type\": \"standard\",\n \"indicator\": \"inProgress\",\n \"progression_percentage\": 50,\n \"contacts\": [\n {\n \"id\": \"6a732d73-6975-47de-9059-452d4a951cbb\",\n \"first_name\": \"Jordan\",\n \"last_name\": \"Lee\",\n \"email\": \"jordan.lee@example.com\",\n \"company\": \"Example Lending\",\n \"position\": \"Applicant\",\n \"language\": \"en\",\n \"phone\": {\n \"id\": \"3a8cdd1a-478d-491a-8c99-2dcb6b91c60a\",\n \"number\": \"211234567\",\n \"country_number_code\": \"+64\",\n \"country_iso2_code\": \"NZ\"\n },\n \"created_at\": \"2026-05-01T10:00:00+12:00\",\n \"completed_at\": null\n }\n ],\n \"created_at\": \"2026-05-28T14:30:00+12:00\",\n \"last_activity_at\": \"2026-05-28T15:10:00+12:00\",\n \"completed_at\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{webhook_receiver_url}}","description":"Sample outbound webhook delivery sent by FileInvite Gen2 to the configured customer webhook endpoint.
\nUse this request as documentation or to replay a representative webhook payload against your own receiver.
\nEvent: requestStatusChanged
This event is fired when a request status changes. The data.request object follows RequestResource; data.invite is appended for invite-backed requests.