Created
September 28, 2023 14:50
-
-
Save felipeorlando/2ecb1c49c96275539bf741fe9695dff0 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi": "3.0.0", | |
| "info": { | |
| "title": "Solidifi Agent Partner API", | |
| "version": "1.2.0", | |
| "description": "\n# Introduction & Purpose\nThe Agent Partner API Integration Guide is for the technical resources assigned by Partner integrating with Solidifi Values™ to obtain direct access for receiving orders, status updates and delivering products. This guide identifies the data requirements, structures and services exchanged between Solidifi Values™ and the Partner.\n\n## Web Services Overview\nSolidifi offers a suite of web services to allow partners to easily interact with the Values™ platform. These web services are sent and received in XML in REST format. The sending and receiving of requests allow the partner to fully manage the order lifecycle from a remote application.\n\nThis document describes the different ways to post requests, but the schema used to send the actual order request and updates will be the same (see examples below). The web service URL endpoint for the partner to post requests to will be provided by Solidifi. \n\nThe service requires a secure connection using Transport Layer Security, TLS 1.2 or greater. \n\n## Support\nQuestions about the integration process should be submitted via email, discussed on regular project conference calls, or via phone to the designated team member on the Solidifi team. Contact information will be shared during a kickoff meeting.\n\nFor production support issues after go-live, the Solidifi on call email address and phone number will be provided for urgent issues after hours.\n\n# Initial Configuration\n\n## Maintenance Windows\nIn the event of a system maintenance window or outage, Solidifi Values™ automatically queues any outgoing events to the partner and retries every 10 minutes for 6 times; a similar queuing setup is recommended in the Partner application also. In the event services are not restored, our support team intervenes and triages manually. Once services are recovered, events can automatically be re-queued to restore services. All HTTP Codes >= 300 will be treated as a failure and events will be retried by Solidifi. \n\n## Application Performance\nSynchronous responses are expected to be within 5 seconds of the request to ensure production stability and performance. In the event a connection timeout is received, Solidifi Values™ will re-queue the event. \n\nAs multiple large files (e.g. 15 MB) can be delivered apart of the outgoing “InputAgentDeliverDocumentRequest” request to Solidifi from the , best practices are to first acknowledge receipt of the payload synchronously and handle the retrieval of the docs in the backend of the Client application.\n\n# Notice\nThis document contains confidential and proprietary information and is considered “Confidential Information” of Solidifi U.S. Inc. (“Solidifi”) as defined and governed by the Application Programming Interface (API) License Agreement between the parties. If you are not the intended recipient of this document, please contact Solidifi immediately and destroy all copies of this document." | |
| }, | |
| "servers": [ | |
| { | |
| "url": "https://{host}.solidifi.com", | |
| "description": "The host value is assigned by Solidifi", | |
| "variables": { | |
| "host": { | |
| "default": "None" | |
| } | |
| } | |
| } | |
| ], | |
| "tags": [ | |
| { | |
| "name": "Agent Partner (Vendor)", | |
| "description": "Calls that are initiated by the Vendor (Agent Partner) to Solidifi" | |
| }, | |
| { | |
| "name": "Solidifi (Client)", | |
| "description": "Calls that are initiated by the client (Solidifi) to the Vendor" | |
| } | |
| ], | |
| "paths": { | |
| "/vxappraisal/RedihiveAgentPartnerService": { | |
| "post": { | |
| "tags": [ | |
| "Agent Partner (Vendor)" | |
| ], | |
| "description": "**The below table describes the purpose of each requesttype parameter**\n\n| RequestType | Description |\n| ---------------------------- | ------------------------------------------------ |\n| **InputAgentOrderUploadRequest** | Sends the order deliverables to Solidifi |\n| **InputAgentDeliverDocumentRequest** | Sends non-deliverable documents to Solidifi IE the Property Data Collection data file |\n| **InputAgentSendMessageRequest** | Allows The Agent or Vendor to communicate back to Solidifi Management|\n| **InputAgentOrderAssignedRequest** | Provides the Agent info to Solidifi and confirms order acceptance by that Agent|\n| **InputAgentOrderAcceptRequest** | Asynchronous acceptance of the AgentCreateOrder payload received from Solidifi|\n| **InputAgentOrderRejectRequest** | Asynchronous rejection of the AgentCreateOrder payload received from Solidifi|\n| **InputAgentOrderScheduleRequest** | Sends the inspection schedule date to Solidifi |\n", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "requesttype", | |
| "schema": { | |
| "type": "string", | |
| "enum": [ | |
| "InputAgentOrderUploadRequest", | |
| "InputAgentDeliverDocumentRequest", | |
| "InputAgentOrderAssignedRequest", | |
| "InputAgentSendMessageRequest", | |
| "InputAgentOrderAcceptRequest", | |
| "InputAgentOrderRejectRequest", | |
| "InputAgentOrderScheduleRequest" | |
| ] | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AppraisalUpdateRequest" | |
| }, | |
| "examples": { | |
| "InputAgentOrderAcceptRequest": { | |
| "value": { | |
| "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance", | |
| "xsi:schemaLocation": "http://appraisal.solidifi.com/schema/AppraisalStatusUpdateRequest/1.2 AppraisalStatusUpdateRequest.xsd", | |
| "partnerClientId": "SuperSupplierPartnerID", | |
| "orderRefNumber": "OR9999999", | |
| "requesterReferenceNumber": 999 | |
| } | |
| }, | |
| "InputAgentOrderRejectRequest": { | |
| "description": "**Please use reason code 2104 for any process errors (IE Duplicate check) you may run duplicate check off of orderRefNumber match and order is still in progress in partner system (ignore cancelled orders or completed orders)**\n", | |
| "value": { | |
| "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance", | |
| "xsi:schemaLocation": "http://appraisal.solidifi.com/schema/AppraisalStatusUpdateRequest/1.2 AppraisalStatusUpdateRequest.xsd", | |
| "partnerClientId": "SuperSupplierPartnerID", | |
| "orderRefNumber": "OR9999999", | |
| "requesterReferenceNumber": 999, | |
| "message": { | |
| "subject": "Reject Order", | |
| "reason": { | |
| "reasoncode": 2107, | |
| "reasonDesc": "Do not service property type" | |
| }, | |
| "comment": "Additional comments can be left by Vendor", | |
| "isImportant": false | |
| } | |
| } | |
| }, | |
| "InputAgentOrderAssignedRequest": { | |
| "value": { | |
| "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance", | |
| "xsi:schemaLocation": "http://appraisal.solidifi.com/schema/AppraisalStatusUpdateRequest/1.2 AppraisalStatusUpdateRequest.xsd", | |
| "partnerClientId": "SuperSupplierPartnerID", | |
| "orderRefNumber": "OR9999999", | |
| "requesterReferenceNumber": 999, | |
| "agentPartnerInfo": { | |
| "agentFee": 45.95, | |
| "companyName": "Photo contracting Inc.", | |
| "firstName": "John", | |
| "lastName": "Doe" | |
| } | |
| } | |
| }, | |
| "InputAgentOrderScheduleRequest": { | |
| "value": { | |
| "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance", | |
| "xsi:schemaLocation": "http://appraisal.solidifi.com/schema/AppraisalStatusUpdateRequest/1.2 AppraisalStatusUpdateRequest.xsd", | |
| "partnerClientId": "SuperSupplierPartnerID", | |
| "orderRefNumber": "OR9999999", | |
| "requesterReferenceNumber": 999, | |
| "scheduleDate": "2023-06-20T17:00:00.000Z" | |
| } | |
| }, | |
| "InputAgentSendMessageRequest": { | |
| "value": { | |
| "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance", | |
| "xsi:schemaLocation": "http://appraisal.solidifi.com/schema/AppraisalStatusUpdateRequest/1.2 AppraisalStatusUpdateRequest.xsd", | |
| "partnerClientId": "SuperSupplierPartnerID", | |
| "orderRefNumber": "OR9999999", | |
| "requesterReferenceNumber": 999, | |
| "message": { | |
| "subject": "Provide Update", | |
| "comment": "This is a comment.", | |
| "messageUniqueId": 123456789, | |
| "isImportant": false | |
| } | |
| } | |
| }, | |
| "InputAgentDeliverDocumentRequest": { | |
| "value": { | |
| "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance", | |
| "xsi:schemaLocation": "http://appraisal.solidifi.com/schema/AppraisalStatusUpdateRequest/1.2 AppraisalStatusUpdateRequest.xsd", | |
| "partnerClientId": "SuperSupplierPartnerID", | |
| "orderRefNumber": "OR9999999", | |
| "requesterReferenceNumber": 999, | |
| "DocumentList": { | |
| "Document": [ | |
| { | |
| "Description": "PDC Photos", | |
| "OriginalFileName": "PDC_Photo.zip", | |
| "Content": "RmxhdGVEZWNvZGUvSURbP...", | |
| "EncodeType": "Base64", | |
| "ReportType": "PDC_PHOTO" | |
| }, | |
| { | |
| "Description": "PDC Data", | |
| "OriginalFileName": "PDC_Data.xml", | |
| "Content": "RmxhdGVEZWNvZGUvSURbP...", | |
| "EncodeType": "Base64", | |
| "ReportType": "PDC_REPORT" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "InputAgentOrderUploadRequest": { | |
| "value": { | |
| "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance", | |
| "xsi:schemaLocation": "http://appraisal.solidifi.com/schema/AppraisalStatusUpdateRequest/1.2 AppraisalStatusUpdateRequest.xsd", | |
| "partnerClientId": "SuperSupplierPartnerID", | |
| "orderRefNumber": "OR9999999", | |
| "requesterReferenceNumber": 999, | |
| "DocumentList": { | |
| "Document": [ | |
| { | |
| "Description": "PDR Report", | |
| "OriginalFileName": "PDR_Report.pdf", | |
| "Content": "RmxhdGVEZWNvZGUvSURbP...", | |
| "EncodeType": "Base64", | |
| "ReportType": "PDF_REPORT" | |
| }, | |
| { | |
| "Description": "PDR DATA Report", | |
| "OriginalFileName": "PDR_Report.xml", | |
| "Content": "RmxhdGVEZWNvZGUvSURbP...", | |
| "EncodeType": "Base64", | |
| "ReportType": "DATA_REPORT" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Application successfully handled request, including process and validation errors", | |
| "content": { | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AppraisalUpdateRequestResponse" | |
| }, | |
| "examples": { | |
| "Successfully received": { | |
| "value": { | |
| "orderRefNumber": "OR9999999", | |
| "requesterReferenceNumber": 999, | |
| "resultCode": 10, | |
| "resultText": "Request Approved." | |
| } | |
| }, | |
| "Order not found": { | |
| "value": { | |
| "resultCode": -1, | |
| "resultText": "Order Not Found." | |
| } | |
| }, | |
| "Invalid order status to receive notification": { | |
| "value": { | |
| "orderRefNumber": "OR9999999", | |
| "requesterReferenceNumber": 999, | |
| "resultCode": -2, | |
| "resultText": "Validation Error : Invalid Order Status." | |
| } | |
| }, | |
| "Unknown error": { | |
| "description": "Partner may retry notification message when this error is received.", | |
| "value": { | |
| "resultCode": -10, | |
| "resultText": "Unknown Error" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/{AgentPartnerDefined}": { | |
| "description": "Calls that are sent from Solidifi to the Agent Parter. Agent Partner defines the URL", | |
| "servers": [ | |
| { | |
| "url": "https:{AgentPartnerHost}.{TLD}", | |
| "variables": { | |
| "AgentPartnerHost": { | |
| "default": "test", | |
| "description": "This is the Agent Partner URL structure" | |
| }, | |
| "TLD": { | |
| "default": "com", | |
| "description": "The top level domain of the Agent Partner URL" | |
| } | |
| } | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Solidifi (Client)" | |
| ], | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "AgentPartnerDefined", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AppraisalStatusUpdateRequest" | |
| }, | |
| "examples": { | |
| "AgentOrderCreate": { | |
| "description": "order create request and informational or supplemental documents intended for the assigned Agent\n", | |
| "value": { | |
| "orderRefNumber": "OR9999999", | |
| "statusType": "AGENTORDERCREATE", | |
| "resultCode": 33, | |
| "resultDescription": "Agent Order Create.", | |
| "userId": "UserName", | |
| "password": "Password", | |
| "eventDate": "2023-02-22T21:15:49.528Z", | |
| "subjectProperty": { | |
| "address": { | |
| "streetNumber": null, | |
| "suffix": null, | |
| "streetDirection": null, | |
| "streetType": null, | |
| "streetName": "100 Main Street", | |
| "city": "Anywhere", | |
| "province": "NY", | |
| "postalCode": 12345, | |
| "countyFIPS": 12345 | |
| } | |
| }, | |
| "appraisalContact": { | |
| "contactName": "John Doe", | |
| "contactEmail": "[email protected]", | |
| "contactDayPhone": "555-555-5555", | |
| "contactEveningPhone": "555-555-5555", | |
| "contactCellPhone": null, | |
| "accessInstructions": "Check in at main gate to access community" | |
| }, | |
| "lenderInfo": { | |
| "lenderName": { | |
| "name": "LenderName" | |
| }, | |
| "lenderAddress": { | |
| "addressLine1": "123 Main Street", | |
| "addressLine2": null, | |
| "city": "Anywhere", | |
| "province": "CT", | |
| "country": "US", | |
| "postalCode": 12345 | |
| }, | |
| "lenderId": 123843 | |
| }, | |
| "productId": 917, | |
| "orderId": 9999995, | |
| "parentOrderId": null, | |
| "relatedOrderId": null, | |
| "fhlmcLpaKey": "LPA key identifier", | |
| "fnmaCaseFileId": "CaseFileID identifier", | |
| "speacialInstructions": "Please use access code 1234 to access the property", | |
| "documentList": { | |
| "document": { | |
| "description": "Appraisal Requirements for lender", | |
| "docName": "Attachment7539969_1685482207149_5774.pdf", | |
| "content": "Base64_content...", | |
| "encodeType": "Base64", | |
| "documentType": "Values LOE" | |
| } | |
| } | |
| } | |
| }, | |
| "AgentSendMessage": { | |
| "description": "Messages intended for the Assigned agent IE requesting delivery ETA update", | |
| "value": { | |
| "orderRefNumber": "OR9999999", | |
| "statusType": "AGENTSENDMESSAGE", | |
| "resultCode": 34, | |
| "resultDescription": "Agent Order Message.", | |
| "requesterReferenceNumber": 999, | |
| "userId": "UserName", | |
| "password": "password", | |
| "eventDate": "2023-02-27T22:55:34.110Z", | |
| "message": { | |
| "subject": "Hello", | |
| "comment": "Please provide an ETA on the order.", | |
| "isImportant": true, | |
| "fromPerson": "Alexander Fernandez", | |
| "toPerson": "AgentPartner name in Values" | |
| } | |
| } | |
| }, | |
| "AgentOrderOnHold": { | |
| "description": "Request to halt progress on the order until resumed", | |
| "value": { | |
| "orderRefNumber": "OR9999999", | |
| "statusType": "AGENTORDERONHOLD", | |
| "resultCode": 37, | |
| "resultDescription": "Agent Order On-Hold.", | |
| "requesterReferenceNumber": 999, | |
| "userId": "UserName", | |
| "password": "password", | |
| "eventDate": "2023-02-27T22:55:34.110Z", | |
| "eventReasons": { | |
| "eventReason": { | |
| "reasonCategory": "ORDERONHOLD", | |
| "reasonCode": 7, | |
| "reasonDesc": "Client Delay", | |
| "reasonComment": "Order placed on hold due to reason of Client Delay. On hold pending lender direction." | |
| } | |
| } | |
| } | |
| }, | |
| "AgentOrderResume": { | |
| "description": "resume order progress", | |
| "value": { | |
| "orderRefNumber": "OR9999999", | |
| "statusType": "AGENTORDERRESUME", | |
| "resultCode": 38, | |
| "resultDescription": "Agent Order Off-Hold.", | |
| "requesterReferenceNumber": 999, | |
| "userId": "UserName", | |
| "password": "password", | |
| "eventDate": "2023-02-27T22:55:34.110Z" | |
| } | |
| }, | |
| "AgentDocumentDeliver": { | |
| "description": "any supplemental documentation required for the Agent. \n**Note: multiple large files (15 MB) can be delivered to the partner at a time. it is recommended to first acknowledge receipt of the payload synchronously and handle the retrieval of the documents in the backend of the partner application.**\n", | |
| "value": { | |
| "orderRefNumber": "OR9999999", | |
| "statusType": "AGENTDOCUMENTDELIVER", | |
| "resultCode": 39, | |
| "resultDescription": "Deliver new document.", | |
| "requesterReferenceNumber": 999, | |
| "userId": "UserName", | |
| "password": "password", | |
| "eventDate": "2023-02-27T22:55:34.110Z", | |
| "documentList": { | |
| "document": { | |
| "description": "New Document for Agent", | |
| "docName": "Attachment7539969_1685482208000_1234.pdf", | |
| "content": "Base64_contents...", | |
| "encodeType": "Base64", | |
| "documentType": "Other" | |
| } | |
| } | |
| } | |
| }, | |
| "AgentRevisionRequired": { | |
| "description": "request to revise the report to the original agent", | |
| "value": { | |
| "orderRefNumber": "OR9999999", | |
| "statusType": "AGENTREVISIONREQUIRED", | |
| "resultCode": 35, | |
| "resultDescription": "Agent Order Revisions Required.", | |
| "requesterReferenceNumber": 999, | |
| "userId": "UserName", | |
| "password": "password", | |
| "eventDate": "2023-02-27T22:55:34.110Z", | |
| "revisionFindings": { | |
| "finding": [ | |
| "A revision", | |
| "A second revision", | |
| "A third revision" | |
| ] | |
| } | |
| } | |
| }, | |
| "AgentOrderCancel": { | |
| "description": "cancels the order", | |
| "value": { | |
| "orderRefNumber": "OR9999999", | |
| "statusType": "AGENTORDERCANCEL", | |
| "resultCode": 36, | |
| "resultDescription": "Agent Order Revisions Required.", | |
| "requesterReferenceNumber": 999, | |
| "userId": "UserName", | |
| "password": "password", | |
| "eventDate": "2023-02-27T22:55:34.110Z", | |
| "currentFeeAmount": 0, | |
| "message": { | |
| "subject": "Cancel order", | |
| "reason": { | |
| "reasonCode": 208, | |
| "reasonDesc": "Other", | |
| "reasonComment": "We had to cancel this order as lender requires upgrade to appraisal", | |
| "solidifiReasonCode": "OActionReason_208" | |
| }, | |
| "comment": "We regret to inform you that this order has been cancelled", | |
| "isImportant": false | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "Application successfully handled request, including process and validation errors", | |
| "content": { | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AppraisalRequestResponse" | |
| }, | |
| "examples": { | |
| "Request Process Successful": { | |
| "value": { | |
| "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance", | |
| "xsi:schemaLocation": "http://appraisal.solidifi.com/schema/AppraisalRequestResponse/1.2 AppraisalRequestResponse.xsd", | |
| "orderRefNumber": "OR9999999", | |
| "requesterReferenceNumber": 999, | |
| "resultCode": 1, | |
| "resultText": "Order Request Received Successfully" | |
| } | |
| }, | |
| "Invalid order status": { | |
| "description": "Use this response if Solidifi sends a notification that does not make sense with the order status. IE AgentRevisionRequired prior to partner sending InputAgentOrderUploadRequest", | |
| "value": { | |
| "xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance", | |
| "xsi:schemaLocation": "http://appraisal.solidifi.com/schema/AppraisalRequestResponse/1.2 AppraisalRequestResponse.xsd", | |
| "orderRefNumber": "OR9999999", | |
| "requesterReferenceNumber": 999, | |
| "resultCode": -2, | |
| "resultText": "Validation Error : Invalid Order Status." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "components": { | |
| "securitySchemes": { | |
| "basicAuth": { | |
| "type": "http", | |
| "scheme": "basic", | |
| "description": "Please contact Solidifi for test credentials" | |
| } | |
| }, | |
| "schemas": { | |
| "AppraisalUpdateRequest": { | |
| "type": "object", | |
| "required": [ | |
| "xmlns:xsi", | |
| "xsi:schemaLocation", | |
| "partnerClientId", | |
| "orderRefNumber", | |
| "requesterReferenceNumber" | |
| ], | |
| "xml": { | |
| "namespace": "http://appraisal.solidifi.com/schema/AppraisalUpdateRequest/1.2" | |
| }, | |
| "properties": { | |
| "xmlns:xsi": { | |
| "type": "string", | |
| "enum": [ | |
| "http://www.w3.org/2001/XMLSchema-instance" | |
| ], | |
| "xml": { | |
| "attribute": true | |
| } | |
| }, | |
| "xsi:schemaLocation": { | |
| "type": "string", | |
| "enum": [ | |
| "http://appraisal.solidifi.com/schema/AppraisalStatusUpdateRequest/1.2 AppraisalStatusUpdateRequest.xsd" | |
| ], | |
| "xml": { | |
| "attribute": true | |
| } | |
| }, | |
| "partnerClientId": { | |
| "type": "string", | |
| "description": "Identifier of the Vendor (assigned by Solidifi) this value will be the same across all envrionments including production." | |
| }, | |
| "orderRefNumber": { | |
| "type": "string", | |
| "description": "unique order identifier on the Solidifi side" | |
| }, | |
| "requesterReferenceNumber": { | |
| "type": "string", | |
| "description": "unique order identifier on the Vendor side" | |
| }, | |
| "message": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/MessageType" | |
| } | |
| }, | |
| "agentPartnerInfo": { | |
| "$ref": "#/components/schemas/agentPartnerInfo" | |
| }, | |
| "DocumentList": { | |
| "$ref": "#/components/schemas/DocumentList" | |
| }, | |
| "scheduleDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| }, | |
| "MessageType": { | |
| "type": "object", | |
| "properties": { | |
| "issueId": { | |
| "type": "string" | |
| }, | |
| "issueStatus": { | |
| "type": "string" | |
| }, | |
| "subject": { | |
| "type": "string" | |
| }, | |
| "from": { | |
| "type": "string" | |
| }, | |
| "reason": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/reasonType" | |
| } | |
| }, | |
| "comment": { | |
| "type": "string" | |
| }, | |
| "messageUniqueId": { | |
| "description": "uniqueID for each message sent", | |
| "type": "string" | |
| }, | |
| "isImportant": { | |
| "type": "boolean" | |
| }, | |
| "messageDate": { | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "toAppraiser": { | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "reasonType": { | |
| "type": "object", | |
| "properties": { | |
| "reasonCode": { | |
| "type": "string", | |
| "enum": [ | |
| "2103", | |
| "2104", | |
| "2107", | |
| "2108" | |
| ], | |
| "description": "* `2103` - Do not service property type\n* `2104` - Other (Use other for any duplicate check failure or ProductId is not recognized by the partner system)\n* `2107` - Unable to meet turn times\n* `2108` - No coverage\n" | |
| }, | |
| "reasonDesc": { | |
| "type": "string" | |
| }, | |
| "reasonComment": { | |
| "type": "string" | |
| }, | |
| "solidifiReasonCode": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "DocumentList": { | |
| "type": "object", | |
| "properties": { | |
| "Document": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Document" | |
| } | |
| } | |
| } | |
| }, | |
| "Document": { | |
| "type": "object", | |
| "description": "**Max file size allowed: 15 MB per file**\n", | |
| "properties": { | |
| "Description": { | |
| "type": "string" | |
| }, | |
| "DocName": { | |
| "type": "string" | |
| }, | |
| "OriginalFileName": { | |
| "type": "string" | |
| }, | |
| "Content": { | |
| "type": "string" | |
| }, | |
| "EncodeType": { | |
| "type": "string" | |
| }, | |
| "DocumentType": { | |
| "type": "string" | |
| }, | |
| "ReportType": { | |
| "$ref": "#/components/schemas/reportType" | |
| } | |
| } | |
| }, | |
| "agentPartnerInfo": { | |
| "type": "object", | |
| "properties": { | |
| "agentFee": { | |
| "type": "number", | |
| "format": "double" | |
| }, | |
| "companyName": { | |
| "type": "string" | |
| }, | |
| "firstName": { | |
| "type": "string" | |
| }, | |
| "lastName": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "reportType": { | |
| "type": "string", | |
| "enum": [ | |
| "PDF_REPORT", | |
| "DATA_REPORT", | |
| "DATA_REPORT_ENV", | |
| "DATA_REPORT_AIREADY", | |
| "BAC_INTERNAL_XML", | |
| "PDC_REPORT", | |
| "PDC_DATA", | |
| "PDC_PHOTO" | |
| ] | |
| }, | |
| "AppraisalStatusUpdateRequest": { | |
| "type": "object", | |
| "xml": { | |
| "namespace": "http://appraisal.solidifi.com/schema/AppraisalStatusUpdateRequest/1.2" | |
| }, | |
| "properties": { | |
| "orderRefNumber": { | |
| "description": "unique order identifier on the Solidifi side", | |
| "type": "string" | |
| }, | |
| "statusType": { | |
| "type": "string", | |
| "enum": [ | |
| "AGENTCREATEORDER", | |
| "AGENTSENDMESSAGE", | |
| "AGENTORDERONHOLD", | |
| "AGENTORDERRESUME", | |
| "AGENTDOCUMENTDELIVER", | |
| "AGENTREVISIONREQUIRED", | |
| "AGENTORDERCANCEL" | |
| ] | |
| }, | |
| "resultCode": { | |
| "type": "integer", | |
| "enum": [ | |
| 33, | |
| 34, | |
| 35, | |
| 36, | |
| 37, | |
| 38, | |
| 39 | |
| ] | |
| }, | |
| "resultDescription": { | |
| "description": "describes the resultcode", | |
| "type": "string" | |
| }, | |
| "requesterReferenceNumber": { | |
| "description": "unique order identifier on the Vendor side", | |
| "type": "string" | |
| }, | |
| "userId": { | |
| "description": "used to authenticate to partner application.", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "description": "used to authenticate to partner application.", | |
| "type": "string" | |
| }, | |
| "eventDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "subjectProperty": { | |
| "$ref": "#/components/schemas/SubjectPropertyType" | |
| }, | |
| "appraisalContact": { | |
| "$ref": "#/components/schemas/appraisalContactType" | |
| }, | |
| "lenderInfo": { | |
| "$ref": "#/components/schemas/LenderInfoType" | |
| }, | |
| "revisionFindings": { | |
| "$ref": "#/components/schemas/revisionFindings" | |
| }, | |
| "eventReasons": { | |
| "$ref": "#/components/schemas/EventReasonsType" | |
| }, | |
| "productId": { | |
| "type": "string", | |
| "enum": [ | |
| "105", | |
| "917", | |
| "936", | |
| "951", | |
| "952", | |
| "953", | |
| "957", | |
| "961" | |
| ], | |
| "description": "* `105` - Property Condition Report\n* `917` - BAC Property Condition Report\n* `936` - FNMA Property Data Collection\n* `951` - Data Collection and Floor Plan\n* `952` - Floor Plan\n* `953` - FHLMC Property Data Report\n* `957` - FHLMC Completion Report\n* `961` - Solidifi Property Data Report\n" | |
| }, | |
| "orderId": { | |
| "type": "string" | |
| }, | |
| "parentOrderId": { | |
| "type": "string" | |
| }, | |
| "relatedOrderId": { | |
| "type": "string" | |
| }, | |
| "fhlmcLpaKey": { | |
| "description": "the Freddie LPA key identifier for property data collections", | |
| "type": "string" | |
| }, | |
| "fnmaCaseFileId": { | |
| "description": "the Fannie CaseFileID for property data collections", | |
| "type": "string" | |
| }, | |
| "speacialInstructions": { | |
| "description": "Instructions intended to be viewed by the Agent prior to accepting the order", | |
| "type": "string" | |
| }, | |
| "message": { | |
| "$ref": "#/components/schemas/MessageType" | |
| }, | |
| "documentList": { | |
| "$ref": "#/components/schemas/documentList" | |
| } | |
| } | |
| }, | |
| "revisionFindings": { | |
| "type": "object", | |
| "properties": { | |
| "finding": { | |
| "type": "array", | |
| "items": { | |
| "type": "string" | |
| } | |
| } | |
| } | |
| }, | |
| "EventReasonsType": { | |
| "type": "object", | |
| "properties": { | |
| "eventReason": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/EventReasonType" | |
| } | |
| } | |
| } | |
| }, | |
| "EventReasonType": { | |
| "type": "object", | |
| "properties": { | |
| "reasonCategory": { | |
| "description": "For this purpose, ORDERONHOLD only will be used", | |
| "type": "string" | |
| }, | |
| "reasonCode": { | |
| "type": "string", | |
| "enum": [ | |
| "1", | |
| "2", | |
| "3", | |
| "4", | |
| "5", | |
| "6", | |
| "7", | |
| "8", | |
| "9", | |
| "10", | |
| "11", | |
| "12", | |
| "13" | |
| ], | |
| "description": "* `1` - awaitingDisclosure\n* `2` - requireAdditionalInformationForFile\n* `3` - borrowerUnavailable\n* `4` - other\n* `5` - missingcontactinfo\n* `6` - collateraldelay\n* `7` - clientdelay\n* `8` - borrowerDidNotShow\n* `9` - contactNotResponding\n* `10` - borrowerResistsInspection\n* `11` - wrongPropertyAddress\n* `12` - ineligibleProperty\n* `13` - incompleteConstruction\n" | |
| }, | |
| "reasonDesc": { | |
| "type": "string" | |
| }, | |
| "reasonComment": { | |
| "type": "string" | |
| }, | |
| "solidifiReasonCode": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "documentList": { | |
| "type": "object", | |
| "properties": { | |
| "document": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/document" | |
| } | |
| } | |
| } | |
| }, | |
| "document": { | |
| "type": "object", | |
| "description": "**Max file size allowed: 15 MB per file**\n", | |
| "properties": { | |
| "description": { | |
| "type": "string" | |
| }, | |
| "docName": { | |
| "type": "string" | |
| }, | |
| "originalFileName": { | |
| "type": "string" | |
| }, | |
| "content": { | |
| "type": "string" | |
| }, | |
| "encodeType": { | |
| "type": "string" | |
| }, | |
| "clientUniqueId": { | |
| "type": "string" | |
| }, | |
| "securityHash": { | |
| "type": "string" | |
| }, | |
| "hideToAppraiser": { | |
| "type": "boolean" | |
| }, | |
| "documentType": { | |
| "type": "string" | |
| }, | |
| "reportType": { | |
| "$ref": "#/components/schemas/reportType" | |
| } | |
| } | |
| }, | |
| "SubjectPropertyType": { | |
| "type": "object", | |
| "properties": { | |
| "address": { | |
| "$ref": "#/components/schemas/AddressType" | |
| } | |
| } | |
| }, | |
| "AddressType": { | |
| "type": "object", | |
| "properties": { | |
| "unitNumber": { | |
| "type": "string" | |
| }, | |
| "streetNumber": { | |
| "type": "string" | |
| }, | |
| "suffix": { | |
| "type": "string" | |
| }, | |
| "streetDirection": { | |
| "type": "string" | |
| }, | |
| "streetType": { | |
| "type": "string" | |
| }, | |
| "streetName": { | |
| "description": "entire street address may be normalized in this element", | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "province": { | |
| "type": "string" | |
| }, | |
| "postalCode": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "countyFIPS": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "appraisalContactType": { | |
| "type": "object", | |
| "properties": { | |
| "contactName": { | |
| "description": "The name of the property contact", | |
| "type": "string" | |
| }, | |
| "contactEmail": { | |
| "description": "Contact Email address", | |
| "type": "string" | |
| }, | |
| "contactDayPhone": { | |
| "description": "Phone number for day hours", | |
| "type": "string" | |
| }, | |
| "contactEveningPhone": { | |
| "description": "Phone number for evening hours", | |
| "type": "string" | |
| }, | |
| "contactCellPhone": { | |
| "type": "string" | |
| }, | |
| "accessInstructions": { | |
| "description": "Any additional details to access the subject property", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "LenderInfoType": { | |
| "type": "object", | |
| "properties": { | |
| "lenderName": { | |
| "$ref": "#/components/schemas/LenderNameType" | |
| }, | |
| "lenderAddress": { | |
| "$ref": "#/components/schemas/LenderAddressType" | |
| }, | |
| "lenderId": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "LenderAddressType": { | |
| "type": "object", | |
| "properties": { | |
| "addressLine1": { | |
| "type": "string" | |
| }, | |
| "addressLine2": { | |
| "type": "string" | |
| }, | |
| "city": { | |
| "type": "string" | |
| }, | |
| "province": { | |
| "type": "string" | |
| }, | |
| "country": { | |
| "type": "string" | |
| }, | |
| "postalCode": { | |
| "type": "string" | |
| }, | |
| "countyFIPS": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "LenderNameType": { | |
| "type": "object", | |
| "properties": { | |
| "name": { | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "AppraisalUpdateRequestResponse": { | |
| "type": "object", | |
| "properties": { | |
| "orderRefNumber": { | |
| "type": "string" | |
| }, | |
| "requesterReferenceNumber": { | |
| "type": "string" | |
| }, | |
| "resultCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": -10, | |
| "enum": [ | |
| -10, | |
| -5, | |
| -4, | |
| -2, | |
| -1, | |
| 1, | |
| 10 | |
| ], | |
| "description": "* `-10` - Uknown Error\n* `-5` - Authentication Failed\n* `-4` - Invalid Request Error\n* `-2` - Validation Error\n* `-1` - Process Error\n* `1` - Request Received Successfully\n* `10` - Request Approved\n" | |
| }, | |
| "resultText": { | |
| "description": "Describes whether the operations was successful or not and why it was not successful", | |
| "type": "string" | |
| }, | |
| "messageList": { | |
| "$ref": "#/components/schemas/MessageList" | |
| } | |
| }, | |
| "xml": { | |
| "name": "AppraisalUpdateRequestResponse", | |
| "prefix": "ns2", | |
| "namespace": "http://appraisal.solidifi.com/schema/AppraisalUpdateRequestResponse/1.2" | |
| } | |
| }, | |
| "MessageList": { | |
| "type": "object", | |
| "properties": { | |
| "message": { | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/components/schemas/Message" | |
| } | |
| } | |
| } | |
| }, | |
| "Message": { | |
| "type": "object", | |
| "properties": { | |
| "subject": { | |
| "type": "string" | |
| }, | |
| "comment": { | |
| "type": "string" | |
| }, | |
| "fromPerson": { | |
| "type": "string" | |
| }, | |
| "eventDate": { | |
| "type": "string", | |
| "format": "date-time" | |
| } | |
| } | |
| }, | |
| "AppraisalRequestResponse": { | |
| "type": "object", | |
| "required": [ | |
| "xmlns:xsi", | |
| "xsi:schemaLocation" | |
| ], | |
| "properties": { | |
| "xmlns:xsi": { | |
| "type": "string", | |
| "enum": [ | |
| "http://www.w3.org/2001/XMLSchema-instance" | |
| ], | |
| "xml": { | |
| "attribute": true | |
| } | |
| }, | |
| "xsi:schemaLocation": { | |
| "type": "string", | |
| "enum": [ | |
| "http://appraisal.solidifi.com/schema/AppraisalRequestResponse/1.2 AppraisalRequestResponse.xsd" | |
| ], | |
| "xml": { | |
| "attribute": true | |
| } | |
| }, | |
| "orderRefNumber": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "requesterReferenceNumber": { | |
| "type": "string" | |
| }, | |
| "clientRefNumber": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "resultCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "enum": [ | |
| -10, | |
| -5, | |
| -4, | |
| -2, | |
| -1, | |
| 1, | |
| 10 | |
| ], | |
| "description": "* `-10` - Uknown Error\n* `-5` - Authentication Failed\n* `-4` - Invalid Request Error\n* `-2` - Validation Error\n* `-1` - Process Error\n* `1` - Request Received Successfully\n* `10` - Request Approved\n", | |
| "default": -10 | |
| }, | |
| "resultText": { | |
| "description": "Describes whether the operations was successful or not and why it was not successful", | |
| "type": "string" | |
| }, | |
| "requestCompleteURL": { | |
| "type": "string", | |
| "nullable": true | |
| }, | |
| "paymentResultCode": { | |
| "type": "integer", | |
| "format": "int32", | |
| "default": -10, | |
| "nullable": true | |
| }, | |
| "paymentResultText": { | |
| "type": "string", | |
| "nullable": true | |
| } | |
| }, | |
| "xml": { | |
| "name": "AppraisalRequestResponse", | |
| "namespace": "http://appraisal.solidifi.com/schema/AppraisalRequestResponse/1.2" | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment