{ "openapi": "3.0.1", "info": { "title": "CertifID V2 APIs", "description": "Access to CertifID data and functions for 3rd Party Integrations", "version": "v1" }, "paths": { "/api/v1/AccountVerifications": { "post": { "tags": [ "AccountVerifications" ], "summary": "Create a new account verification.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.CreateAccountVerificationRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.CreateAccountVerificationRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.CreateAccountVerificationRequestModel" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/AccountVerifications/{id}": { "get": { "tags": [ "AccountVerifications" ], "summary": "Retrieve an account verification by id.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationResponseModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/AccountVerifications/Search": { "post": { "tags": [ "AccountVerifications" ], "summary": "Search account verifications for the authenticated tenant.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationsListQuery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationsListQuery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationsListQuery" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Pagination.PagedData`1[CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationResponseModel]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/AccountVerifications/{id}/Cancel": { "post": { "tags": [ "AccountVerifications" ], "summary": "Cancel an account verification.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationResponseModel" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "422": { "description": "Unprocessable Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/Bank/{abaRoutingNumber}/WiringDetails": { "get": { "tags": [ "BankLookup" ], "summary": "Lookup a bank's wiring details based on their ABA/routing number.", "parameters": [ { "name": "abaRoutingNumber", "in": "path", "description": "The ABA/routing number of the bank to lookup.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankWiringDetailsViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankWiringDetailsViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankWiringDetailsViewModel" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/Bank/{abaRoutingNumber}": { "get": { "tags": [ "BankLookup" ], "summary": "Lookup a correspondent bank's details based on their ABA/routing number.", "parameters": [ { "name": "abaRoutingNumber", "in": "path", "description": "The ABA/routing number of the bank to lookup.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/WiringInstructions/Collect/{requestId}": { "get": { "tags": [ "CollectRequest" ], "summary": "Retrieve the latest state of an initiated request within CertifID's platform.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the request, assigned by CertifID's platform upon initiation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "RequestProduct" ] } ] } }, "/api/v1/WiringInstructions/Collect/{requestId}/Certificate": { "get": { "tags": [ "CollectRequest" ], "summary": "Get the confirmation PDF certificate associated with a successfully completed request.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the completed request.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "RequestProduct" ] } ] } }, "/api/v1/WiringInstructions/Collect": { "post": { "tags": [ "CollectRequest" ], "summary": "Initiate a new request to request a seller's wiring instructions.", "requestBody": { "description": "The details of the file for which a new request is being initiated, and the\r\ndefault values to select in the form within CertifID's platform.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.CollectRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.CollectRequestDetailsViewModel]" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.CollectRequestDetailsViewModel]" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Error codes and description: \n\n```119``` - Invalid Phone Number.\n", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "RequestProduct", "RequestCreator" ] } ] } }, "/api/v1/WiringInstructions/Confirm/{requestId}": { "get": { "tags": [ "ConfirmRequest" ], "summary": "Retrieve the latest state of an initiated confirm request within CertifID's platform.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the request, assigned by CertifID's platform upon initiation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "RequestProduct" ] } ] } }, "/api/v1/WiringInstructions/Confirm/{requestId}/Certificate": { "get": { "tags": [ "ConfirmRequest" ], "summary": "Get the confirmation PDF certificate associated with a successfully completed confirm request.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the completed confirm request.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "RequestProduct" ] } ] } }, "/api/v1/WiringInstructions/Confirm": { "post": { "tags": [ "ConfirmRequest" ], "summary": "Initiate a new request to Confirm a seller's wiring instructions.", "requestBody": { "description": "The details of the file for which a new confirm request is being initiated, and the\r\ndefault values to select in the form within CertifID's platform.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.ConfirmRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.ConfirmRequestDetailsViewModel]" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.ConfirmRequestDetailsViewModel]" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Error codes and description: \n\n```119``` - Invalid Phone Number.\n", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "RequestProduct", "RequestCreator" ] } ] } }, "/api/v1/Disbursements/CreateDisbursement": { "post": { "tags": [ "Disbursements" ], "summary": "Create a new Disbursement (Payoff)", "requestBody": { "description": "Request model CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.CreatePayoffProtectRequestModel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.CreatePayoffProtectRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.CreatePayoffProtectRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.CreatePayoffProtectRequestModel" } } } }, "responses": { "201": { "description": "Returns the newly created Disbursement (Payoff)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectUpsertResponseModel" } } } }, "400": { "description": "Returns Bad Request details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation" } } } }, "401": { "description": "Returns Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/Disbursements/GetDisbursementById/{id}": { "post": { "tags": [ "Disbursements" ], "summary": "Gets a Disbursement (Payoff) by ID", "parameters": [ { "name": "id", "in": "path", "description": "Disbursement (Payoff) ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns Payoff", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectResponseModel" } } } }, "400": { "description": "Returns Bad Request details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation" } } } }, "404": { "description": "Returns that the Disbursement (Payoff) ID provided was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Returns Unauthorized" }, "403": { "description": "Returns Forbidden (consumer does not have access to this Disbursement (Payoff))" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/Disbursements/GetDisbursementStatementsByDisbursementId/{id}": { "post": { "tags": [ "Disbursements" ], "summary": "Gets List of Payoff statements associated to the requested Disbursement", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.GetDisbursementStatementsResponseModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/Disbursements/SearchDisbursements": { "post": { "tags": [ "Disbursements" ], "summary": "Gets a list of Disbursements (Payoffs) for a specified Account (Location)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffSimplePagedQuery" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffSimplePagedQuery" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffSimplePagedQuery" } } } }, "responses": { "200": { "description": "Returns paged Disbursements (Payoffs)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Pagination.PagedData`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectResponseModel]" } } } }, "400": { "description": "Returns Bad Request details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation" } } } }, "401": { "description": "Returns Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/Disbursements/EditDisbursement": { "post": { "tags": [ "Disbursements" ], "summary": "Edit a Disbursement (Payoff)", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.EditPayoffProtectRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.EditPayoffProtectRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.EditPayoffProtectRequestModel" } } } }, "responses": { "200": { "description": "Returns the updated Disbursement (Payoff)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectUpsertResponseModel" } } } }, "400": { "description": "Returns Bad Request details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation" } } } }, "401": { "description": "Returns Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/Disbursements/UploadDisbursementDocument": { "post": { "tags": [ "Disbursements" ], "summary": "Upload and save a Disbursment (Payoff) statement as a .pdf in certifIDs system", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.UploadDisbursementDocumentModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.UploadDisbursementDocumentModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.UploadDisbursementDocumentModel" } } } }, "responses": { "201": { "description": "Disbursement (Payoff) statement was successfully uploaded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.DisbursementStatementUploadResponseModel" } } } }, "400": { "description": "Returns Bad Request details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation" } } } }, "404": { "description": "Returns that the Disbursement (Payoff) ID provided was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Returns Unauthorized" }, "403": { "description": "Returns Forbidden (consumer cannot upload a statement because they do not have access to this Disbursement (Payoff))" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/Disbursements/GetDisbursementVerificationFieldsFromStatement": { "post": { "tags": [ "Disbursements" ], "summary": "Get Disbursement Verification Fields From uploaded Statement", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.GetDisbursementFieldsFromStatementRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.GetDisbursementFieldsFromStatementRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.GetDisbursementFieldsFromStatementRequestModel" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.GetDisbursementFieldsFromStatementResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/Disbursements/getPdfByDisbursementId/{disbursementId}": { "post": { "tags": [ "Disbursements" ], "summary": "Get the confirmation PDF certificate associated with a successfully completed send request.", "parameters": [ { "name": "disbursementId", "in": "path", "description": "The ID of the disbursement", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/Disbursements/GetLoanType": { "post": { "tags": [ "Disbursements" ], "summary": "Return a list of Payoff Loan types", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/Disbursements/GetDisbursementCancelationReasons": { "post": { "tags": [ "Disbursements" ], "summary": "Returns a list of Disbursement Cancelation Reasons", "responses": { "200": { "description": "Returns a list of Disbursement Cancelation Reasons", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/identity/IdentityVerification": { "post": { "tags": [ "IdentityRequest" ], "summary": "Initiates a new identity verification request for a recipient.", "description": "This endpoint creates an identity verification request that will be sent to the specified recipient\r\nvia their preferred delivery method (email, text, or share link). The recipient will be prompted to\r\ncomplete the identity verification process through a secure link.\r\n \r\nThe verification process validates the recipient's identity using multi-factor authentication\r\nand returns a verification result that can be used to confirm the identity of parties involved\r\nin real estate transactions.\r\n \r\n**Delivery Methods:**\r\n- `email_or_text`: Sends verification link via email or SMS to the recipient\r\n- `share_link`: Generates a unique shareable link returned in the response's VerificationDetails.UniqueLink\r\n \r\n**Request Flow:**\r\n1. Submit identity verification request with recipient details\r\n2. System creates request and sends invitation (if email_or_text) or returns share link\r\n3. Recipient receives invitation and completes verification\r\n4. System processes verification result and updates request status\r\n5. Webhook notification sent to results_url (if configured)\r\n \r\n**Authentication:**\r\nRequires API key authentication. The caller's company must have identity verification enabled.", "operationId": "CreateIdentityVerification", "requestBody": { "description": "The identity verification request details including recipient information and delivery preferences.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.IdentityRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.IdentityRequestDetailsViewModel]" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.IdentityRequestDetailsViewModel]" } } } }, "responses": { "200": { "description": "Successfully created the identity verification request. Returns the request details including the unique request ID, status, and verification details (including share link if applicable).", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel]" } } } }, "400": { "description": "Bad request. Validation errors occurred with the provided data. Common issues include:\r\n - Missing required fields (Recipient.FirstName, Recipient.LastName, RequestDetails.DeliveryMethod)\r\n - Invalid data format (email format, phone number must be 10 digits, invalid delivery method)\r\n - Invalid routing number (if applicable)\r\n - Invalid phone number format\r\n Returns Response object with Errors array containing detailed error information.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.BusinessLogic.Models.Response.Response`1[CertifID.V2.PublicAPI.BusinessLogic.Models.Response.ResponseErrorCodes+CodeAndDetails]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.BusinessLogic.Models.Response.Response`1[CertifID.V2.PublicAPI.BusinessLogic.Models.Response.ResponseErrorCodes+CodeAndDetails]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.BusinessLogic.Models.Response.Response`1[CertifID.V2.PublicAPI.BusinessLogic.Models.Response.ResponseErrorCodes+CodeAndDetails]" } } } }, "401": { "description": "Unauthorized. API key is missing, invalid, or expired." }, "403": { "description": "Forbidden. The authenticated account's company does not have identity verification enabled." }, "500": { "description": "Internal server error. An unexpected error occurred while processing the request." } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/identity/IdVerificationResultUrlWebhook/{requestId}": { "post": { "tags": [ "IdentityRequest" ], "summary": "Webhook that is called with id verification results - results_url", "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Results.ApiResult" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Results.ApiResult" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Results.ApiResult" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/v1/identity/IdentityVerification/{requestId}": { "get": { "tags": [ "IdentityRequest" ], "summary": "Retrieves the latest state of an initiated IDV request.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the submitted IDV request.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/identity/GetIdentityRequestCertificate/{requestId}/Certificate": { "get": { "tags": [ "IdentityRequest" ], "summary": "Get the confirmation PDF certificate associated with a successfully completed IDV request.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the completed request.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/Integration/Collect/{requestId}/Certificate": { "get": { "tags": [ "Integration" ], "summary": "Get the confirmation PDF certificate associated with a successfully completed collect request.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the completed request.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:requests|requestId|CollectRequest" ] } ] } }, "/api/v1/Integration/Collect/{requestId}": { "get": { "tags": [ "Integration" ], "summary": "Retrieve the latest state of an initiated request within CertifID's platform.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the request, assigned by CertifID's platform upon initiation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:requests|requestId|CollectRequest" ] } ] } }, "/api/v1/Integration/Send/{requestId}/Certificate": { "get": { "tags": [ "Integration" ], "summary": "Get the confirmation PDF certificate associated with a successfully completed send request.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the completed request.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:requests|requestId|SendRequest" ] } ] } }, "/api/v1/Integration/Send/{requestId}": { "get": { "tags": [ "Integration" ], "summary": "Retrieve the latest state of an initiated send request within CertifID's platform.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the request, assigned by CertifID's platform upon initiation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:requests|requestId|SendRequest" ] } ] } }, "/api/v1/Integration/Confirm/{requestId}/Certificate": { "get": { "tags": [ "Integration" ], "summary": "Get the confirmation PDF certificate associated with a successfully completed collect request.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the completed request.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:requests|requestId|ConfirmRequest" ] } ] } }, "/api/v1/Integration/Confirm/{requestId}": { "get": { "tags": [ "Integration" ], "summary": "Retrieve the latest state of an initiated confirm request within CertifID's platform.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the request, assigned by CertifID's platform upon initiation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:requests|requestId|ConfirmRequest" ] } ] } }, "/api/v1/Integration/Identity/{requestId}/Certificate": { "get": { "tags": [ "Integration" ], "summary": "Get the confirmation PDF certificate associated with a successfully completed identity request.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the completed request.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:requests|requestId|IdentityRequest" ] } ] } }, "/api/v1/Integration/Disbursement/{disbursementId}/Certificate": { "get": { "tags": [ "Integration" ], "summary": "Get the confirmation PDF certificate associated with a successfully validated disbursement.", "parameters": [ { "name": "disbursementId", "in": "path", "description": "The ID of the disbursement", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:requests|disbursementId|DisbursementVerification" ] } ] } }, "/api/v1/Integration/Disbursement/{id}": { "get": { "tags": [ "Integration" ], "summary": "Gets a Disbursement (Payoff) by ID", "parameters": [ { "name": "id", "in": "path", "description": "Disbursement (Payoff) ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns Payoff", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectResponseModel" } } } }, "400": { "description": "Returns Bad Request details", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation" } } } }, "404": { "description": "Returns that the Disbursement (Payoff) ID provided was not found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Returns Unauthorized" }, "403": { "description": "Returns Forbidden (consumer does not have access to this Disbursement (Payoff))" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:disbursements|id|DisbursementVerification" ] } ] } }, "/api/v1/Integration/PayoffOrder/{id}": { "get": { "tags": [ "Integration" ], "summary": "Gets a payoff order by its ID.", "parameters": [ { "name": "payoffOrderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrder" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:payofforder|payoffOrderId|PayoffOrder" ] } ] } }, "/api/v1/Integration/PayoffOrder/{payoffOrderId}/Quote/{quoteId}/Certificate": { "get": { "tags": [ "Integration" ], "summary": "Get the quote PDF associated with payoff order.", "parameters": [ { "name": "payoffOrderId", "in": "path", "description": "The id of the payoff order.", "required": true, "schema": { "type": "string" } }, { "name": "quoteId", "in": "path", "description": "The id of the payoff order quote desired.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:payofforder|payoffOrderId|PayoffOrder" ] } ] } }, "/api/v1/Integration/Identity/{requestId}": { "get": { "tags": [ "Integration" ], "summary": "Retrieves the latest state of an initiated IDV request.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the submitted IDV request.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:requests|requestId|IdentityRequest" ] } ] } }, "/api/v1/Lenders/SearchLenders": { "post": { "tags": [ "Lenders" ], "summary": "Endpoint to search for Lenders by Name. This is a partial search. \r\nFor example, \"US\" would return \"US Bank\", \"Bank of the US\", etc.\r\nOnly available to consumers with Payoff Protect product access.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "Enter a search term to search for Lenders who's Name matches this term", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the Lenders who match the search string", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.Lender.LenderResponseModel" } } } } }, "400": { "description": "Returns details on why the request is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation" } } } }, "401": { "description": "Returns unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/Lenders/GetLenderLogoById": { "post": { "tags": [ "Lenders" ], "summary": "Retrieves a Lender Logo using the Lender Id", "parameters": [ { "name": "lenderId", "in": "query", "description": "The ID of the lender whose logo should be retrieved", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns the object containing the Base64 Image and the Content Type", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Returns details on why the request is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation" } } } }, "404": { "description": "Returns that the a Lender Logo for a provided lenderId was not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Returns unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "PayoffProtectProduct" ] } ] } }, "/api/v1/Account": { "get": { "tags": [ "Location" ], "summary": "Retrieve the list of accounts that the customer has access to within CertifID's platform.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Locations.LocationViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Locations.LocationViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Locations.LocationViewModel" } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/Account/{id}": { "get": { "tags": [ "Location" ], "summary": "Retrieve a specific account belonging to the customer within CertifID's platform.", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the location/account to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Locations.LocationViewModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Locations.LocationViewModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Locations.LocationViewModel" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/PayoffOrdering/CreatePayoffOrder": { "post": { "tags": [ "PayoffOrdering" ], "summary": "Creates a new payoff order.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.CreatePayoffOrderRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.CreatePayoffOrderRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.CreatePayoffOrderRequestModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.PayoffOrderModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.PayoffOrderModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.PayoffOrderModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/PayoffOrdering/UpdatePayoffOrder": { "post": { "tags": [ "PayoffOrdering" ], "summary": "Updates an existing payoff order.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.UpdatePayoffOrderRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.UpdatePayoffOrderRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.UpdatePayoffOrderRequestModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.PayoffOrderModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.PayoffOrderModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.PayoffOrderModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/PayoffOrdering/GetPayoffOrderById/{id}": { "get": { "tags": [ "PayoffOrdering" ], "summary": "Gets a payoff order by its ID.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrder" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrder" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/PayoffOrdering/GetAvailablePayoffOrderLenders": { "get": { "tags": [ "PayoffOrdering" ], "summary": "Fetches the details of existing lenders.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.LenderSummary" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.LenderSummary" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.LenderSummary" } } } } }, "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/PayoffOrdering/CancelPayoffOrder": { "post": { "tags": [ "PayoffOrdering" ], "summary": "Cancels an existing payoff order.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.CancelPayoffOrderRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.CancelPayoffOrderRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.CancelPayoffOrderRequestModel" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.CancelPayoffOrderResponseModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.CancelPayoffOrderResponseModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.CancelPayoffOrderResponseModel" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/PayoffOrdering/GetCertificate/{payoffOrderId}/quote/{quoteId}/Certificate": { "get": { "tags": [ "PayoffOrdering" ], "summary": "Get the quote PDF associated with payoff order.", "parameters": [ { "name": "payoffOrderId", "in": "path", "description": "The id of the payoff order.", "required": true, "schema": { "type": "string" } }, { "name": "quoteId", "in": "path", "description": "The id of the payoff order quote desired.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/WiringInstructions/Send/{requestId}": { "get": { "tags": [ "SendRequest" ], "summary": "Retrieve the latest state of an initiated send request within CertifID's platform.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the request, assigned by CertifID's platform upon initiation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "RequestProduct" ] } ] } }, "/api/v1/WiringInstructions/Send/{requestId}/Certificate": { "get": { "tags": [ "SendRequest" ], "summary": "Get the confirmation PDF certificate associated with a successfully completed send request.", "parameters": [ { "name": "requestId", "in": "path", "description": "The ID of the completed send request.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "RequestProduct" ] } ] } }, "/api/v1/WiringInstructions/Send": { "post": { "tags": [ "SendRequest" ], "summary": "Initiate a new request to send wiring instructions to a buyer.", "requestBody": { "description": "The details of the request that is being initiated, and the default values to select in\r\nthe form within CertifID's platform.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.SendRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.SendRequestDetailsViewModel]" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.SendRequestDetailsViewModel]" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "400": { "description": "Error codes and description: \n\n```119``` - Invalid Phone Number.\n", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "RequestProduct", "RequestCreator" ] } ] } }, "/api/Test/{resourceId}": { "get": { "tags": [ "Test" ], "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "ResourceAccessToken|read:requests|resourceId|CompanyWiringInfo" ] } ] } }, "/api/Test/{resourceId}/NoAuth": { "get": { "tags": [ "Test" ], "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/Test/{resourceId}/JustAuth0": { "get": { "tags": [ "Test" ], "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ null ] } ] } }, "/api/v1/Account/{id}/Underwriter": { "get": { "tags": [ "Underwriter" ], "summary": "Retrieves a list of underwriters associated to the location", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the specific location to retrieve the title underwriters for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Underwriters.UnderwriterViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Underwriters.UnderwriterViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Underwriters.UnderwriterViewModel" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } }, "/api/v1/Users/GetUsersProducts": { "post": { "tags": [ "Users" ], "summary": "Retrieves a list of Products for current user", "responses": { "200": { "description": "Returns Payoff", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Returns unauthorized", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Returns not found error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation" } } } } } } }, "/api/v1/Account/{locationId}/BankInformation": { "get": { "tags": [ "WiringInstructions" ], "summary": "Retrieve a the wiring instructions available to the specified location/account.", "parameters": [ { "name": "locationId", "in": "path", "description": "The ID of the specific location/account to retrieve the wiring instructions for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.WiringInformation.WiringInformationViewModel" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.WiringInformation.WiringInformationViewModel" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.WiringInformation.WiringInformationViewModel" } } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } }, "security": [ { "oauth2": [ "CertifIDUser" ] } ] } } }, "components": { "schemas": { "CertifID.MortgagePayoff.Common.Models.BankInfo": { "type": "object", "properties": { "bankId": { "type": "string", "nullable": true }, "bankName": { "type": "string", "nullable": true }, "abaRoutingNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertifID.MortgagePayoff.Common.Models.Borrowers.BorrowerType": { "enum": [ "Person", "Entity" ], "type": "string" }, "CertifID.V2.Common.Models.Integrations.IntegrationData": { "type": "object", "properties": { "externalPartyId": { "type": "string", "nullable": true }, "fileId": { "type": "string", "nullable": true }, "sourceTPS": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Integrations.IntegrationProviderType" } }, "additionalProperties": false }, "CertifID.V2.Common.Models.Integrations.IntegrationProviderType": { "enum": [ "None", "ResWare", "TxM", "RamQuest", "SoftPro", "AimPlus", "StewartIndependence", "Proliant", "SMKT", "AtClose", "Settlor", "Endpoint", "PresidentialTitle", "TitleManagers", "AccuTitle", "DeferredInc", "EmailBridge" ], "type": "string" }, "CertifID.V2.Common.Models.Paging.SortDirection": { "enum": [ "Default", "Asc", "Desc" ], "type": "string" }, "CertifID.V2.Common.Models.Paging.SortField": { "required": [ "fieldName" ], "type": "object", "properties": { "fieldName": { "type": "string" }, "direction": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Paging.SortDirection" } }, "additionalProperties": false }, "CertifID.V2.Common.Models.Results.ApiResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "statusCode": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Results.StatusCode" }, "status": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Results.Status" }, "exception": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Results.ExceptionInfo" }, "serviceData": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Results.ServiceData" } }, "additionalProperties": false }, "CertifID.V2.Common.Models.Results.ExceptionInfo": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "innerException": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Results.ExceptionInfo" } }, "additionalProperties": false }, "CertifID.V2.Common.Models.Results.ServiceData": { "required": [ "serviceName" ], "type": "object", "properties": { "serviceName": { "type": "string" }, "instanceId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CertifID.V2.Common.Models.Results.Status": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "httpStatus": { "$ref": "#/components/schemas/System.Net.HttpStatusCode" } }, "additionalProperties": false }, "CertifID.V2.Common.Models.Results.StatusCode": { "enum": [ "UnexpectedErrorOccurred", "MissingRequiredParameter", "CompanyService_GetCurrentUserError", "CompanyService_InvalidOrMissingQueryError", "CompanyService_NoQueryError", "CompanyService_LocationNotFoundError", "CompanyService_IntegrationNotFoundError", "CompanyService_SaveLocationError", "CompanyService_SaveLogoError", "CompanyService_LogoNotFoundError", "CompanyService_ResourceSpecifiedError", "CompanyService_DirectAssingmentNotFoundError", "CompanyService_WiringInfoNotFoundError", "CompanyService_UnderwriterNotFoundError", "CompanyService_UserIdNotFoundError", "CompanyService_SaveCompanyError", "CompanyService_QueryCompanyUserError", "CompanyService_SaveCompanyUserError", "CompanyService_SaveUserInviteError", "CompanyService_UserInviteNotFound", "CompanyService_Validation_UserInviteNotInitialized", "CompanyService_UserNotFoundError", "CompanyService_Validation_UserInviteInFinalState", "CompanyService_UpdateUserAttributesError", "CompanyService_UpdateUserAttributes_AttributeTreeMismatch", "CompanyService_UpdateUserAttributes_InvalidAttributeCombination", "CompanyService_DirectAssignmentForAdminError", "CompanyService_UploadedFileIsNotAnImage", "CompanyService_CompanyPaymentAccountNotFound", "CompanyService_PaymentConfigNotFound", "CompanyService_ClientHubConfigNotFound", "CompanyService_RcsConfigNotFound", "CompanyService_CompanyBusinessNotFound", "Log_SaveItemFailed", "Log_ActivityLogAccessError", "Log_ActivityLogInvalidPagedQuery_Locations", "Notifications_SaveNotificationFailed", "Notifications_GetAccessError", "Notifications_UpdateNotificationFailed", "Notifications_DeletePhoneNotificationFailed", "Notifications_DeleteEmailNotificationFailed", "Notifications_UnknownSetting", "Notifications_ReplayNotificationFailed", "Notifications_InvalidShortlink", "Notifications_DisabledSetting", "Notifications_WebhookSecurityFailed", "Notifications_WebhookMissingNotificationId", "Requests_SaveRequestFailed", "Requests_RequestAccessError", "Requests_CompanyServiceAccessError", "Requests_Validation_MissingCompanyId", "Requests_Validation_MissingLocationId", "Requests_Validation_MissingUserId", "Requests_Validation_UnknownRequestId", "Requests_Validation_StatusChangeFailure_AlreadyStarted", "Requests_Validation_StatusChangeIgnored_AreadyStarted", "Requests_Validation_StatusChangeFailure_RequestInFinalState", "Requests_Validation_InvalidRequestType", "Requests_Validation_StatusMustBeStarted", "Requests_Validation_WiringInstructionsAlreadyExist", "Requests_Validation_MissingRoutingNumber", "Requests_Validation_MissingAccountNumber", "Requests_Validation_MissingWiringInstructions", "Requests_Validation_MissingAddressForWiringInstructions", "Requests_Validation_MissingBankInfoForWiringInstructions", "Requests_Validation_RequestIdMustBeNull", "Requests_Validation_IntegrationsSetButNotSupported", "Requests_Validation_IntegrationNotFound", "Requests_Validation_StatusChangeFailure_AlreadyOpened", "Requests_Validation_MissingFileNumber", "Requests_SaveMppPolicyItemFailed", "Requests_MppPolicyItemAccessError", "Requests_DeleteMppPolicyItemFailed", "Requests_MppPolicyPriceDefinitionGenerationError", "Requests_ActivityCreationError", "Payments_Validation_MissingRequestModel", "Payments_Validation_MissingId", "Payments_Validation_MissingReferenceId", "Payments_Validation_MissingCustomerEmail", "Payments_Validation_MissingInsurancePolicyId", "Payments_Validation_IsAboveMaxPolicy", "Payments_PaymentAlreadyExistsError", "Payments_SaveIntentError", "Payments_GetUpdatedIntentError", "Payments_GetIntentError", "Payments_IntentNotFound", "Payments_IntentFaulted", "Security_UserInviteActivitySessionCreated", "Security_UserInviteActivitySessionCreatedException", "Security_UserInviteActivitySessionRetrieved", "Security_UserInviteActivitySessionRetrievedException", "Security_UserInviteActivitySessionExtended", "Security_UserInviteActivitySessionExtendedException", "Security_ClientRequestActivitySessionCreated", "Security_ClientRequestActivitySessionCreatedException", "Security_ClientRequestActivitySessionRetrieved", "Security_ClientRequestActivitySessionRetrievedException", "Security_ClientRequestActivitySessionExtended", "Security_ClientRequestActivitySessionExtendedException", "Security_NewDigitalVerificationIdCreated", "Security_NewDigitalVerificationIdCreatedException", "Security_ClientDigitalVerificationStatusPassed", "Security_ClientDigitalVerificationStatusFailed", "Security_ClientDigitalVerificationException", "Security_UserInviteDigitalVerificationStatusPassed", "Security_UserInviteDigitalVerificationStatusFailed", "Security_UserInviteDigitalVerificationException", "Security_LoggedInUserDigitalVerificationStatusPassed", "Security_LoggedInUserDigitalVerificationStatusFailed", "Security_LoggedInUserDigitalVerificationException", "Security_MfaVerificationSessionRetrieved", "Security_MfaVerificationSessionRetrievedException", "Security_MfaClientRequestPhoneVerificationInitiated", "Security_MfaClientRequestPhoneVerificiationInitiatiedException", "Security_MfaClientRequestEmailVerificationInitiated", "Security_MfaClientRequestEmailVerificationInitiatedException", "Security_MfaUserInvitePhoneVerificationInitiated", "Security_MfaUserInvitePhoneVerificationInitiatedException", "Security_NoMfaSessionFound", "Security_MfaSessionFailed", "Security_MfaVerificationSessionDoesNotExistForSubjectId", "Security_MfaSessionVerificationAttemptsCapReached", "Security_MfaVerificationSessionAlreadyInFinalState", "Security_MfaVerificationSubsequentAttemptAfterSuccessfulAttempt", "Security_MfaVerificationSessionLocked", "Security_MfaSessionPassed", "Security_MfaSessionTryAgain", "Security_MfaVerificationSessionFaulted", "Security_MfaVerificationSessionException", "Security_KbaGetQuestionsActivitySessionDoesNotExist", "Security_KbaGetQuestionsLockedOut", "Security_KbaGetQuestionsNoQuestionsReturned", "Security_KbaGetQuestionReturnedQuestions", "Security_KbaGetQuestionsException", "Security_KbaSendAnswersActivitySessionDoesNotExist", "Security_KbaSendAnswersLockedOut", "Security_KbaSendAnswersTimeLimitReached", "Security_KbaSendAnswersReturnedFollowUpQuestions", "Security_KbaSendAnswersPassed", "Security_KbaSendAnswersFailed", "Security_KbaSendAnswersException", "Security_LoggedInUserActivitySessionRetrieved", "Security_LoggedInUserActivitySessionException", "Security_LoggedInUserActivitySessionCreated", "Security_LoggedInUserActivitySessionCreationException", "Security_LoggedInUserActivitySessionExtended", "Security_LoggedInUserActivitySessionExtensionException", "Security_ClientHubActivitySessionRetrieved", "Security_ClientHubActivitySessionException", "Security_ClientHubActivitySessionCreated", "Security_ClientHubActivitySessionCreationException", "Security_ClientHubActivitySessionExtended", "Security_ClientHubActivitySessionExtensionException", "Security_ClientHubRequestPhoneVerificationInitiated", "Security_ClientHubRequestPhoneVerificiationInitiatiedException", "Security_KbaGetQuestionsIndividualNotFound", "Auth0_GetAllAuth0UsersException", "Auth0_GetAllAuth0RolesException", "Auth0_GetAuth0UserByIdException", "Auth0_UpdateUseFailed_400", "Auth0_UpdateUserFailed_401", "Auth0_UpdateUserFailed_403", "Auth0_UpdateUserFailed_404", "Auth0_UpdateUserFailed_429", "Auth0_WebhookGetUserByIdException", "Auth0_WebhookAcknowledgeLoginException", "Auth0_WebhookAcknowledgePasswordChangeException", "Auth0_WebhookAcknowledgeUserDeleteException", "Auth0_WebhookGetActiveAttributesByUserIdException", "PublicApiService_WebhookCallFailed_IncrementFailure", "PublicApiService_WebhookCallSuccess_ResetFailure", "DocumentService_VirusFound", "DocumentService_DocumentNotFound", "DocumentService_PdfIntegrityFlagged", "DocumentService_PdfIntegrityScanUnavailable", "DocumentService_PdfIntegrityCannotScanEncrypted", "DocumentService_PdfIntegrityCannotScanMalformed", "Bff_MaxFileSizeExceeded", "Bff_FileTypeNotSupported", "Bff_PayoffIdNotProvided", "Bff_FileNameContainsInvalidCharacters", "Bff_AccessToPayoffForbidden", "Bff_PayoffNotFound", "Bff_PermissionToDeletePayoffStatementDenied", "Bff_CannotUploadPayoffStatementsToAPayoffInANonFinalizedStatus", "Bff_AccessToDocumentForbidden", "EventEngine_MissingApiKey", "EventEngine_InvalidApiKey", "EventEngine_InvalidJson", "EventEngine_NotAuthorized", "EventEngine_WriteFailed", "EventEngine_SchemaValidationFailed", "PaymentAccountsService_FetchSensitiveDataFailed", "PaymentAccountsService_UpdateSensitiveDataFailed", "PaymentAccountsService_FetchPaymentAccountsFailed", "PaymentAccountsService_UpdatePaymentAccountFailed", "PaymentAccountsService_DeletePaymentAccountFailed", "PaymentAccountsService_PaymentAccountNotFound", "PaymentAccountsService_PaymentAccountAlreadyExists", "PaymentAccountsService_PaymentAccountNotValid", "PaymentAccountsService_FetchPaymentWalletFailed", "PaymentAccountsService_UpdatePaymentWalletFailed", "PaymentAccountsService_DeletePaymentWalletFailed", "PaymentAccountsService_PaymentWalletNotFound", "PaymentAccountsService_PaymentWalletAlreadyExists", "PaymentAccountsService_PaymentWalletNotValid", "UnknownError" ], "type": "string" }, "CertifID.V2.PayoffOrdering.Common.Enums.PayoffAccountType": { "enum": [ "mortgage", "heloc" ], "type": "string" }, "CertifID.V2.PayoffOrdering.Common.Enums.PayoffOrderStatus": { "enum": [ "Pending", "InProgress", "SubmittedToLender", "Delivered", "Canceled", "Unorderable" ], "type": "string" }, "CertifID.V2.PayoffOrdering.Common.Models.FileAttachment": { "type": "object", "properties": { "fileName": { "type": "string" }, "contentType": { "type": "string" }, "base64Content": { "type": "string" } }, "additionalProperties": false }, "CertifID.V2.PayoffOrdering.Common.Models.IntegrationData": { "type": "object", "properties": { "fileId": { "type": "string" }, "type": { "type": "string" }, "fileNumber": { "type": "string" }, "integrationId": { "type": "string" } }, "additionalProperties": false }, "CertifID.V2.PayoffOrdering.Common.Models.LenderSummary": { "type": "object", "properties": { "lenderId": { "type": "string" }, "lenderName": { "type": "string" }, "lenderAliases": { "type": "array", "items": { "type": "string" } }, "lenderAddress": { "type": "string", "nullable": true }, "nmls": { "type": "string", "nullable": true }, "lenderNotes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertifID.V2.PayoffOrdering.Common.Models.PayoffOrder": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "string", "nullable": true }, "modified": { "type": "string", "format": "date-time", "nullable": true }, "modifiedBy": { "type": "string", "nullable": true }, "companyId": { "type": "string" }, "locationId": { "type": "string", "nullable": true }, "userId": { "type": "string" }, "status": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Enums.PayoffOrderStatus" }, "integrationData": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.IntegrationData" }, "createdAt": { "type": "string" }, "accountType": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Enums.PayoffAccountType" }, "fileNumber": { "type": "string" }, "loanNumber": { "type": "string" }, "lender": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrderLenderInfo" }, "borrowerFirstName": { "type": "string" }, "borrowerLastName": { "type": "string" }, "secondaryBorrowerFirstName": { "type": "string", "nullable": true }, "secondaryBorrowerLastName": { "type": "string", "nullable": true }, "fullPropertyAddress": { "type": "string" }, "goodThroughDate": { "type": "string" }, "specialInstructions": { "type": "string", "nullable": true }, "parentOrderId": { "type": "string", "nullable": true }, "childOrderId": { "type": "string", "nullable": true }, "borrowerAuthorizationUrl": { "type": "string", "nullable": true }, "orderAttachmentUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "payoffQuotes": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffQuote" } }, "payoffOrderEvents": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrderEvent" } }, "unstructuredOrderData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CertifID.V2.PayoffOrdering.Common.Models.PayoffOrderEvent": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "eventCode": { "type": "string" }, "eventDescription": { "type": "string" }, "eventType": { "type": "string" } }, "additionalProperties": false }, "CertifID.V2.PayoffOrdering.Common.Models.PayoffOrderLenderInfo": { "type": "object", "properties": { "lenderId": { "type": "string", "nullable": true }, "lenderName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertifID.V2.PayoffOrdering.Common.Models.PayoffQuote": { "type": "object", "properties": { "payoffQuoteUrl": { "type": "string" }, "wiringInstructionsVerified": { "type": "boolean" }, "totalPayoffAmount": { "type": "string" }, "wiringRoutingNumber": { "type": "string" }, "wiringAccountNumber": { "type": "string" }, "wiringBank": { "type": "string" }, "deliveredAt": { "type": "string", "format": "date-time" }, "quoteId": { "type": "string" }, "goodThroughDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.BusinessLogic.Models.Response.ResponseError": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "string" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.BusinessLogic.Models.Response.ResponseErrorCodes+CodeAndDetails": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "details": { "type": "string" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.BusinessLogic.Models.Response.ResponseServerInfo": { "type": "object", "properties": { "utcTime": { "type": "string", "format": "date-time", "readOnly": true }, "version": { "type": "string", "readOnly": true } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.BusinessLogic.Models.Response.Response`1[CertifID.V2.PublicAPI.BusinessLogic.Models.Response.ResponseErrorCodes+CodeAndDetails]": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.BusinessLogic.Models.Response.ResponseErrorCodes+CodeAndDetails" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.BusinessLogic.Models.Response.ResponseError" }, "nullable": true }, "serverInfo": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.BusinessLogic.Models.Response.ResponseServerInfo" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateErrorsRepresentation": { "type": "object", "properties": { "[fieldName1]": { "type": "array", "items": { "type": "string" }, "description": "Name of field containing errors, contains a list of error messages.", "readOnly": true }, "[fieldName2]": { "type": "array", "items": { "type": "string" }, "description": "Name of field containing errors, contains a list of error messages.", "readOnly": true } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateRepresentation": { "type": "object", "properties": { "type": { "type": "string", "description": "Type", "readOnly": true }, "title": { "type": "string", "description": "Title of the error response sent to user", "readOnly": true }, "status": { "$ref": "#/components/schemas/System.Net.HttpStatusCode" }, "traceId": { "type": "string", "description": "Trace ID", "readOnly": true }, "errors": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.Models.ResponseModels.ModelStateErrorsRepresentation" } }, "additionalProperties": false, "description": "" }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountRequestModel": { "type": "object", "properties": { "routingNumber": { "type": "string", "description": "ABA routing number.", "nullable": true }, "accountNumber": { "type": "string", "description": "Bank account number.", "nullable": true }, "accountName": { "type": "string", "description": "Name on the bank account.", "nullable": true } }, "additionalProperties": false, "description": "Bank account details on a verification request." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationResponseModel": { "type": "object", "properties": { "id": { "type": "string", "description": "Verification id, format \"av_...\".", "nullable": true }, "object": { "type": "string", "description": "Object discriminator.", "readOnly": true }, "status": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationStatus" }, "reasonCodes": { "type": "array", "items": { "type": "string" }, "description": "Stable, snake_case reason codes behind the status. They compose, and the list is empty\r\nwhile the verification is in flight.", "nullable": true }, "createdAt": { "type": "string", "description": "Creation timestamp.", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "description": "Last-update timestamp.", "format": "date-time", "nullable": true }, "completedAt": { "type": "string", "description": "Terminal timestamp. Null while the verification is in flight.", "format": "date-time", "nullable": true }, "canceledAt": { "type": "string", "description": "Cancellation timestamp. Null unless the verification was canceled.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Shared response shape for the create / retrieve / cancel account verification requests." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationStatus": { "enum": [ "InReview", "Certifid", "Verified", "Blocked", "Canceled", "UnableToDetermine" ], "type": "string", "description": "Status of a verification — the in-flight position and the terminal verdicts in a single\r\ndiscriminator. CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationStatus.InReview is non-terminal; the rest are terminal." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationUseCase": { "enum": [ "Payoff", "B2bWire", "ConsumerWire" ], "type": "string", "description": "Use case driving the verification. Determines which transaction context block\r\n(`transaction.payoff` or `transaction.b2bWire`) may be populated." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationsListQuery": { "type": "object", "properties": { "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The requested page size. Defaulted to 20. If PageSize is set to a value less than 20, it will be set to 20.", "format": "int32" }, "sortFields": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Paging.SortField" }, "description": "A list of fields to sort on.", "nullable": true }, "query": { "type": "string", "description": "Search text.", "nullable": true }, "zeroBasedPage": { "minimum": 0, "type": "integer", "description": "The requested page (zero based).", "format": "int32" }, "status": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationStatus" }, "useCase": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationUseCase" }, "partyType": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PartyType" }, "externalReferenceId": { "type": "string", "description": "Filter by the caller's external reference id.", "nullable": true }, "createdGte": { "type": "string", "description": "Filter: created_at greater than or equal.", "format": "date-time", "nullable": true }, "createdLte": { "type": "string", "description": "Filter: created_at less than or equal.", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Body for the search account verifications request. Inherits standard pagination\r\n(page size, page index, sort fields, free-text query) from CertifID.V2.PublicAPI.ViewModels.Requests.Api.Pagination.SimplePagedQuery." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AddressRequestModel": { "type": "object", "properties": { "line1": { "type": "string", "description": "Street line 1.", "nullable": true }, "line2": { "type": "string", "description": "Street line 2.", "nullable": true }, "city": { "type": "string", "description": "City / locality.", "nullable": true }, "state": { "type": "string", "description": "State / region.", "nullable": true }, "postalCode": { "type": "string", "description": "Postal / ZIP code.", "nullable": true }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code. Defaults to US when absent.", "nullable": true } }, "additionalProperties": false, "description": "Postal address." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.B2BWireContextRequestModel": { "type": "object", "properties": { "notes": { "type": "string", "description": "Free-form additional instructions for the disbursement.", "nullable": true }, "underwriter": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.DisbursementUnderwriterRequestModel" }, "onBehalfOf": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.DisbursementPartyRequestModel" }, "description": "Parties the wire is sent on behalf of.", "nullable": true }, "industry": { "type": "string", "description": "Industry classification of the recipient business.", "nullable": true } }, "additionalProperties": false, "description": "Business-wire-specific transaction context." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.BusinessPartyRequestModel": { "type": "object", "properties": { "legalName": { "type": "string", "description": "Registered legal name.", "nullable": true }, "aliases": { "type": "array", "items": { "type": "string" }, "description": "Doing-business-as / trade-name aliases.", "nullable": true }, "registrations": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.BusinessRegistrationRequestModel" }, "description": "Business registrations (NMLS, LEI, DUNS). A single business may hold multiple registrations;\r\npass as many as are held and the verification service uses the strongest signal it can match.", "nullable": true }, "taxId": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.BusinessTaxIdRequestModel" }, "address": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AddressRequestModel" }, "phone": { "type": "string", "description": "Business phone.", "nullable": true }, "email": { "type": "string", "description": "Business email.", "nullable": true }, "website": { "type": "string", "description": "Business website.", "nullable": true } }, "additionalProperties": false, "description": "A business / commercial party." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.BusinessRegistrationRequestModel": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.BusinessRegistrationType" }, "value": { "type": "string", "description": "Registration identifier.", "nullable": true } }, "additionalProperties": false, "description": "Business registration descriptor." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.BusinessRegistrationType": { "enum": [ "Nmls", "Lei", "Duns" ], "type": "string", "description": "Business registration identifier type. Distinct from the tax id (EIN): a registration is a\r\nnon-tax identifier issued by another regulator." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.BusinessTaxIdRequestModel": { "type": "object", "properties": { "value": { "type": "string", "description": "The EIN value.", "nullable": true }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the issuing jurisdiction. Defaults to US when absent.", "nullable": true } }, "additionalProperties": false, "description": "Employer Identification Number for a business party." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.CreateAccountVerificationRequestModel": { "required": [ "account", "externalReference", "party", "useCase" ], "type": "object", "properties": { "useCase": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationUseCase" }, "account": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountRequestModel" }, "party": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PartyRequestModel" }, "transaction": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.TransactionRequestModel" }, "externalReference": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.ExternalReferenceRequestModel" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form customer metadata (≤16 keys).", "nullable": true } }, "additionalProperties": false, "description": "Body for the create account verification request." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.DisbursementPartyRequestModel": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.DisbursementPartyType" }, "firstName": { "type": "string", "description": "First name; populated for a person.", "nullable": true }, "lastName": { "type": "string", "description": "Last name; populated for a person.", "nullable": true }, "entityName": { "type": "string", "description": "Entity name; populated for an entity.", "nullable": true } }, "additionalProperties": false, "description": "A party a disbursement is made on behalf of (a borrower or on-behalf-of party)." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.DisbursementPartyType": { "enum": [ "Person", "Entity" ], "type": "string", "description": "Kind of party a disbursement is made on behalf of." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.DisbursementUnderwriterRequestModel": { "type": "object", "properties": { "id": { "type": "string", "description": "Underwriter id.", "nullable": true }, "name": { "type": "string", "description": "Underwriter name.", "nullable": true } }, "additionalProperties": false, "description": "Title underwriter on a disbursement." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.ExternalReferenceRequestModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The record id in the caller's system (e.g. a file number).", "nullable": true } }, "additionalProperties": false, "description": "Reference to the record in the caller's own system." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.IndividualPartyRequestModel": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PersonNameRequestModel" }, "taxId": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.IndividualTaxIdRequestModel" }, "dateOfBirth": { "type": "string", "description": "Date of birth.", "format": "date", "nullable": true }, "address": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AddressRequestModel" }, "phone": { "type": "string", "description": "Phone (E.164).", "nullable": true }, "email": { "type": "string", "description": "Email.", "nullable": true } }, "additionalProperties": false, "description": "An individual / consumer party." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.IndividualTaxIdRequestModel": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.IndividualTaxIdType" }, "value": { "type": "string", "description": "The tax id value.", "nullable": true } }, "additionalProperties": false, "description": "Tax identifier for an individual party." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.IndividualTaxIdType": { "enum": [ "Ssn", "Itin" ], "type": "string", "description": "Tax id type for an individual party." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PartyRequestModel": { "type": "object", "properties": { "individual": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.IndividualPartyRequestModel" }, "business": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.BusinessPartyRequestModel" } }, "additionalProperties": false, "description": "The owning party — exactly one of CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PartyRequestModel.Individual or CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PartyRequestModel.Business must be set.\r\nThe party type is inferred from which one is populated." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PartyType": { "enum": [ "Individual", "Business" ], "type": "string", "description": "The party type. On the request side it is inferred from whether `party.individual`\r\nor `party.business` is populated; it is also a search filter." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PaymentRail": { "enum": [ "Wire", "Ach", "Rtp", "FedNow" ], "type": "string", "description": "Payment rail the transaction under verification moves on." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PayoffContextRequestModel": { "type": "object", "properties": { "notes": { "type": "string", "description": "Free-form additional instructions for the disbursement.", "nullable": true }, "underwriter": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.DisbursementUnderwriterRequestModel" }, "goodThroughDate": { "type": "string", "description": "Date through which the payoff quote is valid.", "format": "date", "nullable": true }, "perDiemAmount": { "type": "number", "description": "Per-diem interest that accrues after the good-through date.", "format": "double", "nullable": true }, "loanNumber": { "type": "string", "description": "Loan / account number at the payoff servicer.", "nullable": true }, "loanType": { "type": "string", "description": "Loan type descriptor.", "nullable": true }, "borrowers": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.DisbursementPartyRequestModel" }, "description": "Borrowers on the loan being paid off.", "nullable": true }, "propertyAddress": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AddressRequestModel" } }, "additionalProperties": false, "description": "Payoff-specific transaction context." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PersonNameRequestModel": { "type": "object", "properties": { "first": { "type": "string", "description": "First / given name.", "nullable": true }, "last": { "type": "string", "description": "Last / family name.", "nullable": true } }, "additionalProperties": false, "description": "Person name pair." }, "CertifID.V2.PublicAPI.ViewModels.AccountVerifications.TransactionRequestModel": { "type": "object", "properties": { "amount": { "type": "number", "description": "Transaction amount in CertifID.V2.PublicAPI.ViewModels.AccountVerifications.TransactionRequestModel.Currency.", "format": "double", "nullable": true }, "currency": { "type": "string", "description": "ISO 4217 currency code.", "nullable": true }, "paymentRail": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PaymentRail" }, "referenceNumber": { "type": "string", "description": "Secondary reference number (e.g. a case or file number).", "nullable": true }, "payoff": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.PayoffContextRequestModel" }, "b2bWire": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.B2BWireContextRequestModel" } }, "additionalProperties": false, "description": "Optional transaction context for the verification." }, "CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails": { "required": [ "abaRoutingNumber" ], "type": "object", "properties": { "abaRoutingNumber": { "minLength": 1, "type": "string", "description": "The bank's ABA/routing number.", "example": "111904943" }, "institutionFullName": { "type": "string", "description": "The bank's full name.", "example": "Texas Bank" }, "streetAddress": { "maxLength": 150, "minLength": 0, "type": "string", "description": "The bank's street address.", "example": "1120 US Hwy 79 N" }, "city": { "maxLength": 27, "minLength": 0, "type": "string", "description": "The bank's city.", "example": "Henderson" }, "state": { "type": "string", "description": "The bank's state.", "example": "TX" }, "zipCode": { "type": "string", "description": "The bank's ZIP code.", "example": "75652" }, "phoneNumber": { "type": "string", "description": "The bank's phone number.", "example": "9036571466" }, "bankWireStatus": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankWireStatusType" } }, "additionalProperties": false, "description": "Details about a bank." }, "CertifID.V2.PublicAPI.ViewModels.Banks.BankWireStatusType": { "enum": [ "Unknown", "Valid", "CannotTransactWiresElectronically", "CannotTransactWires" ], "type": "string" }, "CertifID.V2.PublicAPI.ViewModels.Banks.BankWiringDetailsViewModel": { "type": "object", "properties": { "beneficiaryBank": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails" }, "correspondentBank": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.CorrespondentBankDetails" } }, "additionalProperties": false, "description": "Wiring details for a bank." }, "CertifID.V2.PublicAPI.ViewModels.Banks.CorrespondentBankDetails": { "required": [ "abaRoutingNumber" ], "type": "object", "properties": { "abaRoutingNumber": { "minLength": 1, "type": "string", "description": "The bank's ABA/routing number.", "example": "111904943" }, "institutionFullName": { "type": "string", "description": "The bank's full name.", "example": "Texas Bank" }, "streetAddress": { "maxLength": 150, "minLength": 0, "type": "string", "description": "The bank's street address.", "example": "1120 US Hwy 79 N" }, "city": { "maxLength": 27, "minLength": 0, "type": "string", "description": "The bank's city.", "example": "Henderson" }, "state": { "type": "string", "description": "The bank's state.", "example": "TX" }, "zipCode": { "type": "string", "description": "The bank's ZIP code.", "example": "75652" }, "phoneNumber": { "type": "string", "description": "The bank's phone number.", "example": "9036571466" }, "bankWireStatus": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankWireStatusType" }, "achWithBeneficiaryFedwire": { "type": "boolean", "description": "The correspondent ABA Routing Number is an ACH, but the bank has\r\na Fedwire ABA Routing Number as a beneficiary." } }, "additionalProperties": false, "description": "Correspondent bank details related to a beneficiary ABA Routing Number." }, "CertifID.V2.PublicAPI.ViewModels.Locations.LocationViewModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the account." }, "name": { "type": "string", "description": "The name given to identify the account/office by the customer within their organization.", "example": "South Bank - Central Office" }, "companyId": { "type": "string", "description": "The ID of parent account that this child account is organized under within the customer's organization.", "nullable": true }, "isDefault": { "type": "boolean", "description": "A flag indicating whether the account is selected as the user's default." } }, "additionalProperties": false, "description": "An account/location within the CertifID platform, often representing a single agency or office\r\nlocation within a customer's organization." }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.CollectRequestDetailsViewModel]": { "required": [ "recipient" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "The unique identifier for the account/location within the customer's organization in CertifID's platform from which the\r\nrequest is being sent.\r\nIf not specified, the customer's default or current account will be selected initially.", "nullable": true, "example": "00000000-0000-0000-0000-000000000001" }, "fileNumber": { "maxLength": 254, "type": "string", "description": "A file number identifying a deal/file in the 3rd party system, such as a mortgage\r\norigination system.", "nullable": true, "example": "A4242" }, "transactionId": { "maxLength": 254, "type": "string", "description": "A given transaction id for a CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1.FileNumber from the 3rd party origination system.", "nullable": true, "example": "20336491" }, "recipient": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.Party" }, "requestDetails": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.CollectRequestDetailsViewModel" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.ConfirmRequestDetailsViewModel]": { "required": [ "recipient" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "The unique identifier for the account/location within the customer's organization in CertifID's platform from which the\r\nrequest is being sent.\r\nIf not specified, the customer's default or current account will be selected initially.", "nullable": true, "example": "00000000-0000-0000-0000-000000000001" }, "fileNumber": { "maxLength": 254, "type": "string", "description": "A file number identifying a deal/file in the 3rd party system, such as a mortgage\r\norigination system.", "nullable": true, "example": "A4242" }, "transactionId": { "maxLength": 254, "type": "string", "description": "A given transaction id for a CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1.FileNumber from the 3rd party origination system.", "nullable": true, "example": "20336491" }, "recipient": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.Party" }, "requestDetails": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.ConfirmRequestDetailsViewModel" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.IdentityRequestDetailsViewModel]": { "required": [ "recipient" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "The unique identifier for the account/location within the customer's organization in CertifID's platform from which the\r\nrequest is being sent.\r\nIf not specified, the customer's default or current account will be selected initially.", "nullable": true, "example": "00000000-0000-0000-0000-000000000001" }, "fileNumber": { "maxLength": 254, "type": "string", "description": "A file number identifying a deal/file in the 3rd party system, such as a mortgage\r\norigination system.", "nullable": true, "example": "A4242" }, "transactionId": { "maxLength": 254, "type": "string", "description": "A given transaction id for a CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1.FileNumber from the 3rd party origination system.", "nullable": true, "example": "20336491" }, "recipient": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.Party" }, "requestDetails": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.IdentityRequestDetailsViewModel" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.SendRequestDetailsViewModel]": { "required": [ "recipient" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "The unique identifier for the account/location within the customer's organization in CertifID's platform from which the\r\nrequest is being sent.\r\nIf not specified, the customer's default or current account will be selected initially.", "nullable": true, "example": "00000000-0000-0000-0000-000000000001" }, "fileNumber": { "maxLength": 254, "type": "string", "description": "A file number identifying a deal/file in the 3rd party system, such as a mortgage\r\norigination system.", "nullable": true, "example": "A4242" }, "transactionId": { "maxLength": 254, "type": "string", "description": "A given transaction id for a CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1.FileNumber from the 3rd party origination system.", "nullable": true, "example": "20336491" }, "recipient": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.Party" }, "requestDetails": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.SendRequestDetailsViewModel" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.CollectRequestDetailsViewModel": { "type": "object", "properties": { "underwriterId": { "type": "string", "description": "The ID of the title underwriter to associate with the request.", "nullable": true }, "transactionAmount": { "type": "number", "description": "The monetary amount of the transaction that the wiring instructions are for.", "format": "double", "nullable": true, "example": 50000 }, "expectedSettlementDate": { "type": "string", "description": "Expected closing date.", "format": "date-time", "nullable": true }, "propertyAddress": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PropertyAddress" } }, "additionalProperties": false, "description": "A request to collect wiring instructions from a recipient (seller or real estate deal)." }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.ConfirmRequestDetailsViewModel": { "type": "object", "properties": { "underwriterId": { "type": "string", "description": "The ID of the title underwriter to associate with the request.", "nullable": true }, "transactionAmount": { "type": "number", "description": "The monetary amount of the transaction that the wiring instructions are for.", "format": "double", "nullable": true, "example": 50000 }, "expectedSettlementDate": { "type": "string", "description": "Expected closing date.", "format": "date-time", "nullable": true }, "propertyAddress": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PropertyAddress" }, "beneficiaryAba": { "maxLength": 9, "minLength": 0, "type": "string", "description": "The ABA routing number of the beneficiary bank being confirmed.", "example": "026009593" }, "correspondentAba": { "maxLength": 9, "minLength": 0, "type": "string", "description": "The ABA routing number of the correspondent bank being confirmed.", "nullable": true, "example": "026009593" }, "creditToName": { "maxLength": 55, "minLength": 0, "type": "string", "description": "The account name the credit is to be addressed to.", "nullable": true, "example": "CertifID GP" }, "creditToAccountNumber": { "maxLength": 26, "minLength": 0, "type": "string", "description": "The account number the credit is to be addressed to.", "nullable": true, "example": "8675309" }, "finalCreditToName": { "maxLength": 55, "minLength": 0, "type": "string", "description": "The account name the final credit is to be addressed to.", "nullable": true, "example": "Final" }, "finalCreditToAccountNumber": { "maxLength": 26, "minLength": 0, "type": "string", "description": "The account number the final credit is to be addressed to.", "nullable": true, "example": "903528434" } }, "additionalProperties": false, "description": "A request to collect wiring instructions from a recipient (seller or real estate deal)." }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.IdentityRequestDetailsViewModel": { "required": [ "deliveryMethod" ], "type": "object", "properties": { "underwriterId": { "type": "string", "description": "The ID of the title underwriter to associate with the request.", "nullable": true }, "propertyAddress": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PropertyAddress" }, "deliveryMethod": { "minLength": 1, "type": "string", "description": "The method by which identity is to be verified.", "example": "email_or_text" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.CancelPayoffOrderRequestModel": { "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string" }, "cancellationReason": { "type": "string", "description": "Optional reason for canceling the order", "nullable": true } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.CreatePayoffOrderRequestModel": { "required": [ "borrowerFirstName", "borrowerLastName", "borrowerSsn", "fileNumber", "fullPropertyAddress", "goodThroughDate", "loanNumber", "locationId" ], "type": "object", "properties": { "accountType": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Enums.PayoffAccountType" }, "borrowerFirstName": { "minLength": 1, "type": "string" }, "borrowerLastName": { "minLength": 1, "type": "string" }, "borrowerSsn": { "minLength": 1, "pattern": "^\\d{4}$", "type": "string" }, "fileNumber": { "minLength": 1, "type": "string" }, "transactionId": { "type": "string", "nullable": true }, "fullPropertyAddress": { "minLength": 1, "type": "string" }, "goodThroughDate": { "type": "string", "format": "date" }, "loanNumber": { "minLength": 1, "type": "string" }, "integrationOrderChannel": { "type": "string", "nullable": true }, "locationId": { "minLength": 1, "type": "string" }, "fileUnderwriterId": { "type": "string", "nullable": true }, "integrationChannelUserId": { "type": "string", "nullable": true }, "lenderId": { "type": "string", "nullable": true }, "rawLenderName": { "type": "string", "nullable": true }, "secondaryBorrowerFirstName": { "type": "string", "nullable": true }, "secondaryBorrowerLastName": { "type": "string", "nullable": true }, "secondaryBorrowerSsn": { "pattern": "^\\d{4}$", "type": "string", "nullable": true }, "specialInstructions": { "type": "string", "nullable": true }, "unstructuredOrderData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "borrowerAuth": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.FileAttachmentWithValidation" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.FileAttachmentWithValidation" }, "nullable": true } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.FileAttachmentWithValidation": { "required": [ "base64Content", "contentType", "fileName" ], "type": "object", "properties": { "fileName": { "minLength": 1, "pattern": "^.+\\.pdf$", "type": "string" }, "contentType": { "minLength": 1, "pattern": "^application/pdf$", "type": "string" }, "base64Content": { "minLength": 1, "type": "string", "format": "byte" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffOrdering.UpdatePayoffOrderRequestModel": { "required": [ "id" ], "type": "object", "properties": { "id": { "minLength": 1, "type": "string" }, "accountType": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Enums.PayoffAccountType" }, "borrowerFirstName": { "type": "string", "nullable": true }, "borrowerLastName": { "type": "string", "nullable": true }, "borrowerSsn": { "type": "string", "nullable": true }, "fileNumber": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true }, "fullPropertyAddress": { "type": "string", "nullable": true }, "goodThroughDate": { "type": "string", "nullable": true }, "integrationOrderChannel": { "type": "string", "nullable": true }, "loanNumber": { "type": "string", "nullable": true }, "fileUnderwriterId": { "type": "string", "nullable": true }, "integrationChannelUserId": { "type": "string", "nullable": true }, "lenderId": { "type": "string", "nullable": true }, "rawLenderName": { "type": "string", "nullable": true }, "secondaryBorrowerFirstName": { "type": "string", "nullable": true }, "secondaryBorrowerLastName": { "type": "string", "nullable": true }, "secondaryBorrowerSsn": { "type": "string", "nullable": true }, "specialInstructions": { "type": "string", "nullable": true }, "unstructuredOrderData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true }, "borrowerAuth": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.FileAttachment" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.FileAttachment" }, "nullable": true }, "locationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.BorrowerRequestModel": { "required": [ "type" ], "type": "object", "properties": { "entityName": { "type": "string", "description": "Entity Name" }, "firstName": { "type": "string", "description": "First Name" }, "lastName": { "type": "string", "description": "Last Name" }, "type": { "$ref": "#/components/schemas/CertifID.MortgagePayoff.Common.Models.Borrowers.BorrowerType" } }, "additionalProperties": false, "description": "Payoff Protect Borrower" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.CreatePayoffProtectRequestModel": { "required": [ "accountId", "bankAccountNumber", "borrowers", "lender", "loan", "propertyAddress" ], "type": "object", "properties": { "accountId": { "minLength": 1, "type": "string", "description": "Account Id. This is called Location Id in V2, but called AccountId here for backwards compatibility." }, "underwriterId": { "type": "string", "description": "UnderwriterId", "nullable": true }, "underwriter": { "type": "string", "description": "Underwriter Name. This is resolved by the ID if ID is valid, If not then we will use this Name for things like\r\nNone, Not Listed", "nullable": true }, "bankAccountNumber": { "minLength": 1, "pattern": "^[a-zA-Z0-9-]{1,26}$", "type": "string", "description": "Bank Account Number" }, "beneficiaryBank": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffProtectBeneficiaryBankRequestModel" }, "borrowers": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.BorrowerRequestModel" }, "description": "Borrowers on the transaction" }, "fileNumber": { "type": "string", "description": "File Number", "nullable": true }, "lender": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffProtectLenderRequestModel" }, "loan": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffProtectLoanRequestModel" }, "propertyAddress": { "minLength": 1, "type": "string", "description": "Property Address" }, "externalPartyId": { "type": "string", "description": "This ID is used to identify integrations from external parties; it is not a CertifID ID", "nullable": true }, "sourceTPS": { "type": "string", "description": "Which SMKT TPS is requesting a PayOff", "nullable": true } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.EditPayoffProtectRequestModel": { "required": [ "accountId", "bankAccountNumber", "borrowers", "disbursementId", "lender", "loan", "propertyAddress" ], "type": "object", "properties": { "accountId": { "minLength": 1, "type": "string", "description": "Account Id. This is called Location Id in V2, but called AccountId here for backwards compatibility." }, "underwriterId": { "type": "string", "description": "UnderwriterId", "nullable": true }, "underwriter": { "type": "string", "description": "Underwriter Name. This is resolved by the ID if ID is valid, If not then we will use this Name for things like\r\nNone, Not Listed", "nullable": true }, "bankAccountNumber": { "minLength": 1, "pattern": "^[a-zA-Z0-9-]{1,26}$", "type": "string", "description": "Bank Account Number" }, "beneficiaryBank": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffProtectBeneficiaryBankRequestModel" }, "borrowers": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.BorrowerRequestModel" }, "description": "Borrowers on the transaction" }, "fileNumber": { "type": "string", "description": "File Number", "nullable": true }, "lender": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffProtectLenderRequestModel" }, "loan": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffProtectLoanRequestModel" }, "propertyAddress": { "minLength": 1, "type": "string", "description": "Property Address" }, "externalPartyId": { "type": "string", "description": "This ID is used to identify integrations from external parties; it is not a CertifID ID", "nullable": true }, "sourceTPS": { "type": "string", "description": "Which SMKT TPS is requesting a PayOff", "nullable": true }, "disbursementId": { "minLength": 1, "type": "string", "description": "Payoff Protect ID" } }, "additionalProperties": false, "description": "Request model for updating a Payoff Protect" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.GetDisbursementFieldsFromStatementRequestModel": { "required": [ "base64Data", "fileName", "mimeType" ], "type": "object", "properties": { "fileName": { "minLength": 1, "type": "string", "description": "Name of the file being uploaded" }, "mimeType": { "minLength": 1, "type": "string", "description": "What type of file this is. \r\nAcceptable values are: \"application/pdf\" (.pdf)" }, "base64Data": { "minLength": 1, "type": "string", "description": "The file data. File size limited to 20mb or less." }, "accountId": { "type": "string", "description": "Account id also known as LocationId. This field is OPTIONAL.", "nullable": true } }, "additionalProperties": false, "description": "Request model for getting disbursement fields from a statement" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffProtectBeneficiaryBankRequestModel": { "required": [ "abaRoutingNumber", "bankName" ], "type": "object", "properties": { "abaRoutingNumber": { "minLength": 1, "type": "string", "allOf": [ { "pattern": "^[0-9]{9}$" }, { "pattern": "^[0-9]{9}$" }, { "pattern": "^[0-9]{9}$" } ], "description": "Bank's ABA Routing Number" }, "bankName": { "type": "string", "description": "Bank Name" } }, "additionalProperties": false, "description": "Beneficiary Bank information used for Payoff Protect" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffProtectLenderRequestModel": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "ID of the Lender - If consumer of this endpoint does not have a Lender ID, please keep this empty. If this is populated, it will be \r\nvalidated against to ensure the Lender ID is an existing Lender in CertifID's system.", "nullable": true }, "name": { "minLength": 1, "type": "string", "description": "Name of the Lender" } }, "additionalProperties": false, "description": "View model to contain Payoff Protect Lender details" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffProtectLoanRequestModel": { "required": [ "amount", "number" ], "type": "object", "properties": { "amount": { "maximum": 79228162514264337593543950335, "exclusiveMaximum": true, "minimum": 0, "exclusiveMinimum": true, "type": "number", "description": "Loan Amount", "format": "double" }, "number": { "minLength": 1, "type": "string", "description": "Loan Number" }, "type": { "type": "string", "description": "Type - typical values are but can be any value: ['Residential Mortgage', 'HELOC', 'Commercial Mortgage' , 'Other']", "nullable": true } }, "additionalProperties": false, "description": "Request model for a Payoff Protect Loan" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.PayoffSimplePagedQuery": { "type": "object", "properties": { "pageSize": { "maximum": 8000, "type": "integer", "description": "The requested page size. Defaulted to 20. If PageSize is set to a value less than 20, it will be set to 20.", "format": "int32" }, "zeroBasedPage": { "type": "integer", "description": "The requested page (zero based).", "format": "int32" }, "query": { "type": "string", "description": "This text field will search for the following fields that contain this optional Query value: Status, Created By (full name of the user), \r\nFile Number, Lender Name, Property Address, Beneficiary Bank's Name, Beneficiary Bank's routing number, Loan Number, \r\nBorrowers (first name, last name or full name)", "nullable": true }, "sortFields": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Paging.SortField" }, "description": "A list of fields to sort on.\r\nAccepted values are (case sensitive): status, created, lenderName, createdBy, primary borrower (primary sorting on last name, secondary sorting on first name), isMyRequest", "nullable": true } }, "additionalProperties": false, "description": "Pagination used for Payoff Protects" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.PayoffProtect.UploadDisbursementDocumentModel": { "required": [ "base64Data", "disbursementId", "fileName", "mimeType" ], "type": "object", "properties": { "fileName": { "minLength": 1, "type": "string", "description": "Name of the file being uploaded" }, "mimeType": { "type": "string", "description": "What type of file this is. \r\nAcceptable values are: \"application/pdf\" (.pdf)" }, "base64Data": { "minLength": 1, "type": "string", "description": "The file data. File size limited to 20mb or less." }, "disbursementId": { "minLength": 1, "type": "string", "description": "Disbursement (Payoff) ID" } }, "additionalProperties": false, "description": "Inbound model which contains data of a disbursement (payoff) statement to be uploaded and save \r\nto certifID's system" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Inbound.SendRequestDetailsViewModel": { "type": "object", "properties": { "underwriterId": { "type": "string", "description": "The ID of the title underwriter to associate with the request.", "nullable": true }, "transactionAmount": { "type": "number", "description": "The monetary amount of the transaction that the wiring instructions are for.", "format": "double", "nullable": true, "example": 50000 }, "expectedSettlementDate": { "type": "string", "description": "Expected closing date.", "format": "date-time", "nullable": true }, "propertyAddress": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PropertyAddress" }, "bankInformationId": { "type": "string", "description": "The ID of the bank information to send.", "nullable": true }, "includeEarnestMoneyAccounts": { "type": "boolean", "description": "A flag indicating whether or not to include the earnest money \r\naccounts bank information with the request.", "example": false } }, "additionalProperties": false, "description": "A request to send an organization's bank information to a recipient." }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PublicIdentityRequestStatus" }, "verificationDetails": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.VerificationDetails" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel": { "type": "object", "properties": { "underwriterId": { "type": "string", "description": "The ID of the title underwriter to associate with the request.", "nullable": true }, "transactionAmount": { "type": "number", "description": "The monetary amount of the transaction that the wiring instructions are for.", "format": "double", "nullable": true, "example": 50000 }, "expectedSettlementDate": { "type": "string", "description": "Expected closing date.", "format": "date-time", "nullable": true }, "propertyAddress": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PropertyAddress" }, "status": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PublicRequestStatus" }, "rejectFeedback": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.RejectFeedback" }, "beneficiaryAba": { "maxLength": 9, "minLength": 0, "type": "string", "description": "The ABA routing number of the beneficiary bank being confirmed.", "nullable": true, "example": "091000019" }, "correspondentAba": { "maxLength": 9, "minLength": 0, "type": "string", "description": "The ABA routing number of the correspondent bank being confirmed.", "nullable": true, "example": "011401533" }, "creditToName": { "maxLength": 55, "minLength": 0, "type": "string", "description": "The account name the credit is to be addressed to.", "nullable": true, "example": "CertifID GP" }, "creditToAccountNumber": { "maxLength": 26, "minLength": 0, "type": "string", "description": "The account number the credit is to be addressed to.", "nullable": true, "example": "867530-9" }, "finalCreditToName": { "maxLength": 55, "minLength": 0, "type": "string", "description": "The account name the final credit is to be addressed to.", "nullable": true, "example": "Final" }, "finalCreditToAccountNumber": { "maxLength": 26, "minLength": 0, "type": "string", "description": "The account number the final credit is to be addressed to.", "nullable": true, "example": "903576-8" }, "createdUtc": { "type": "string", "description": "The date and time when Request was created.", "format": "date-time" }, "expiresOnUtc": { "type": "string", "description": "The date and time when the request gets expired if the recipient do not act on it.", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.Lender.LenderResponseModel": { "type": "object", "properties": { "city": { "type": "string", "description": "City", "nullable": true }, "id": { "type": "string", "description": "Id" }, "name": { "type": "string", "description": "Name" }, "propertyAddress": { "type": "string", "description": "Property Address of the lender", "nullable": true }, "state": { "type": "string", "description": "State", "nullable": true }, "zip": { "type": "string", "description": "Zipcode", "nullable": true } }, "additionalProperties": false, "description": "Lender response model" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel]": { "required": [ "recipient" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "The unique identifier for the account/location within the customer's organization in CertifID's platform from which the\r\nrequest is being sent.\r\nIf not specified, the customer's default or current account will be selected initially.", "nullable": true, "example": "00000000-0000-0000-0000-000000000001" }, "fileNumber": { "maxLength": 254, "type": "string", "description": "A file number identifying a deal/file in the 3rd party system, such as a mortgage\r\norigination system.", "nullable": true, "example": "A4242" }, "transactionId": { "maxLength": 254, "type": "string", "description": "A given transaction id for a CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1.FileNumber from the 3rd party origination system.", "nullable": true, "example": "20336491" }, "recipient": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.Party" }, "requestDetails": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiIdentityRequestViewModel" }, "id": { "type": "string", "description": "A unique identifier for this request, provided by the CertifID platform." } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.OutboundRequest`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel]": { "required": [ "recipient" ], "type": "object", "properties": { "accountId": { "type": "string", "description": "The unique identifier for the account/location within the customer's organization in CertifID's platform from which the\r\nrequest is being sent.\r\nIf not specified, the customer's default or current account will be selected initially.", "nullable": true, "example": "00000000-0000-0000-0000-000000000001" }, "fileNumber": { "maxLength": 254, "type": "string", "description": "A file number identifying a deal/file in the 3rd party system, such as a mortgage\r\norigination system.", "nullable": true, "example": "A4242" }, "transactionId": { "maxLength": 254, "type": "string", "description": "A given transaction id for a CertifID.V2.PublicAPI.ViewModels.Requests.Api.ApiRequestViewModel`1.FileNumber from the 3rd party origination system.", "nullable": true, "example": "20336491" }, "recipient": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.Party" }, "requestDetails": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.ApiRequestDetailsViewModel" }, "id": { "type": "string", "description": "A unique identifier for this request, provided by the CertifID platform." } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.CancelPayoffOrderResponseModel": { "type": "object", "properties": { "orderId": { "type": "string", "description": "The IPO system identifier of the canceled order" }, "status": { "type": "string", "description": "The status of the order after cancellation" }, "message": { "type": "string" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.PayoffOrderEventModel": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "eventCode": { "type": "string" }, "eventDescription": { "type": "string" }, "eventType": { "type": "string" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.PayoffOrderModel": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "createdUtc": { "type": "string", "format": "date-time", "nullable": true }, "modifiedUtc": { "type": "string", "format": "date-time", "nullable": true }, "accountId": { "type": "string", "description": "This is the location id. Integrations have historically called this accountId", "nullable": true }, "status": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Enums.PayoffOrderStatus" }, "accountType": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Enums.PayoffAccountType" }, "fileNumber": { "type": "string" }, "transactionId": { "type": "string", "nullable": true }, "loanNumber": { "type": "string" }, "lender": { "$ref": "#/components/schemas/CertifID.V2.PayoffOrdering.Common.Models.PayoffOrderLenderInfo" }, "borrowerFirstName": { "type": "string" }, "borrowerLastName": { "type": "string" }, "secondaryBorrowerFirstName": { "type": "string", "nullable": true }, "secondaryBorrowerLastName": { "type": "string", "nullable": true }, "fullPropertyAddress": { "type": "string" }, "goodThroughDate": { "type": "string" }, "specialInstructions": { "type": "string", "nullable": true }, "parentOrderId": { "type": "string", "nullable": true }, "childOrderId": { "type": "string", "nullable": true }, "borrowerAuthorizationUrl": { "type": "string", "nullable": true }, "orderAttachmentUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "payoffOrderEvents": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.PayoffOrderEventModel" } }, "payoffQuotes": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.PayoffQuoteModel" } }, "unstructuredOrderData": { "type": "object", "additionalProperties": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffOrdering.PayoffQuoteModel": { "type": "object", "properties": { "wiringInstructionsVerified": { "type": "boolean", "description": "Indicates whether the wiring instructions have been verified" }, "totalPayoffAmount": { "type": "string", "description": "The total payoff amount" }, "wiringRoutingNumber": { "type": "string", "description": "The ABA routing number for wiring funds" }, "wiringAccountNumber": { "type": "string", "description": "The account number for wiring funds" }, "wiringBank": { "type": "string", "description": "The bank name for wiring funds" }, "deliveredAt": { "type": "string", "format": "date-time" }, "quoteId": { "type": "string" }, "goodThroughDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.BorrowerResponseModel": { "type": "object", "properties": { "entityName": { "type": "string", "description": "Entity Name" }, "firstName": { "type": "string", "description": "First Name" }, "lastName": { "type": "string", "description": "Last Name" }, "type": { "$ref": "#/components/schemas/CertifID.MortgagePayoff.Common.Models.Borrowers.BorrowerType" } }, "additionalProperties": false, "description": "Payoff Protect Borrower" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.DisbursementStatementUploadResponseModel": { "type": "object", "additionalProperties": false, "description": "Outbound model which contains data about the disbursement (payoff) statement upload action" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.GetDisbursementFieldsFromStatementResponseModel": { "type": "object", "properties": { "lenderName": { "type": "string", "description": "Lender Name" }, "loanAmount": { "type": "string", "description": "Loan Amount" }, "propertyAddress": { "type": "string", "description": "Property Address" }, "borrowerFirstName": { "type": "string", "description": "Borrower First Name" }, "borrowerLastName": { "type": "string", "description": "Borrower Last Name" }, "borrowerEntityName": { "type": "string", "description": "Borrower Entity Name" }, "loanType": { "type": "string", "description": "Loan Type" }, "routingNumber": { "type": "string", "description": "Routing Number" }, "accountNumber": { "type": "string", "description": "Account Number" }, "loanNumber": { "type": "string", "description": "Loan Number" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.GetDisbursementStatementsResponseModel": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time" }, "entityId": { "type": "string", "description": "Entity ID of the document", "nullable": true }, "expiresOn": { "type": "string", "description": "Date and time the document expires at", "format": "date-time", "nullable": true }, "id": { "type": "string", "description": "ID of the document" }, "mimeType": { "type": "string", "description": "Mime Type", "nullable": true }, "name": { "type": "string", "description": "Name of the file", "nullable": true }, "isDeleted": { "type": "boolean", "description": "Determine if this Document is marked as deleted (soft delete; data still exists in database)" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectLenderResponseModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The resolved Lender's ID" }, "name": { "type": "string", "description": "Lender name" }, "userProvidedLenderName": { "type": "string", "description": "This is the original lender name provided by the payoff statement\r\nIt may differ from the official lender name in the lender record.\r\nFor example, the lender record could be \"Wells Fargo\", while the\r\nprovided lender name could be \"Wells Fargo Home Mortgage\". We\r\npreserve this so we can display it and avoid support issues when\r\na user is confused that the lender name has changed on them" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectLoanResponseModel": { "type": "object", "properties": { "amount": { "type": "number", "description": "Loan Amount", "format": "double", "nullable": true }, "number": { "type": "string", "description": "Loan Number", "nullable": true }, "type": { "type": "string", "description": "Type - typical values are but can be any value: ['Residential Mortgage', 'HELOC', 'Commercial Mortgage' , 'Other']", "nullable": true } }, "additionalProperties": false, "description": "Request model for a Payoff Protect Loan" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectResponseModel": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Account (Enterprise) Id from which this Payoff was created. \r\nCurrently with v2 released, this is actually Location Id" }, "bankAccountNumber": { "type": "string", "description": "The account number at the bank to wire funds to" }, "beneficiaryBank": { "$ref": "#/components/schemas/CertifID.MortgagePayoff.Common.Models.BankInfo" }, "borrowers": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.BorrowerResponseModel" }, "description": "The Borrowers, as entered by the user" }, "created": { "type": "string", "description": "Date/Time Record was created", "format": "date-time" }, "createdBy": { "type": "string", "description": "The name of the user that created this Payoff record" }, "fileNumber": { "type": "string", "description": "File number entered by the user" }, "id": { "type": "string", "description": "Id of the record" }, "lender": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectLenderResponseModel" }, "loan": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectLoanResponseModel" }, "status": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectUpsertStatusResponseModel" }, "propertyAddress": { "type": "string", "description": "The property address" }, "userId": { "type": "string", "description": "The user id of the user that created this Payoff record" }, "underwriterId": { "type": "string", "description": "UnderwriterId", "nullable": true }, "underwriter": { "type": "string", "description": "Underwriter Name. This is resolved by the ID if ID is valid, If not then we will use this Name for things like\r\nNone, Not Listed", "nullable": true }, "integrationData": { "$ref": "#/components/schemas/CertifID.V2.Common.Models.Integrations.IntegrationData" } }, "additionalProperties": false, "description": "Response model for a Payoff" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectUpsertResponseModel": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectUpsertStatusResponseModel" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectUpsertStatusResponseModel": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/CertifID.V2.PublicAPIsService.Common.Models.PublicModels.PayoffStatus" }, "displayName": { "enum": [ "Unable To Validate", "High Risk", "CertifID", "Pending", "Canceled", "Needs Attention" ], "type": "string", "description": "Gets a human-readable display name for the Status enum value", "readOnly": true }, "description": { "type": "string", "description": "Description of the Status along with any additional notes", "readOnly": true } }, "additionalProperties": false, "description": "This will contain information about the Status of the Disbursement/Payoff" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Pagination.PagedData`1[CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationResponseModel]": { "type": "object", "properties": { "pageSize": { "type": "integer", "description": "Number of Items per page.", "format": "int32" }, "zeroBasedCurrentPage": { "type": "integer", "description": "Zero-based current page (where 0 is the first page).", "format": "int32" }, "totalItems": { "type": "integer", "description": "Total items available (the total of all results without paging).", "format": "int64" }, "totalPages": { "type": "integer", "description": "The number of pages that represent results.", "format": "int32", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.AccountVerifications.AccountVerificationResponseModel" }, "description": "The items that are part of the current page" } }, "additionalProperties": false, "description": "This class is used to return Paged data. In addition to the list of items, Page state is\r\nmaintained. Of note: \"Passthrough\" is an arbitrary value passed from the client to the\r\nserver. It gets returned, unaltered. This is useful for scenarios where multiple calls in\r\nare play. For example:\r\n \r\nIf a user is applying filters to paged data, and they rapidly send 2 or more requests for\r\ndata to the server, the client can have a number that increments with each call. That number\r\nis sent with the request for paged data. When data is received, the client can compare the\r\n\"Passthrough\" number to the current number, and if they don't match, the client can discard\r\nthe results, as it is expecting newer results." }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.Pagination.PagedData`1[CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectResponseModel]": { "type": "object", "properties": { "pageSize": { "type": "integer", "description": "Number of Items per page.", "format": "int32" }, "zeroBasedCurrentPage": { "type": "integer", "description": "Zero-based current page (where 0 is the first page).", "format": "int32" }, "totalItems": { "type": "integer", "description": "Total items available (the total of all results without paging).", "format": "int64" }, "totalPages": { "type": "integer", "description": "The number of pages that represent results.", "format": "int32", "readOnly": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.Outbound.PayoffProtect.PayoffProtectResponseModel" }, "description": "The items that are part of the current page" } }, "additionalProperties": false, "description": "This class is used to return Paged data. In addition to the list of items, Page state is\r\nmaintained. Of note: \"Passthrough\" is an arbitrary value passed from the client to the\r\nserver. It gets returned, unaltered. This is useful for scenarios where multiple calls in\r\nare play. For example:\r\n \r\nIf a user is applying filters to paged data, and they rapidly send 2 or more requests for\r\ndata to the server, the client can have a number that increments with each call. That number\r\nis sent with the request for paged data. When data is received, the client can compare the\r\n\"Passthrough\" number to the current number, and if they don't match, the client can discard\r\nthe results, as it is expecting newer results." }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.Party": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "minLength": 1, "pattern": "^[A-Za-z]{1}[A-Za-z-'\\. ]{0,49}$", "type": "string", "description": "The party's first name.", "example": "Alex" }, "lastName": { "minLength": 1, "pattern": "^[A-Za-z]{1}[A-Za-z-'\\. ]{0,49}$", "type": "string", "description": "The party's last name.", "example": "Smith" }, "email": { "maxLength": 100, "type": "string", "description": "The party's email address.", "format": "email", "nullable": true, "example": "asmith@email.com" }, "phone": { "pattern": "^[0-9]{10}$", "type": "string", "description": "The party's phone number.", "nullable": true, "example": "5038675309" }, "role": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PublicRecipientType" }, "roleOther": { "type": "string", "description": "If \"Other\" is selected for the party, allows the integrating system to send a value\r\nother than the preset list.", "nullable": true }, "customEmailMessage": { "maxLength": 550, "minLength": 0, "type": "string", "description": "Custom text section will be part of the recipient's invite message, in the email's body.", "nullable": true, "example": "\n This is a demo message from the title agent to the buyer, which will be added to the invite email.\n " } }, "additionalProperties": false, "description": "A party to a file/deal." }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PropertyAddress": { "type": "object", "properties": { "streetAddress": { "type": "string", "description": "The street address of the property being described.", "nullable": true, "example": "123 Some Way" }, "streetAddress2": { "type": "string", "description": "The second line of the street address.", "nullable": true, "example": "Unit 12" }, "city": { "type": "string", "description": "The city of the property being described.", "nullable": true, "example": "Georgetown" }, "state": { "type": "string", "description": "The state of the property being described.", "nullable": true, "example": "OR" }, "zip": { "type": "string", "description": "The ZIP code of the property being described.", "nullable": true, "example": "78642" } }, "additionalProperties": false, "description": "A description of the property in question." }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PublicIdentityRequestStatus": { "enum": [ "Verified", "Expired", "Started", "Sent", "Canceled", "HighRisk", "UnableToVerify", "PendingRetry" ], "type": "string" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PublicRecipientType": { "enum": [ "Other", "Buyer", "Seller", "Lender", "RealEstateAgent", "Attorney", "TitleCompany", "LawFirm", "Builder", "GeneralContractor" ], "type": "string", "description": "The role of the party in the real estate deal." }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.PublicRequestStatus": { "enum": [ "CertifId", "Expired", "Failed", "Started", "Sent", "Rejected", "Canceled", "HighRisk" ], "type": "string", "description": "The various statuses of a wiring instructions related request in the CertifID platform." }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.RejectFeedback": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.RejectFeedbackType" }, "typeDisplayText": { "type": "string" }, "freeText": { "type": "string" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.RejectFeedbackType": { "enum": [ "Other", "IncorrectAccountHolder", "IncorrectAccountNumber", "IncorrectAbaNumber", "GetCheck" ], "type": "string" }, "CertifID.V2.PublicAPI.ViewModels.Requests.Api.RequestParts.VerificationDetails": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Display name of the status of the request" }, "uniqueLink": { "type": "string", "description": "Unique link if share_link was chosen as delivery method", "nullable": true }, "descriptionTitle": { "type": "string", "description": "Description title of the status of the verification request" }, "descriptionLong": { "type": "string", "description": "Verbose description of the status of the verification request" }, "descriptionShort": { "type": "string", "description": "Concise description of the status of the verification request" } }, "additionalProperties": false }, "CertifID.V2.PublicAPI.ViewModels.Underwriters.UnderwriterViewModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the underwriter." }, "name": { "type": "string", "description": "The (display) name of the underwriter.", "example": "Integrity National Title Insurance Co" } }, "additionalProperties": false, "description": "A title underwriter." }, "CertifID.V2.PublicAPI.ViewModels.WiringInformation.CreditToViewModel": { "type": "object", "properties": { "accountName": { "type": "string", "description": "The name associated to the account." }, "accountNumber": { "type": "string", "description": "The mask representation of the account number." } }, "additionalProperties": false, "description": "Credit to" }, "CertifID.V2.PublicAPI.ViewModels.WiringInformation.WiringInformationViewModel": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique ID of this specific set of wiring instructions." }, "name": { "type": "string", "description": "A name given to the instructions by the customer in the CertifID platform.", "example": "Main Central Account" }, "creditTo": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.WiringInformation.CreditToViewModel" }, "finalCreditTo": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.WiringInformation.CreditToViewModel" }, "beneficiaryBank": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails" }, "correspondentBank": { "$ref": "#/components/schemas/CertifID.V2.PublicAPI.ViewModels.Banks.BankDetails" } }, "additionalProperties": false, "description": "View Model For Wiring Information" }, "CertifID.V2.PublicAPIsService.Common.Models.PublicModels.PayoffStatus": { "enum": [ "UnableToValidate", "HighRisk", "CertifID", "Pending", "Canceled", "NeedsAttention" ], "type": "string" }, "Microsoft.AspNetCore.Mvc.ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "System.Net.HttpStatusCode": { "enum": [ "Continue", "SwitchingProtocols", "Processing", "EarlyHints", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultiStatus", "AlreadyReported", "IMUsed", "MultipleChoices", "MovedPermanently", "Found", "SeeOther", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "PermanentRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "MisdirectedRequest", "UnprocessableEntity", "Locked", "FailedDependency", "UpgradeRequired", "PreconditionRequired", "TooManyRequests", "RequestHeaderFieldsTooLarge", "UnavailableForLegalReasons", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported", "VariantAlsoNegotiates", "InsufficientStorage", "LoopDetected", "NotExtended", "NetworkAuthenticationRequired" ], "type": "string" } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://auth.certifid.com/authorize?audience=https://api.certifid.com&connection=CertifID-Users-DB", "tokenUrl": "https://auth.certifid.com/oauth/token", "scopes": { } } } } } }, "security": [ { "oauth2": [ ] } ] }