{"info":{"title":"Webhooks","description":"API for interacting with account assignment webhooks, document webhooks, job webhooks, loan application webhooks, loan milestone webhooks, loan officer webhooks, loan webhooks, milestone webhooks, organization webhooks, state license webhooks, subscriptions, user webhooks, verification webhooks, and webhooks in the nCino Mortgage system","version":"1.0","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"servers":[{"url":"https://api.ncinomortgage.com","description":"Production server"}],"security":[{"OAuth2":[]}],"openapi":"3.1.0","paths":{"/webhooks":{"get":{"tags":["Webhooks"],"operationId":"webhooks-index","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/CreatedAfter"},{"$ref":"#/components/parameters/CreatedBefore"},{"$ref":"#/components/parameters/UpdatedAfter"},{"$ref":"#/components/parameters/UpdatedBefore"},{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPagination"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"This endpoint will retrieve all <<glossary:webhook>> records.","summary":"Retrieve all webhook records"},"post":{"tags":["Webhooks"],"operationId":"webhooks-create","parameters":[{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"201":{"description":"Created webhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceCreated"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"409":{"description":"Webhook already exists for the given URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"This endpoint will create a new <<glossary:webhook>> record.","summary":"Create a new webhook record","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPostBody"}}}}}},"/webhooks/{webhook_id}":{"delete":{"tags":["Webhooks"],"operationId":"webhooks-destroy","parameters":[{"name":"webhook_id","description":"Webhook ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"204":{"description":"Deleted webhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoContent"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"This endpoint will delete a <<glossary:webhook>> record.","summary":"Delete a webhook record"},"get":{"tags":["Webhooks"],"operationId":"webhooks-show","parameters":[{"name":"webhook_id","description":"Webhook ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Webhook.Detail"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"This endpoint will retrieve a <<glossary:webhook>> record.","summary":"Retrieve a webhook record"},"patch":{"tags":["Webhooks"],"operationId":"webhooks-update","parameters":[{"name":"webhook_id","description":"Webhook ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"204":{"description":"Updated webhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoContent"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"This endpoint will update a <<glossary:webhook>> record.","summary":"Update a webhook record","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPatchBody"}}}}}},"/webhooks/{webhook_id}/actions":{"post":{"tags":["Webhooks"],"operationId":"webhooks-actions","parameters":[{"name":"webhook_id","description":"Webhook ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"201":{"description":"Created <<glossary:asynchronous job>> to process action","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceCreated"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"204":{"description":"No content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoContent"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"description":"Webhook already exists for the given URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"412":{"description":"Resource is in an invalid state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"> 📌 Available actions\n  **ENABLE** - Activate webhook\n  **DISABLE** - Deactivate webhook\n  **TEST** - Test webhook connection to URL\n  **CHANGE_URL** - Change URL for webhook","summary":"Perform action on a webhook","requestBody":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/WebhookAction"}],"discriminator":{"propertyName":"action","mapping":{"ENABLE":"#/components/schemas/WebhookAction","DISABLE":"#/components/schemas/WebhookAction","TEST":"#/components/schemas/WebhookAction","CHANGE_URL":"#/components/schemas/ChangeUrlAction"}}}}}}}},"/webhooks/{webhook_id}/subscriptions":{"get":{"tags":["Subscriptions"],"operationId":"subscriptions-index","parameters":[{"name":"webhook_id","description":"Webhook ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/CreatedAfter"},{"$ref":"#/components/parameters/CreatedBefore"},{"$ref":"#/components/parameters/UpdatedAfter"},{"$ref":"#/components/parameters/UpdatedBefore"},{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionPagination"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"This endpoint will retrieve all of a <<glossary:webhook>>'s subscription records.","summary":"Retrieve all of a webhook's subscription records"},"post":{"tags":["Subscriptions"],"operationId":"subscriptions-create","parameters":[{"name":"webhook_id","description":"Webhook ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"201":{"description":"Subscription created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceCreated"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"description":"Webhook is already subscribed to event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"Create a subscription for a <<glossary:webhook>>","summary":"Create a subscription for a webhook","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionSaveBody"}}}}}},"/webhooks/{webhook_id}/subscriptions/{webhook_subscription_id}":{"delete":{"tags":["Subscriptions"],"operationId":"subscriptions-destroy","parameters":[{"name":"webhook_id","description":"Webhook ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"name":"webhook_subscription_id","description":"Subscription ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"204":{"description":"Subscription removed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoContent"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"This endpoint will delete a <<glossary:webhook>>'s subscription record (i.e. unsubscribes a webhook from an event).","summary":"Delete a webhook's subscription record"},"get":{"tags":["Subscriptions"],"operationId":"subscriptions-show","parameters":[{"name":"webhook_id","description":"Webhook ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"name":"webhook_subscription_id","description":"Subscription ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"This endpoint will retrieve a <<glossary:webhook>>'s subscription record.","summary":"Retrieve a webhook's subscription record"},"patch":{"tags":["Subscriptions"],"operationId":"subscriptions-update","parameters":[{"name":"webhook_id","description":"Webhook ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"name":"webhook_subscription_id","description":"Subscription ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"204":{"description":"Subscription updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoContent"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"409":{"description":"Webhook is already subscribed to event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"This endpoint will update a <<glossary:webhook>>'s subscription record.","summary":"Update a webhook's subscription record","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscriptionSaveBody"}}}}}},"/webhooks/{webhook_id}/test_events":{"post":{"tags":["Webhooks"],"operationId":"webhooks-test_events","parameters":[{"name":"webhook_id","description":"Webhook ID.","required":true,"in":"path","schema":{"type":"string","format":"uuid"}},{"$ref":"#/components/parameters/ApiVersionHeader"}],"responses":{"200":{"description":"Successfully sent webhook request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookTestResponse"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"},"404":{"$ref":"#/components/responses/NotFoundError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"description":"Use this endpoint to test events being sent to your <<glossary:webhook>>.","summary":"Perform test event on a webhook","requestBody":{"description":"","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/JobStatusChangedTestEvent0"},{"$ref":"#/components/schemas/LoanAppStartedTestEvent0"},{"$ref":"#/components/schemas/LoanAppUpdatedTestEvent0"},{"$ref":"#/components/schemas/LoanAppSubmittedTestEvent0"},{"$ref":"#/components/schemas/LoanAppImportedTestEvent0"},{"$ref":"#/components/schemas/LoanAppAbandonedTestEvent0"},{"$ref":"#/components/schemas/DocumentUploadedTestEvent0"},{"$ref":"#/components/schemas/DocumentCreatedTestEvent0"},{"$ref":"#/components/schemas/DocumentUpdatedTestEvent0"},{"$ref":"#/components/schemas/LoanMilestoneUpdatedTestEvent0"},{"$ref":"#/components/schemas/LoanMilestoneCompletedTestEvent0"},{"$ref":"#/components/schemas/LoanCreatedTestEvent0"},{"$ref":"#/components/schemas/LoanUpdatedTestEvent0"},{"$ref":"#/components/schemas/LoanDeletedTestEvent0"},{"$ref":"#/components/schemas/LoanActivatedTestEvent0"},{"$ref":"#/components/schemas/LoanDeactivatedTestEvent0"},{"$ref":"#/components/schemas/MilestonesReorderedTestEvent0"},{"$ref":"#/components/schemas/MilestoneCreatedTestEvent0"},{"$ref":"#/components/schemas/MilestoneDeletedTestEvent0"},{"$ref":"#/components/schemas/OrganizationCreatedTestEvent0"},{"$ref":"#/components/schemas/OrganizationDeletedTestEvent0"},{"$ref":"#/components/schemas/StateLicenseCreatedTestEvent0"},{"$ref":"#/components/schemas/StateLicenseUpdatedTestEvent0"},{"$ref":"#/components/schemas/StateLicenseDeletedTestEvent0"},{"$ref":"#/components/schemas/AccountAssignmentCreatedTestEvent0"},{"$ref":"#/components/schemas/AccountAssignmentDeletedTestEvent0"},{"$ref":"#/components/schemas/LoanOfficerPromotedTestEvent0"},{"$ref":"#/components/schemas/LoanOfficerDemotedTestEvent0"},{"$ref":"#/components/schemas/UserCreatedTestEvent0"},{"$ref":"#/components/schemas/UserUpdatedTestEvent0"},{"$ref":"#/components/schemas/UserEnabledTestEvent0"},{"$ref":"#/components/schemas/UserDisabledTestEvent0"},{"$ref":"#/components/schemas/UserFirstLoginTestEvent0"},{"$ref":"#/components/schemas/UserDeletedTestEvent0"},{"$ref":"#/components/schemas/VerificationAvailableTestEvent0"}],"discriminator":{"propertyName":"event","mapping":{"job_status_changed":"#/components/schemas/JobStatusChangedTestEvent0","loan_app_started":"#/components/schemas/LoanAppStartedTestEvent0","loan_app_updated":"#/components/schemas/LoanAppUpdatedTestEvent0","loan_app_submitted":"#/components/schemas/LoanAppSubmittedTestEvent0","loan_app_imported":"#/components/schemas/LoanAppImportedTestEvent0","loan_app_abandoned":"#/components/schemas/LoanAppAbandonedTestEvent0","document_uploaded":"#/components/schemas/DocumentUploadedTestEvent0","document_created":"#/components/schemas/DocumentCreatedTestEvent0","document_updated":"#/components/schemas/DocumentUpdatedTestEvent0","loan_milestone_updated":"#/components/schemas/LoanMilestoneUpdatedTestEvent0","loan_milestone_completed":"#/components/schemas/LoanMilestoneCompletedTestEvent0","loan_created":"#/components/schemas/LoanCreatedTestEvent0","loan_updated":"#/components/schemas/LoanUpdatedTestEvent0","loan_deleted":"#/components/schemas/LoanDeletedTestEvent0","loan_activated":"#/components/schemas/LoanActivatedTestEvent0","loan_deactivated":"#/components/schemas/LoanDeactivatedTestEvent0","milestones_reordered":"#/components/schemas/MilestonesReorderedTestEvent0","milestone_created":"#/components/schemas/MilestoneCreatedTestEvent0","milestone_deleted":"#/components/schemas/MilestoneDeletedTestEvent0","organization_created":"#/components/schemas/OrganizationCreatedTestEvent0","organization_deleted":"#/components/schemas/OrganizationDeletedTestEvent0","state_license_created":"#/components/schemas/StateLicenseCreatedTestEvent0","state_license_updated":"#/components/schemas/StateLicenseUpdatedTestEvent0","state_license_deleted":"#/components/schemas/StateLicenseDeletedTestEvent0","account_assignment_created":"#/components/schemas/AccountAssignmentCreatedTestEvent0","account_assignment_deleted":"#/components/schemas/AccountAssignmentDeletedTestEvent0","loan_officer_promoted":"#/components/schemas/LoanOfficerPromotedTestEvent0","loan_officer_demoted":"#/components/schemas/LoanOfficerDemotedTestEvent0","user_created":"#/components/schemas/UserCreatedTestEvent0","user_updated":"#/components/schemas/UserUpdatedTestEvent0","user_enabled":"#/components/schemas/UserEnabledTestEvent0","user_disabled":"#/components/schemas/UserDisabledTestEvent0","user_first_login":"#/components/schemas/UserFirstLoginTestEvent0","user_deleted":"#/components/schemas/UserDeletedTestEvent0","verification_available":"#/components/schemas/VerificationAvailableTestEvent0"}}}}}}}}},"tags":[{"name":"Account Assignment Webhooks","description":"Webhook events pertaining to account assignment records"},{"name":"Authentication","description":"Authentication endpoints using OAuth 2.0"},{"name":"Authorization","description":"Authorization endpoints using OAuth 2.0"},{"name":"Automated Underwriting Findings","description":"Endpoints for <<glossary:Automated Underwriting System>> (AUS) findings for a <<glossary:loan>>."},{"name":"Borrower Task Reminders","description":"Endpoints pertaining to borrower task reminders"},{"name":"Borrowers","description":"Endpoints pertaining to <<glossary:borrower account>>s in the nCino Mortgage platform"},{"name":"Branch Images","description":"Endpoints pertaining to <<glossary:branch>> images"},{"name":"Branch Links","description":"Endpoints pertaining to <<glossary:branch>> links"},{"name":"Branch Reports","description":"Endpoints pertaining to <<glossary:branch>> reports"},{"name":"Branch State Licenses","description":"Endpoints pertaining to <<glossary:branch>> <<glossary:state license>>s"},{"name":"Companies","description":"Endpoints pertaining to <<glossary:company>> records"},{"name":"Company Images","description":"Endpoints pertaining to <<glossary:company>> images"},{"name":"Company Links","description":"Endpoints pertaining to <<glossary:company>> <<glossary:link>>s"},{"name":"Company Milestones","description":"Endpoints pertaining to company milestones"},{"name":"Company Regions","description":"Endpoints pertaining to <<glossary:company>> regions"},{"name":"Company Reports","description":"Endpoints pertaining to <<glossary:company>> reports"},{"name":"Company State License Templates","description":"Endpoints pertaining to company state license templates"},{"name":"Company State Licenses","description":"Endpoints pertaining to <<glossary:company>> state licenses"},{"name":"Custom Form Requests","description":"Endpoints pertaining to custom form requests (e.g. econsent, credit auth)"},{"name":"Developer Info","description":"Endpoints pertaining to developer info"},{"name":"Doc Package Orders","description":"Endpoints pertaining to doc package orders"},{"name":"Document Webhooks","description":"Webhook events pertaining to loan document changes"},{"name":"Inquiry Tasks","description":"Endpoints pertaining to inquiry <<glossary:task>>s"},{"name":"Job Webhooks","description":"Webhook events pertaining to jobs"},{"name":"Jobs","description":"Endpoints pertaining to jobs"},{"name":"Links","description":"Endpoints pertaining to links"},{"name":"Loan App Borrower Task Reminders","description":"Endpoints pertaining to borrower task reminders"},{"name":"Loan App Custom Form Requests","description":"Endpoints pertaining to custom form requests (e.g. econsent, credit auth)"},{"name":"Loan App Doc Tasks","description":"Endpoints pertaining to loan doc <<glossary:task>>s"},{"name":"Loan App Inquiry Tasks","description":"Endpoints pertaining to inquiry <<glossary:task>>s"},{"name":"Loan Application (Nested)","description":"Endpoints pertaining to a loan application in nested format."},{"name":"Loan Application (Nested) Assets","description":"Endpoints pertaining to a loan application's assets.\n\n> 🚧 Interim identifier scheme\n`_id` is an opaque string, stable only for the lifetime of the loan\napplication's current field ordering. A persisted, stable identifier is\nplanned as future work."},{"name":"Loan Application (Nested) Borrower Incomes","description":"Endpoints pertaining to a loan application's borrower's income sources.\n\n> 🚧 Interim identifier scheme\n`_id` is an opaque string, stable only for the lifetime of the loan\napplication's current field ordering. A persisted, stable identifier is\nplanned as future work."},{"name":"Loan Application (Nested) Co-borrower Incomes","description":"Endpoints pertaining to a loan application's co-borrower's income sources.\n\n> 🚧 Interim identifier scheme\n`_id` is an opaque string, stable only for the lifetime of the loan\napplication's current field ordering. A persisted, stable identifier is\nplanned as future work."},{"name":"Loan Application (Nested) Expenses","description":"Endpoints pertaining to a loan application's expenses.\n\n> 🚧 Interim identifier scheme\n`_id` is an opaque string, stable only for the lifetime of the loan\napplication's current field ordering. A persisted, stable identifier is\nplanned as future work."},{"name":"Loan Application (Nested) Liabilities","description":"Endpoints pertaining to a loan application's liabilities.\n\n> 🚧 Interim identifier scheme\n`_id` is an opaque string, stable only for the lifetime of the loan\napplication's current field ordering. A persisted, stable identifier is\nplanned as future work."},{"name":"Loan Application Borrowers","description":"Endpoints pertaining to loan application borrowers"},{"name":"Loan Application Webhooks","description":"Webhook events pertaining to loan applications"},{"name":"Loan Applications","description":"Endpoints pertaining to loan applications"},{"name":"Loan Borrower Verifications","description":"Endpoints pertaining to <<glossary:loan borrower>> <<glossary:verification>>s"},{"name":"Loan Borrowers","description":"Endpoints pertaining to <<glossary:loan borrower>>s"},{"name":"Loan Doc Tasks","description":"Endpoints pertaining to loan doc <<glossary:task>>s"},{"name":"Loan Documents","description":"Endpoints for retrieving documents uploaded to a loan."},{"name":"Loan Milestone Webhooks","description":"Webhook events pertaining to loan milestone status changes"},{"name":"Loan Milestones","description":"Endpoints pertaining to loan milestone instances on a specific loan.\nThese represent the completion status of milestones, not milestone definitions."},{"name":"Loan Officer Aliases","description":"Endpoints pertaining to <<glossary:loan officer>> <<glossary:alias>>es"},{"name":"Loan Officer App Shares","description":"Endpoints pertaining to sharing a <<glossary:loan officer>>'s app link"},{"name":"Loan Officer Assignments","description":"Endpoints pertaining to <<glossary:loan officer>> <<glossary:assignment>>s"},{"name":"Loan Officer Images","description":"Endpoints pertaining to <<glossary:loan officer>> images"},{"name":"Loan Officer Links","description":"Endpoints pertaining to <<glossary:loan officer>> links"},{"name":"Loan Officer Loan Doc Tasks","description":"Endpoints pertaining to loan doc <<glossary:task>>s aggregated at the <<glossary:loan officer>> level"},{"name":"Loan Officer Partners","description":"Endpoints pertaining to a <<glossary:loan officer>>s' <<glossary:partner>>s"},{"name":"Loan Officer Prospects","description":"Endpoints pertaining to <<glossary:loan officer>> prospects"},{"name":"Loan Officer State Licenses","description":"Endpoints pertaining to <<glossary:loan officer>> <<glossary:state license>>s"},{"name":"Loan Officer Webhooks","description":"Webhook events pertaining to <<glossary:loan officer>>s"},{"name":"Loan Officers","description":"Endpoints pertaining to <<glossary:loan officer>>s"},{"name":"Loan Webhooks","description":"Webhook events pertaining to loans"},{"name":"Loans","description":"Endpoints for loans"},{"name":"Milestone Webhooks","description":"Webhook events pertaining to milestone records"},{"name":"Organization Webhooks","description":"Webhook events pertaining to organization records (i.e. companies, regions, and branches)"},{"name":"Partner Images","description":"Endpoints pertaining to partners"},{"name":"Partner Links","description":"Endpoints pertaining to partner links"},{"name":"Permissions","description":"Endpoints pertaining to permissions"},{"name":"Readme","description":"Endpoints pertaining to Readme"},{"name":"Region Branches","description":"Endpoints pertaining to a region's <<glossary:branch>>es"},{"name":"Region Images","description":"Endpoints pertaining to region images"},{"name":"Region Links","description":"Endpoints pertaining to region links"},{"name":"Region Reports","description":"Endpoints pertaining to region reports"},{"name":"Region State Licenses","description":"Endpoints pertaining to region state licenses"},{"name":"Role Permissions","description":"Endpoints for managing the <<glossary:permission>>s assigned to a\n<<glossary:role>>.\n\nPermissions are identified by their string *key* (e.g. `manage_roles`).\nRequests are scoped to the authenticated token's company: a role that\ndoes not exist, or is owned by another company, returns a 404."},{"name":"Role Users","description":"Endpoints for managing user assignments on a <<glossary:role>>."},{"name":"Roles","description":"Endpoints pertaining to <<glossary:role>>s"},{"name":"State License Webhooks","description":"Webhook events pertaining to state license records"},{"name":"State Licenses","description":"Endpoints pertaining to <<glossary:State license>>s"},{"name":"Subscriptions","description":"Endpoints pertaining to webhook subscriptions"},{"name":"Team Member Assignments","description":"Endpoints pertaining to team member assignments"},{"name":"Team Member Images","description":"Endpoints pertaining to team member images"},{"name":"Team Members","description":"Endpoints pertaining to team members"},{"name":"User Permissions","description":"Endpoints for querying a user's effective permissions, resolved across\nall of their assigned roles."},{"name":"User Roles","description":"Endpoints for inspecting role assignments on a user."},{"name":"User Webhooks","description":"Webhook events pertaining to user records"},{"name":"Verification Webhooks","description":"Webhook events pertaining to verification report records"},{"name":"Verifications","description":"Endpoints pertaining to <<glossary:verification>>s"},{"name":"Webhooks","description":"Endpoints pertaining to webhooks"}],"components":{"parameters":{"Page":{"name":"page","description":"The page to retrieve.","required":false,"in":"query","schema":{"type":"integer"}},"PageSize":{"name":"page_size","description":"The number of records returned in each page.","required":false,"in":"query","schema":{"type":"integer"}},"CreatedAfter":{"name":"created_after","description":"The date which a resource must be created after to be returned.","required":false,"in":"query","schema":{"type":"string","format":"date-time"}},"CreatedBefore":{"name":"created_before","description":"The date which a resource must be created before to be returned.","required":false,"in":"query","schema":{"type":"string","format":"date-time"}},"UpdatedAfter":{"name":"updated_after","description":"The date which a resource must be updated after to be returned.","required":false,"in":"query","schema":{"type":"string","format":"date-time"}},"UpdatedBefore":{"name":"updated_before","description":"The date which a resource must be updated before to be returned.","required":false,"in":"query","schema":{"type":"string","format":"date-time"}},"ApiVersionHeader":{"name":"X-Api-Version","description":"Specify API version, for example '1.0'. By default, the version configured in the company settings is used.","required":false,"in":"header","schema":{"type":"string"}}},"responses":{"BadRequestError":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"UnauthorizedError":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"ForbiddenError":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"NotFoundError":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"InternalServerError":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"NotImplementedError":{"description":"Not implemented error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorSet"}}},"headers":{"X-Api-Version":{"$ref":"#/components/headers/ApiVersionResponseHeader"},"X-Api-Supported-Versions":{"$ref":"#/components/headers/ApiSupportedVersionsResponseHeader"}}},"WebhookResponse":{"description":"Return a 200 status to indicate that the data was received successfully","content":{}}},"headers":{"ContentDispositionResponseHeader":{"description":"Additional information about response payload.","schema":{"type":"string"}},"ApiVersionResponseHeader":{"description":"API version.","schema":{"type":"string"}},"ApiSupportedVersionsResponseHeader":{"description":"API supported versions for endpoint.","schema":{"type":"string"}},"LocationResponseHeader":{"description":"URL to redirect.","schema":{"type":"string"}}},"schemas":{"Error":{"type":"object","properties":{"id":{"type":"string","description":"A unique ID (useful as a reference when debugging an error with support)"},"status":{"type":"integer","description":"The HTTP status code"},"title":{"type":"string","description":"A generic title"},"detail":{"type":"string","description":"A detailed message"},"_links":{"type":"object","description":"A list of relevant links"}},"required":["id","status","title"],"example":{"id":"123abc","status":400,"title":"Generic title for the error","detail":"Detailed message for the error","_links":{"resource":"contextual resource if applicable"}}},"ErrorSet":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}},"required":["errors"],"example":{"errors":[{"id":"123abc","status":400,"title":"Generic title for the error","detail":"Detailed message for the error","_links":{"resource":"contextual resource if applicable"}}]}},"AbstractCollection":{"allOf":[{"$ref":"#/components/schemas/AbstractModel"},{"type":"object","properties":{"contents":{"type":"array","items":{"type":"object"},"description":"The contents for the collection."}},"required":["contents"],"additionalProperties":false}]},"AbstractModel":{"type":"object","properties":{"_self":{"type":"string","description":"The model's resource link to itself."},"_type":{"type":"string","description":"The model's type."},"_links":{"type":"object","description":"A list of links for the model's associations."}},"required":["_self","_type"],"additionalProperties":false},"AbstractPagination":{"allOf":[{"$ref":"#/components/schemas/AbstractCollection"},{"type":"object","properties":{"total_pages":{"type":"integer","description":"The total number of pages in the collection."},"total":{"type":"integer","description":"The total number of items in the collection."}},"additionalProperties":false}]},"AbstractResourceModel":{"allOf":[{"$ref":"#/components/schemas/AbstractModel"},{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the record."}},"required":["id"],"additionalProperties":false}]},"NoContent":{"type":"object","properties":{},"additionalProperties":false},"ResourceCreated":{"allOf":[{"$ref":"#/components/schemas/AbstractResourceModel"}],"description":"Resource created model"},"Webhook":{"allOf":[{"$ref":"#/components/schemas/AbstractResourceModel"},{"type":"object","properties":{"name":{"type":"string","description":"Webhook's name."},"url":{"type":"string","format":"http_uri","description":"URL called when a webhook event has occurred."},"version":{"type":"string","description":"API version to be used when webhook request is rendered.","nullable":true},"created_at":{"type":"string","format":"date-time","description":"Webhook's created at timestamp.","nullable":true}},"additionalProperties":false}],"description":"Webhook record"},"WebhookPagination":{"allOf":[{"$ref":"#/components/schemas/AbstractPagination"},{"type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}}},"required":["contents"]}]},"WebhookPostBody":{"type":"object","properties":{"url":{"type":"string","format":"http_uri","description":"Webhook's callback URL."},"name":{"type":"string","description":"Webhook's name."},"version":{"type":"string","description":"API version to be used when webhook request is rendered.","nullable":true}},"required":["url","name"],"description":"Available properties for creating a webhook.","additionalProperties":false},"WebhookPatchBody":{"type":"object","properties":{"name":{"type":"string","description":"Webhook's name."},"version":{"type":"string","description":"API version to be used when webhook request is rendered.","nullable":true}},"description":"Available properties for updating a webhook.","additionalProperties":false,"minProperties":1},"WebhookAction":{"type":"object","properties":{"action":{"type":"string","enum":["ENABLE","DISABLE","TEST","CHANGE_URL"],"description":"Action to perform."}},"required":["action"],"description":"Available properties for a webhook action. Validation requests are performed against the URL when enabling.","additionalProperties":false},"ChangeUrlAction":{"allOf":[{"$ref":"#/components/schemas/WebhookAction"},{"type":"object","properties":{"url":{"type":"string","format":"http_uri","description":"Webhook's new callback URL."}},"required":["url"],"additionalProperties":false}],"description":"Available properties for the change webhook URL action. Validation requests are performed against the new URL if the webhook is enabled."},"WebhookSubscription":{"allOf":[{"$ref":"#/components/schemas/AbstractResourceModel"},{"type":"object","properties":{"event":{"allOf":[{"$ref":"#/components/schemas/WebhookEventName"}],"description":"Event that the webhook is subscribed to."}},"required":["event"],"additionalProperties":false}],"description":"Webhook subscription record"},"WebhookSubscriptionPagination":{"allOf":[{"$ref":"#/components/schemas/AbstractPagination"},{"type":"object","properties":{"contents":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscription"}}},"required":["contents"]}]},"WebhookSubscriptionSaveBody":{"type":"object","properties":{"event":{"allOf":[{"$ref":"#/components/schemas/WebhookEventName"}],"description":"Event being subscribed to."}},"required":["event"],"description":"Available properties for creating or updating a webhook's subscription.","additionalProperties":false,"minProperties":1},"WebhookTestResponse":{"allOf":[{"$ref":"#/components/schemas/AbstractModel"},{"type":"object","properties":{"code":{"type":"integer","description":"Webhook response's status code."},"body":{"type":"string","description":"Webhook response's body."}},"required":["code","body"],"additionalProperties":false}],"description":"Webhook test response"},"JobStatusChangedEventInfo":{"type":"object","properties":{"job_type":{"allOf":[{"$ref":"#/components/schemas/JobType"}],"description":"Type of job that was changed."},"job_description":{"type":"string","description":"Job's description.","nullable":true},"from_status":{"allOf":[{"$ref":"#/components/schemas/NullableJobStatus"}],"description":"Job's status prior to the change. If the job was just created, this will be nil."},"to_status":{"allOf":[{"$ref":"#/components/schemas/JobStatus"}],"description":"Job's status after the change."},"changed_at":{"type":"string","format":"date-time","description":"When the job's status changed."}},"description":"The event info particular to the job_status_changed event."},"LoanApplicationEventInfo":{"type":"object","properties":{"borrower_name":{"type":"string","description":"Borrower name."}},"description":"The event info particular to the loan application webhook group events."},"DocumentUploadedEventInfo":{"type":"object","properties":{"document_name":{"type":"string","description":"Name of the uploaded document."},"doc_type":{"type":"string","description":"Document type classification.","nullable":true},"task_name":{"type":"string","description":"Name of the associated task.","nullable":true},"loan_number":{"type":"string","description":"Loan number.","nullable":true},"uploaded_by":{"type":"string","description":"Who uploaded the document (borrower or servicer)."}},"required":["document_name","uploaded_by"],"description":"The event info for the document_uploaded event."},"DocumentCreatedEventInfo":{"type":"object","properties":{"document_name":{"type":"string","description":"Name of the created document."},"doc_type":{"type":"string","description":"Document type classification.","nullable":true},"task_name":{"type":"string","description":"Name of the associated task.","nullable":true},"loan_number":{"type":"string","description":"Loan number.","nullable":true}},"required":["document_name"],"description":"The event info for the document_created event."},"DocumentUpdatedEventInfo":{"type":"object","properties":{"document_name":{"type":"string","description":"Name of the updated document."},"doc_type":{"type":"string","description":"Document type classification.","nullable":true},"task_name":{"type":"string","description":"Name of the associated task.","nullable":true},"loan_number":{"type":"string","description":"Loan number.","nullable":true}},"required":["document_name"],"description":"The event info for the document_updated event."},"LoanMilestoneUpdatedEventInfo":{"type":"object","properties":{"milestone_name":{"type":"string","description":"Name of the milestone."},"status":{"type":"string","description":"Current status of the milestone."},"loan_number":{"type":"string","description":"Loan number."}},"required":["milestone_name","status","loan_number"],"description":"The event info for the loan_milestone_updated event."},"LoanMilestoneCompletedEventInfo":{"type":"object","properties":{"milestone_name":{"type":"string","description":"Name of the milestone."},"loan_number":{"type":"string","description":"Loan number."}},"required":["milestone_name","loan_number"],"description":"The event info for the loan_milestone_completed event."},"LoanEventInfo":{"type":"object","properties":{"loan_number":{"type":"string","description":"Loan number."}},"required":["loan_number"],"description":"The event info particular to the loan webhook group events."},"MilestonesReorderedEventInfo":{"type":"object","properties":{"name":{"type":"string","description":"Name of the organization."}},"required":["name"],"description":"The event info particular to the milestones_reordered event."},"MilestoneCreatedEventInfo":{"type":"object","properties":{"name":{"type":"string","description":"Name of the milestone."}},"required":["name"],"description":"The event info particular to the milestone_created event."},"MilestoneDeletedEventInfo":{"type":"object","properties":{"name":{"type":"string","description":"Name of the organization."}},"required":["name"],"description":"The event info particular to the milestone_deleted event."},"OrganizationCreatedEventInfo":{"type":"object","properties":{"org_type":{"type":"string","enum":["REGION","BRANCH"],"description":"Type of organization (REGION or BRANCH)."},"name":{"type":"string","description":"Name of the organization created."}},"required":["org_type","name"],"description":"The event info particular to the organization_created event."},"OrganizationDeletedEventInfo":{"type":"object","properties":{"org_type":{"type":"string","enum":["REGION","BRANCH"],"description":"Type of organization (REGION or BRANCH)."},"name":{"type":"string","description":"Name of the organization deleted."}},"required":["org_type","name"],"description":"The event info particular to the organization_deleted event"},"StateLicenseEventInfo":{"type":"object","properties":{"state":{"oneOf":[{"$ref":"#/components/schemas/StateCode"},{"$ref":"#/components/schemas/NationwideCode"}],"description":"State license's state."}},"required":["state"],"description":"The event info particular to the state license events."},"AccountAssignmentEventInfo":{"type":"object","properties":{"assignee_type":{"type":"string","description":"Type of the account that owns the assignment."},"assignee_name":{"type":"string","description":"Name of the account that owns the assignment."},"assignor_type":{"type":"string","description":"Type of entity the relevant account has access to."},"assignor_name":{"type":"string","description":"Name of the entity the relevant account has access to."}},"required":["assignee_type","assignee_name","assignor_type","assignor_name"],"description":"The event info particular to the account assignment events."},"LoanOfficerAdminChangeEventInfo":{"type":"object","properties":{"admin_type":{"type":"string","enum":["COMPANY_ADMIN","REGION_ADMIN","BRANCH_ADMIN"],"description":"Type of admin to which the loan officer was promoted or from which the loan officer was demoted."},"name":{"type":"string","description":"Name of the loan officer."}},"required":["admin_type","name"],"description":"The event info particular to the loan_officer_promoted and loan_officer_demoted events."},"UserEventInfo":{"type":"object","properties":{"name":{"type":"string","description":"Name of user."},"user_type":{"type":"string","enum":["USER_BORROWER","COMPANY_ADMIN","REGION_ADMIN","BRANCH_ADMIN","LOAN_OFFICER","TEAM_MEMBER","PARTNER"],"description":"Type of user."}},"description":"The event info shared between user events."},"UserCreatedEventInfo":{"allOf":[{"$ref":"#/components/schemas/UserEventInfo"},{"type":"object","properties":{"user_borrower":{"type":"string","description":"Borrower's name."}}}],"description":"The event info particular to the user_created event."},"UserUpdatedEventInfo":{"allOf":[{"$ref":"#/components/schemas/UserEventInfo"}],"description":"The event info particular to the user_updated event."},"UserEnabledEventInfo":{"allOf":[{"$ref":"#/components/schemas/UserEventInfo"}],"description":"The event info particular to the user_enabled event."},"UserDisabledEventInfo":{"allOf":[{"$ref":"#/components/schemas/UserEventInfo"}],"description":"The event info particular to the user_disabled event."},"UserDeletedEventInfo":{"allOf":[{"$ref":"#/components/schemas/UserEventInfo"}],"description":"The event info particular to the user_deleted event."},"UserFirstLoginEventInfo":{"allOf":[{"$ref":"#/components/schemas/UserEventInfo"}],"description":"The event info particular to the user_first_login event."},"VerificationAvailableEventInfo":{"type":"object","properties":{"report_type":{"allOf":[{"$ref":"#/components/schemas/VerificationReportType"}],"description":"Type of the report that is available."}},"required":["report_type"],"description":"The event info particular to the verification_complete event."},"StateCode":{"type":"string","enum":["AA","AE","AK","AL","AP","AR","AS","AZ","CA","CO","CT","DC","DE","FL","FM","GA","GU","HI","IA","ID","IL","IN","KS","KY","LA","MA","MD","ME","MH","MI","MN","MO","MP","MS","MT","NC","ND","NE","NH","NJ","NM","NV","NY","OH","OK","OR","PA","PR","PW","RI","SC","SD","TN","TX","UT","VA","VI","VT","WA","WI","WV","WY"],"description":"State abbreviated code."},"NationwideCode":{"type":"string","enum":["US"],"description":"Nationwide code."},"VerificationReportType":{"type":"string","enum":["BOTH","DOC_VOI_MORTGAGE","DVOE","VOA","VOAI","VOA_HISTORY","VOE","VOE_MORTGAGE","VOE_PAYROLL","VOE_TRANSACTIONS","VOI","VOIE","VOIE_MORTGAGE","VOIE_PAYROLL","VOIE_TX_VERIFY"],"description":"Types of verification reports."},"JobType":{"type":"string","enum":["SYNC_LOAN_APPS","VALIDATE_WEBHOOK_URL","GENERATE_ORGANIZATION_REPORT","DELETE_REGION_BRANCH","ORDER_VERIFICATION_REPORT","REFRESH_VERIFICATION_REPORTS","DISCONNECT_BORROWER","SEND_VERIFICATION_REMINDER","DELETE_LOAN","REASSIGN_BORROWERS_PARTNERS_LOAN_APPS"]},"JobStatus":{"type":"string","enum":["QUEUED","STARTED","QUEUED_FOR_RETRY","COMPLETED","FAILED"]},"NullableJobStatus":{"type":"string","enum":["QUEUED","STARTED","QUEUED_FOR_RETRY","COMPLETED","FAILED",null],"nullable":true},"WebhookEventName":{"type":"string","enum":["account_assignment_created","account_assignment_deleted","document_created","document_updated","document_uploaded","job_status_changed","loan_activated","loan_app_abandoned","loan_app_imported","loan_app_started","loan_app_submitted","loan_app_updated","loan_created","loan_deactivated","loan_deleted","loan_milestone_completed","loan_milestone_updated","loan_officer_demoted","loan_officer_promoted","loan_updated","milestone_created","milestone_deleted","milestones_reordered","organization_created","organization_deleted","state_license_created","state_license_deleted","state_license_updated","user_created","user_deleted","user_disabled","user_enabled","user_first_login","user_updated","verification_available"],"description":"Webhook event name."},"Webhook.Detail":{"allOf":[{"$ref":"#/components/schemas/Webhook"},{"type":"object","properties":{"secret":{"type":"string","description":"Secret used to verify a request made to the webhook URL is from a valid source (nCino Mortgage)."}}}],"description":"Webhook record (Detail)"},"JobStatusChangedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"job":{"type":"string"}},"required":["job"],"example":{"job":"/fake/path/to/job"}},"event":{"type":"string","enum":["job_status_changed"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/JobStatusChangedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanAppStartedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan_application":{"type":"string"}},"required":["loan_application"],"example":{"loan_application":"/fake/path/to/loan_application"}},"event":{"type":"string","enum":["loan_app_started"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanApplicationEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanAppUpdatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan_application":{"type":"string"}},"required":["loan_application"],"example":{"loan_application":"/fake/path/to/loan_application"}},"event":{"type":"string","enum":["loan_app_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanApplicationEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanAppSubmittedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan_application":{"type":"string"}},"required":["loan_application"],"example":{"loan_application":"/fake/path/to/loan_application"}},"event":{"type":"string","enum":["loan_app_submitted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanApplicationEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanAppImportedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan_application":{"type":"string"}},"required":["loan_application"],"example":{"loan_application":"/fake/path/to/loan_application"}},"event":{"type":"string","enum":["loan_app_imported"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanApplicationEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanAppAbandonedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan_application":{"type":"string"}},"required":["loan_application"],"example":{"loan_application":"/fake/path/to/loan_application"}},"event":{"type":"string","enum":["loan_app_abandoned"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanApplicationEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"DocumentUploadedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan":{"type":"string"}},"required":["loan"],"example":{"loan":"/fake/path/to/loan"}},"event":{"type":"string","enum":["document_uploaded"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/DocumentUploadedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"DocumentCreatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan":{"type":"string"}},"required":["loan"],"example":{"loan":"/fake/path/to/loan"}},"event":{"type":"string","enum":["document_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/DocumentCreatedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"DocumentUpdatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan":{"type":"string"}},"required":["loan"],"example":{"loan":"/fake/path/to/loan"}},"event":{"type":"string","enum":["document_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/DocumentUpdatedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanMilestoneUpdatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan_milestone":{"type":"string"}},"required":["loan_milestone"],"example":{"loan_milestone":"/fake/path/to/loan_milestone"}},"event":{"type":"string","enum":["loan_milestone_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanMilestoneUpdatedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanMilestoneCompletedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan_milestone":{"type":"string"}},"required":["loan_milestone"],"example":{"loan_milestone":"/fake/path/to/loan_milestone"}},"event":{"type":"string","enum":["loan_milestone_completed"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanMilestoneCompletedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanCreatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan":{"type":"string"}},"required":["loan"],"example":{"loan":"/fake/path/to/loan"}},"event":{"type":"string","enum":["loan_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanUpdatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan":{"type":"string"}},"required":["loan"],"example":{"loan":"/fake/path/to/loan"}},"event":{"type":"string","enum":["loan_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanDeletedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loans":{"type":"string"}},"required":["loans"],"example":{"loans":"/fake/path/to/loans"}},"event":{"type":"string","enum":["loan_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanActivatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan":{"type":"string"}},"required":["loan"],"example":{"loan":"/fake/path/to/loan"}},"event":{"type":"string","enum":["loan_activated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanDeactivatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan":{"type":"string"}},"required":["loan"],"example":{"loan":"/fake/path/to/loan"}},"event":{"type":"string","enum":["loan_deactivated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"MilestonesReorderedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"milestones":{"type":"string"}},"required":["milestones"],"example":{"milestones":"/fake/path/to/milestones"}},"event":{"type":"string","enum":["milestones_reordered"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/MilestonesReorderedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"MilestoneCreatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"milestone":{"type":"string"}},"required":["milestone"],"example":{"milestone":"/fake/path/to/milestone"}},"event":{"type":"string","enum":["milestone_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/MilestoneCreatedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"MilestoneDeletedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"milestones":{"type":"string"}},"required":["milestones"],"example":{"milestones":"/fake/path/to/milestones"}},"event":{"type":"string","enum":["milestone_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/MilestoneDeletedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"OrganizationCreatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"organization":{"type":"string"}},"required":["organization"],"example":{"organization":"/fake/path/to/organization"}},"event":{"type":"string","enum":["organization_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/OrganizationCreatedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"OrganizationDeletedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"parent_organization":{"type":"string"}},"required":["parent_organization"],"example":{"parent_organization":"/fake/path/to/parent_organization"}},"event":{"type":"string","enum":["organization_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/OrganizationDeletedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"StateLicenseCreatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"state_license":{"type":"string"}},"required":["state_license"],"example":{"state_license":"/fake/path/to/state_license"}},"event":{"type":"string","enum":["state_license_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/StateLicenseEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"StateLicenseUpdatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"state_license":{"type":"string"}},"required":["state_license"],"example":{"state_license":"/fake/path/to/state_license"}},"event":{"type":"string","enum":["state_license_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/StateLicenseEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"StateLicenseDeletedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"state_licenses":{"type":"string"}},"required":["state_licenses"],"example":{"state_licenses":"/fake/path/to/state_licenses"}},"event":{"type":"string","enum":["state_license_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/StateLicenseEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"AccountAssignmentCreatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"assignment":{"type":"string"}},"required":["assignment"],"example":{"assignment":"/fake/path/to/assignment"}},"event":{"type":"string","enum":["account_assignment_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/AccountAssignmentEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"AccountAssignmentDeletedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"assignments":{"type":"string"}},"required":["assignments"],"example":{"assignments":"/fake/path/to/assignments"}},"event":{"type":"string","enum":["account_assignment_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/AccountAssignmentEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanOfficerPromotedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan_officer":{"type":"string"}},"required":["loan_officer"],"example":{"loan_officer":"/fake/path/to/loan_officer"}},"event":{"type":"string","enum":["loan_officer_promoted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanOfficerAdminChangeEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"LoanOfficerDemotedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan_officer":{"type":"string"}},"required":["loan_officer"],"example":{"loan_officer":"/fake/path/to/loan_officer"}},"event":{"type":"string","enum":["loan_officer_demoted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanOfficerAdminChangeEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"UserCreatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"user":{"type":"string"}},"required":["user"],"example":{"user":"/fake/path/to/user"}},"event":{"type":"string","enum":["user_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserCreatedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"UserUpdatedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"user":{"type":"string"}},"required":["user"],"example":{"user":"/fake/path/to/user"}},"event":{"type":"string","enum":["user_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserUpdatedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"UserEnabledWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"user":{"type":"string"}},"required":["user"],"example":{"user":"/fake/path/to/user"}},"event":{"type":"string","enum":["user_enabled"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserEnabledEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"UserDisabledWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"user":{"type":"string"}},"required":["user"],"example":{"user":"/fake/path/to/user"}},"event":{"type":"string","enum":["user_disabled"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserDisabledEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"UserFirstLoginWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"user":{"type":"string"}},"required":["user"],"example":{"user":"/fake/path/to/user"}},"event":{"type":"string","enum":["user_first_login"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserFirstLoginEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"UserDeletedWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"loan_officer":{"type":"string"}},"required":["loan_officer"],"example":{"loan_officer":"/fake/path/to/loan_officer"}},"event":{"type":"string","enum":["user_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserDeletedEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"VerificationAvailableWebhookRequestBody0":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"_links":{"type":"object","properties":{"verification":{"type":"string"}},"required":["verification"],"example":{"verification":"/fake/path/to/verification"}},"event":{"type":"string","enum":["verification_available"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/VerificationAvailableEventInfo"}]}},"required":["_links","event","event_info"],"additionalProperties":false}]},"BaseWebhookRequestBody":{"type":"object","properties":{"_id":{"type":"string","format":"uuid","description":"Unique identifier for the webhook event.","example":"00000000-0000-0000-0000-000000000000"},"_timestamp":{"type":"string","format":"date-time","description":"Timestamp for when the webhook event was triggered.","example":"1989-08-23T00:00:00+00:00"}},"required":["_id","_timestamp"],"additionalProperties":false},"WebhookRequestEvent":{"type":"object","properties":{},"discriminator":{"propertyName":"event","mapping":{"job_status_changed":"#/components/schemas/JobStatusChangedWebhookRequestBody0","loan_app_started":"#/components/schemas/LoanAppStartedWebhookRequestBody0","loan_app_updated":"#/components/schemas/LoanAppUpdatedWebhookRequestBody0","loan_app_submitted":"#/components/schemas/LoanAppSubmittedWebhookRequestBody0","loan_app_imported":"#/components/schemas/LoanAppImportedWebhookRequestBody0","loan_app_abandoned":"#/components/schemas/LoanAppAbandonedWebhookRequestBody0","document_uploaded":"#/components/schemas/DocumentUploadedWebhookRequestBody0","document_created":"#/components/schemas/DocumentCreatedWebhookRequestBody0","document_updated":"#/components/schemas/DocumentUpdatedWebhookRequestBody0","loan_milestone_updated":"#/components/schemas/LoanMilestoneUpdatedWebhookRequestBody0","loan_milestone_completed":"#/components/schemas/LoanMilestoneCompletedWebhookRequestBody0","loan_created":"#/components/schemas/LoanCreatedWebhookRequestBody0","loan_updated":"#/components/schemas/LoanUpdatedWebhookRequestBody0","loan_deleted":"#/components/schemas/LoanDeletedWebhookRequestBody0","loan_activated":"#/components/schemas/LoanActivatedWebhookRequestBody0","loan_deactivated":"#/components/schemas/LoanDeactivatedWebhookRequestBody0","milestones_reordered":"#/components/schemas/MilestonesReorderedWebhookRequestBody0","milestone_created":"#/components/schemas/MilestoneCreatedWebhookRequestBody0","milestone_deleted":"#/components/schemas/MilestoneDeletedWebhookRequestBody0","organization_created":"#/components/schemas/OrganizationCreatedWebhookRequestBody0","organization_deleted":"#/components/schemas/OrganizationDeletedWebhookRequestBody0","state_license_created":"#/components/schemas/StateLicenseCreatedWebhookRequestBody0","state_license_updated":"#/components/schemas/StateLicenseUpdatedWebhookRequestBody0","state_license_deleted":"#/components/schemas/StateLicenseDeletedWebhookRequestBody0","account_assignment_created":"#/components/schemas/AccountAssignmentCreatedWebhookRequestBody0","account_assignment_deleted":"#/components/schemas/AccountAssignmentDeletedWebhookRequestBody0","loan_officer_promoted":"#/components/schemas/LoanOfficerPromotedWebhookRequestBody0","loan_officer_demoted":"#/components/schemas/LoanOfficerDemotedWebhookRequestBody0","user_created":"#/components/schemas/UserCreatedWebhookRequestBody0","user_updated":"#/components/schemas/UserUpdatedWebhookRequestBody0","user_enabled":"#/components/schemas/UserEnabledWebhookRequestBody0","user_disabled":"#/components/schemas/UserDisabledWebhookRequestBody0","user_first_login":"#/components/schemas/UserFirstLoginWebhookRequestBody0","user_deleted":"#/components/schemas/UserDeletedWebhookRequestBody0","verification_available":"#/components/schemas/VerificationAvailableWebhookRequestBody0"}},"oneOf":[{"$ref":"#/components/schemas/JobStatusChangedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanAppStartedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanAppUpdatedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanAppSubmittedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanAppImportedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanAppAbandonedWebhookRequestBody0"},{"$ref":"#/components/schemas/DocumentUploadedWebhookRequestBody0"},{"$ref":"#/components/schemas/DocumentCreatedWebhookRequestBody0"},{"$ref":"#/components/schemas/DocumentUpdatedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanMilestoneUpdatedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanMilestoneCompletedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanCreatedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanUpdatedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanDeletedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanActivatedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanDeactivatedWebhookRequestBody0"},{"$ref":"#/components/schemas/MilestonesReorderedWebhookRequestBody0"},{"$ref":"#/components/schemas/MilestoneCreatedWebhookRequestBody0"},{"$ref":"#/components/schemas/MilestoneDeletedWebhookRequestBody0"},{"$ref":"#/components/schemas/OrganizationCreatedWebhookRequestBody0"},{"$ref":"#/components/schemas/OrganizationDeletedWebhookRequestBody0"},{"$ref":"#/components/schemas/StateLicenseCreatedWebhookRequestBody0"},{"$ref":"#/components/schemas/StateLicenseUpdatedWebhookRequestBody0"},{"$ref":"#/components/schemas/StateLicenseDeletedWebhookRequestBody0"},{"$ref":"#/components/schemas/AccountAssignmentCreatedWebhookRequestBody0"},{"$ref":"#/components/schemas/AccountAssignmentDeletedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanOfficerPromotedWebhookRequestBody0"},{"$ref":"#/components/schemas/LoanOfficerDemotedWebhookRequestBody0"},{"$ref":"#/components/schemas/UserCreatedWebhookRequestBody0"},{"$ref":"#/components/schemas/UserUpdatedWebhookRequestBody0"},{"$ref":"#/components/schemas/UserEnabledWebhookRequestBody0"},{"$ref":"#/components/schemas/UserDisabledWebhookRequestBody0"},{"$ref":"#/components/schemas/UserFirstLoginWebhookRequestBody0"},{"$ref":"#/components/schemas/UserDeletedWebhookRequestBody0"},{"$ref":"#/components/schemas/VerificationAvailableWebhookRequestBody0"}],"additionalProperties":false},"WebhookRequestBody":{"allOf":[{"$ref":"#/components/schemas/BaseWebhookRequestBody"},{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/WebhookRequestEvent"},"minItems":1,"description":"An array of events that have been triggered."}},"required":["events"],"additionalProperties":false}]},"JobStatusChangedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["job_status_changed"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/JobStatusChangedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'job_status_changed' event.","additionalProperties":false},"LoanAppStartedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_app_started"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanApplicationEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_app_started' event.","additionalProperties":false},"LoanAppUpdatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_app_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanApplicationEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_app_updated' event.","additionalProperties":false},"LoanAppSubmittedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_app_submitted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanApplicationEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_app_submitted' event.","additionalProperties":false},"LoanAppImportedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_app_imported"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanApplicationEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_app_imported' event.","additionalProperties":false},"LoanAppAbandonedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_app_abandoned"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanApplicationEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_app_abandoned' event.","additionalProperties":false},"DocumentUploadedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["document_uploaded"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/DocumentUploadedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'document_uploaded' event.","additionalProperties":false},"DocumentCreatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["document_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/DocumentCreatedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'document_created' event.","additionalProperties":false},"DocumentUpdatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["document_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/DocumentUpdatedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'document_updated' event.","additionalProperties":false},"LoanMilestoneUpdatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_milestone_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanMilestoneUpdatedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_milestone_updated' event.","additionalProperties":false},"LoanMilestoneCompletedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_milestone_completed"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanMilestoneCompletedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_milestone_completed' event.","additionalProperties":false},"LoanCreatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_created' event.","additionalProperties":false},"LoanUpdatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_updated' event.","additionalProperties":false},"LoanDeletedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_deleted' event.","additionalProperties":false},"LoanActivatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_activated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_activated' event.","additionalProperties":false},"LoanDeactivatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_deactivated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_deactivated' event.","additionalProperties":false},"MilestonesReorderedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["milestones_reordered"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/MilestonesReorderedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'milestones_reordered' event.","additionalProperties":false},"MilestoneCreatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["milestone_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/MilestoneCreatedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'milestone_created' event.","additionalProperties":false},"MilestoneDeletedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["milestone_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/MilestoneDeletedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'milestone_deleted' event.","additionalProperties":false},"OrganizationCreatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["organization_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/OrganizationCreatedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'organization_created' event.","additionalProperties":false},"OrganizationDeletedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["organization_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/OrganizationDeletedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'organization_deleted' event.","additionalProperties":false},"StateLicenseCreatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["state_license_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/StateLicenseEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'state_license_created' event.","additionalProperties":false},"StateLicenseUpdatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["state_license_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/StateLicenseEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'state_license_updated' event.","additionalProperties":false},"StateLicenseDeletedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["state_license_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/StateLicenseEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'state_license_deleted' event.","additionalProperties":false},"AccountAssignmentCreatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["account_assignment_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/AccountAssignmentEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'account_assignment_created' event.","additionalProperties":false},"AccountAssignmentDeletedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["account_assignment_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/AccountAssignmentEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'account_assignment_deleted' event.","additionalProperties":false},"LoanOfficerPromotedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_officer_promoted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanOfficerAdminChangeEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_officer_promoted' event.","additionalProperties":false},"LoanOfficerDemotedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["loan_officer_demoted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/LoanOfficerAdminChangeEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'loan_officer_demoted' event.","additionalProperties":false},"UserCreatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["user_created"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserCreatedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'user_created' event.","additionalProperties":false},"UserUpdatedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["user_updated"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserUpdatedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'user_updated' event.","additionalProperties":false},"UserEnabledTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["user_enabled"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserEnabledEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'user_enabled' event.","additionalProperties":false},"UserDisabledTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["user_disabled"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserDisabledEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'user_disabled' event.","additionalProperties":false},"UserFirstLoginTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["user_first_login"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserFirstLoginEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'user_first_login' event.","additionalProperties":false},"UserDeletedTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["user_deleted"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/UserDeletedEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'user_deleted' event.","additionalProperties":false},"VerificationAvailableTestEvent0":{"type":"object","properties":{"event":{"type":"string","enum":["verification_available"],"description":"Event that triggered the webhook."},"event_info":{"allOf":[{"$ref":"#/components/schemas/VerificationAvailableEventInfo"}]}},"required":["event","event_info"],"description":"Available properties for testing a 'verification_available' event.","additionalProperties":false}},"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth 2.0 Access Token (Default)","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}}}}}},"webhooks":{"account_assignment_created":{"post":{"tags":["Account Assignment Webhooks"],"operationId":"account_assignment_webhooks-account_assignment_created","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when an account assignment is created.","summary":"account_assignment_created","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"assignment":"/fake/path/to/assignment"},"event":"account_assignment_created","event_info":{"assignee_type":"Assignee type","assignee_name":"Assignee name","assignor_type":"Assignor type","assignor_name":"Assignor name"}}]}}}}}},"account_assignment_deleted":{"post":{"tags":["Account Assignment Webhooks"],"operationId":"account_assignment_webhooks-account_assignment_deleted","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when an account assignment is deleted.","summary":"account_assignment_deleted","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"assignments":"/fake/path/to/assignments"},"event":"account_assignment_deleted","event_info":{"assignee_type":"Assignee type","assignee_name":"Assignee name","assignor_type":"Assignor type","assignor_name":"Assignor name"}}]}}}}}},"document_created":{"post":{"tags":["Document Webhooks"],"operationId":"document_webhooks-document_created","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent when a document record is created on a loan.","summary":"document_created","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan":"/fake/path/to/loan"},"event":"document_created","event_info":{"document_name":"Document name","doc_type":"Doc type","task_name":"Task name","loan_number":"Loan number"}}]}}}}}},"document_updated":{"post":{"tags":["Document Webhooks"],"operationId":"document_webhooks-document_updated","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent when a document is updated on a loan.","summary":"document_updated","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan":"/fake/path/to/loan"},"event":"document_updated","event_info":{"document_name":"Document name","doc_type":"Doc type","task_name":"Task name","loan_number":"Loan number"}}]}}}}}},"document_uploaded":{"post":{"tags":["Document Webhooks"],"operationId":"document_webhooks-document_uploaded","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent when a document is uploaded to a loan.","summary":"document_uploaded","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan":"/fake/path/to/loan"},"event":"document_uploaded","event_info":{"document_name":"Document name","doc_type":"Doc type","task_name":"Task name","loan_number":"Loan number","uploaded_by":"Uploaded by"}}]}}}}}},"job_status_changed":{"post":{"tags":["Job Webhooks"],"operationId":"job_webhooks-job_status_changed","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a job's status has changed.","summary":"job_status_changed","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"job":"/fake/path/to/job"},"event":"job_status_changed","event_info":{"job_type":"SYNC_LOAN_APPS","job_description":"Job description","from_status":"QUEUED","to_status":"QUEUED","changed_at":"1989-08-23T00:00:00+00:00"}}]}}}}}},"loan_activated":{"post":{"tags":["Loan Webhooks"],"operationId":"loan_webhooks-loan_activated","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan>> is activated.","summary":"loan_activated","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan":"/fake/path/to/loan"},"event":"loan_activated","event_info":{"loan_number":"Loan number"}}]}}}}}},"loan_app_abandoned":{"post":{"tags":["Loan Application Webhooks"],"operationId":"loan_application_webhooks-loan_app_abandoned","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan application>> is abandoned.","summary":"loan_app_abandoned","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan_application":"/fake/path/to/loan_application"},"event":"loan_app_abandoned","event_info":{"borrower_name":"Borrower name"}}]}}}}}},"loan_app_imported":{"post":{"tags":["Loan Application Webhooks"],"operationId":"loan_application_webhooks-loan_app_imported","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan application>> is imported.","summary":"loan_app_imported","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan_application":"/fake/path/to/loan_application"},"event":"loan_app_imported","event_info":{"borrower_name":"Borrower name"}}]}}}}}},"loan_app_started":{"post":{"tags":["Loan Application Webhooks"],"operationId":"loan_application_webhooks-loan_app_started","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan application>> is started.","summary":"loan_app_started","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan_application":"/fake/path/to/loan_application"},"event":"loan_app_started","event_info":{"borrower_name":"Borrower name"}}]}}}}}},"loan_app_submitted":{"post":{"tags":["Loan Application Webhooks"],"operationId":"loan_application_webhooks-loan_app_submitted","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan application>> is submitted.","summary":"loan_app_submitted","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan_application":"/fake/path/to/loan_application"},"event":"loan_app_submitted","event_info":{"borrower_name":"Borrower name"}}]}}}}}},"loan_app_updated":{"post":{"tags":["Loan Application Webhooks"],"operationId":"loan_application_webhooks-loan_app_updated","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan application>> is updated.","summary":"loan_app_updated","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan_application":"/fake/path/to/loan_application"},"event":"loan_app_updated","event_info":{"borrower_name":"Borrower name"}}]}}}}}},"loan_created":{"post":{"tags":["Loan Webhooks"],"operationId":"loan_webhooks-loan_created","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan>> is created.","summary":"loan_created","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan":"/fake/path/to/loan"},"event":"loan_created","event_info":{"loan_number":"Loan number"}}]}}}}}},"loan_deactivated":{"post":{"tags":["Loan Webhooks"],"operationId":"loan_webhooks-loan_deactivated","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan>> is deactivated.","summary":"loan_deactivated","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan":"/fake/path/to/loan"},"event":"loan_deactivated","event_info":{"loan_number":"Loan number"}}]}}}}}},"loan_deleted":{"post":{"tags":["Loan Webhooks"],"operationId":"loan_webhooks-loan_deleted","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan>> is deleted.","summary":"loan_deleted","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loans":"/fake/path/to/loans"},"event":"loan_deleted","event_info":{"loan_number":"Loan number"}}]}}}}}},"loan_milestone_completed":{"post":{"tags":["Loan Milestone Webhooks"],"operationId":"loan_milestone_webhooks-loan_milestone_completed","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent when a <<glossary:loan milestone>> is completed.","summary":"loan_milestone_completed","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan_milestone":"/fake/path/to/loan_milestone"},"event":"loan_milestone_completed","event_info":{"milestone_name":"Milestone name","loan_number":"Loan number"}}]}}}}}},"loan_milestone_updated":{"post":{"tags":["Loan Milestone Webhooks"],"operationId":"loan_milestone_webhooks-loan_milestone_updated","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent when a <<glossary:loan milestone>> is updated.","summary":"loan_milestone_updated","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan_milestone":"/fake/path/to/loan_milestone"},"event":"loan_milestone_updated","event_info":{"milestone_name":"Milestone name","status":"Status","loan_number":"Loan number"}}]}}}}}},"loan_officer_demoted":{"post":{"tags":["Loan Officer Webhooks"],"operationId":"loan_officer_webhooks-loan_officer_demoted","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan officer>> is demoted.","summary":"loan_officer_demoted","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan_officer":"/fake/path/to/loan_officer"},"event":"loan_officer_demoted","event_info":{"admin_type":"COMPANY_ADMIN","name":"Name"}}]}}}}}},"loan_officer_promoted":{"post":{"tags":["Loan Officer Webhooks"],"operationId":"loan_officer_webhooks-loan_officer_promoted","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan officer>> is promoted.","summary":"loan_officer_promoted","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan_officer":"/fake/path/to/loan_officer"},"event":"loan_officer_promoted","event_info":{"admin_type":"COMPANY_ADMIN","name":"Name"}}]}}}}}},"loan_updated":{"post":{"tags":["Loan Webhooks"],"operationId":"loan_webhooks-loan_updated","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:loan>> is updated.","summary":"loan_updated","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan":"/fake/path/to/loan"},"event":"loan_updated","event_info":{"loan_number":"Loan number"}}]}}}}}},"milestone_created":{"post":{"tags":["Milestone Webhooks"],"operationId":"milestone_webhooks-milestone_created","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when <<glossary:milestone>> is created.","summary":"milestone_created","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"milestone":"/fake/path/to/milestone"},"event":"milestone_created","event_info":{"name":"Name"}}]}}}}}},"milestone_deleted":{"post":{"tags":["Milestone Webhooks"],"operationId":"milestone_webhooks-milestone_deleted","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when <<glossary:milestone>> is deleted.","summary":"milestone_deleted","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"milestones":"/fake/path/to/milestones"},"event":"milestone_deleted","event_info":{"name":"Name"}}]}}}}}},"milestones_reordered":{"post":{"tags":["Milestone Webhooks"],"operationId":"milestone_webhooks-milestones_reordered","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when <<glossary:milestone>>s are reordered.","summary":"milestones_reordered","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"milestones":"/fake/path/to/milestones"},"event":"milestones_reordered","event_info":{"name":"Name"}}]}}}}}},"organization_created":{"post":{"tags":["Organization Webhooks"],"operationId":"organization_webhooks-organization_created","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when an organization is created.","summary":"organization_created","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"organization":"/fake/path/to/organization"},"event":"organization_created","event_info":{"org_type":"REGION","name":"Name"}}]}}}}}},"organization_deleted":{"post":{"tags":["Organization Webhooks"],"operationId":"organization_webhooks-organization_deleted","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when an organization is deleted.","summary":"organization_deleted","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"parent_organization":"/fake/path/to/parent_organization"},"event":"organization_deleted","event_info":{"org_type":"REGION","name":"Name"}}]}}}}}},"state_license_created":{"post":{"tags":["State License Webhooks"],"operationId":"state_license_webhooks-state_license_created","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:state license>> is created.","summary":"state_license_created","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"state_license":"/fake/path/to/state_license"},"event":"state_license_created","event_info":{"state":"AA"}}]}}}}}},"state_license_deleted":{"post":{"tags":["State License Webhooks"],"operationId":"state_license_webhooks-state_license_deleted","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:state license>> is deleted.","summary":"state_license_deleted","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"state_licenses":"/fake/path/to/state_licenses"},"event":"state_license_deleted","event_info":{"state":"AA"}}]}}}}}},"state_license_updated":{"post":{"tags":["State License Webhooks"],"operationId":"state_license_webhooks-state_license_updated","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a <<glossary:state license>> is updated.","summary":"state_license_updated","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"state_license":"/fake/path/to/state_license"},"event":"state_license_updated","event_info":{"state":"AA"}}]}}}}}},"user_created":{"post":{"tags":["User Webhooks"],"operationId":"user_webhooks-user_created","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a user is created.","summary":"user_created","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"user":"/fake/path/to/user"},"event":"user_created","event_info":{"name":"Name","user_type":"USER_BORROWER","user_borrower":"User borrower"}}]}}}}}},"user_deleted":{"post":{"tags":["User Webhooks"],"operationId":"user_webhooks-user_deleted","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a user is deleted.","summary":"user_deleted","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"loan_officer":"/fake/path/to/loan_officer"},"event":"user_deleted","event_info":{"name":"Name","user_type":"USER_BORROWER"}}]}}}}}},"user_disabled":{"post":{"tags":["User Webhooks"],"operationId":"user_webhooks-user_disabled","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a user is disabled.","summary":"user_disabled","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"user":"/fake/path/to/user"},"event":"user_disabled","event_info":{"name":"Name","user_type":"USER_BORROWER"}}]}}}}}},"user_enabled":{"post":{"tags":["User Webhooks"],"operationId":"user_webhooks-user_enabled","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a user is enabled.","summary":"user_enabled","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"user":"/fake/path/to/user"},"event":"user_enabled","event_info":{"name":"Name","user_type":"USER_BORROWER"}}]}}}}}},"user_first_login":{"post":{"tags":["User Webhooks"],"operationId":"user_webhooks-user_first_login","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a user first logs in.","summary":"user_first_login","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"user":"/fake/path/to/user"},"event":"user_first_login","event_info":{"name":"Name","user_type":"USER_BORROWER"}}]}}}}}},"user_updated":{"post":{"tags":["User Webhooks"],"operationId":"user_webhooks-user_updated","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a user is updated.","summary":"user_updated","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"user":"/fake/path/to/user"},"event":"user_updated","event_info":{"name":"Name","user_type":"USER_BORROWER"}}]}}}}}},"verification_available":{"post":{"tags":["Verification Webhooks"],"operationId":"verification_webhooks-verification_available","responses":{"200":{"$ref":"#/components/responses/WebhookResponse"}},"description":"A <<glossary:webhook>> notification sent out when a verification report is available.","summary":"verification_available","requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequestBody"},"example":{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","events":[{"_id":"00000000-0000-0000-0000-000000000000","_timestamp":"1989-08-23T00:00:00+00:00","_links":{"verification":"/fake/path/to/verification"},"event":"verification_available","event_info":{"report_type":"BOTH"}}]}}}}}}}}