nCino Mortgage Webhooks

{"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":{"descri

# --- truncated at 32 KB (114 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ncino/refs/heads/main/openapi/ncino-mortgage-webhooks-openapi.json