Acuity Integration Framework

Introduction

The intent of this integration specification is to provide information to consumers or providers of mortgage-related services that wish to exchange information electronically. Such information typically includes placement of orders, updates of the progress of orders, and delivery of the final products.

The Acuity platform contains an extensive and flexible enterprise-class integration environment aimed at providing the highest degree of automation possible for its clients. This document does not describe all of these capabilities, but rather provides the framework for its standard proprietary means of electronic communication that likely represents the fastest track for such projects.

The platform can also support the data formatting native to its clients. Data formats supported are not limited to XML. The selection of appropriate data formats and other technical details of the integration process can be discussed and selected during an integration project, though that is beyond the scope of this documentation.

Basic Conventions

The default integration consists of delivering XML messages via HTTPS. There are defined message structures for placing new orders, updating status, cancelling orders, etc.

Messages you will exchange follow a common structure. Each message will contain certain header elements, including a message date and a sender and recipient code. Those codes will identify the communicating parties and will be provided during a specific integration project.

Consider the message fragment below. It contains a SenderID and RecipientID that identify who the message is coming from, and who it is destined for, respectively. The message also contains a PartnerReferenceNumber and LineItemNumber that identify an existing transaction upon which this message is intended to operate. These two values have a parent-child relationship. The PartnerReferenceNumber is the parent and represents a loan package, while the LineItemNumber is the child and identifies a specific product being ordered for that loan. The LineItemNumber is numeric but optional. In practice, each order could be placed with a unique PartnerReferenceNumber, but the ability to have line items within an order makes it possible to associate appraisal, title, and closing products together when ordered in support of the same loan. Another example would be associating an initial appraisal and a final inspection.


<?xml version="1.0" encoding="utf-8"?>
<AcuityOrder>
	<SenderID>SENDER</SenderID>
	<RecipientID>RECIPIENT</RecipientID>
	<MessageDate>2021-10-30T15:49:24.3480451-07:00</MessageDate>
	<PartnerReferenceNumber>acb123</PartnerReferenceNumber>
	<LineItemNumber>1</LineItemNumber>

The above fragment also illustrates the standard date/time format used in Acuity XML messages, which is the ISO 8601 format. In .NET languages such as C#, dates can be generated in this format using a statement such as date.ToString("o"). For more information on date/time values in XML, please consult http://www.w3schools.com/xml/schema_dtypes_date.asp.

Each message will be acknowledged synchronously, i.e. in the same HTTP transaction. The acknowledgement indicates whether the message format was acceptable, and whether processing of the message occurred successfully. Consequently, an acknowledgement indicating failure may not neccessarily indicate that the message structure was invalid. It may indicate that the message was understood but could not be successfully applied. For example, a message requesting that an order be placed on hold may be properly formatted, but may specify an invalid order number.

The example messages shown in this guide may not include every optional data point defined in the schema. The samples are meant to illustrate structure. In practice, most messages will not contain every available data point.

Some examples will contain binary data, such as documents, that have been base-64 encoded. Since documents can be large, and there's no added clarity gained from pages of encoded content, the encoded text is generally abbreviated. In such cases, the content removed is replaced with an ellipse. As a consequence, the reader should not expect to decode the base-64 content of sample messages and attain a valid document.

Authentication

It is assumed that endpoints intended to receive Acuity messages are likely protected against unwanted visitors. For this reason, systems supporting the Acuity interface specification have adopted standarized protocols for security. The interface supports the HTTP/1.1 protocol and requires TLS 1.2. The interface also requires basic authentication, as defined in RFC 2617.

Basic authentication utilizes a HTTP header to supply credentials. The format of the header is shown here.

Authorization: Basic [credentials]

The [credentials] tag will be replaced by concatenating the user name and password, separated by a colon, then encoding the result using Base64. Most modern frameworks will support the exchange of credentials over HTTP in this manner.

Systems that cannot support standardized authentication may also supply credentials in the query string when submitting messages to Acuity. The parameters username and password are accepted, as shown below.

someurl.com?username=someuser&password=somepassword

When Acuity sends messages to a foreign system, it will always use basic authentication.

Schemas and Sample Files

What's Contained in the Package?

The downloadable archive contains a number of files in the directory structure shown below. There are schemas and a sample of each message type. A new version of the integration framework is released periodically. Every effort is made to be completely backward compatible with prior versions. Any changes to the framework generally consist of new message types, new data elements, or new values in the data dictionary. The latest package can be downloaded here, although the link is also available atop the page for quicker access.

Schema archive hierarchy
  • Other - The hierarchy in the downloadable schema package
    • ACKNOWLEDGEMENT.xml - A sample AcuityAcknowledgement response
    • CLIENT-PRODUCT-REQUEST.xml - A sample AcuityClientProductRequest message
    • ORDER-STATUS-REQUEST.xml - A sample AcuityOrderStatusRequest message
  • XSD - Schema files for each message
    • Messages.Addendum - Schemas for acknowledgement addenda
      • CLIENT-PRODUCTS.xsd - The schema for the AcuityClientProducts acknowledgement addendum
      • ORDER-STATUSES.xsd - The schema for the AcuityOrderStatuses acknowledgement addendum
    • Messages.Communal - Schemas for components of other messages
      • AcuityAddress.xsd - The schema for a property address
      • AcuityDocument.xsd - The schema for a separate document
      • ... - Schemas for other message components
    • AcuityAcknowledgement.xsd - The schema for the AcuityAcknowledgement response
    • AcuityAssignment.xsd - The schema for the AcuityAssignment message
    • AcuityBorrowerCorrespondence.xsd - The schema for the AcuityBorrowerCorrespondence message
    • ... - Schemas of the remaining message types
  • ASSIGNMENT.xml - A sample AcuityAssignment messsage
  • CANCELLATION.xml - A sample AcuityCancellation message
  • CANCELLATION-ACCEPT.xml - A sample AcuityCancellationAcceptance message
  • ... - Samples of the remaining message types

Integration Messages

A sampling of common message types are provided below. Samples of all supported messages are provided in the downloadable schema package.

Message In/Out Description
AcuityAcknowledgement In, Out A message is being acknowledged indicating success or failure.
AcuityAssignment In, Out An order has been assigned to a service provider.
AcuityCancellation In, Out An existing order is being cancelled.
AcuityCancellationAcceptance In, Out A prior request for order cancellation is accepted.
AcuityCancellationRejection In, Out A prior request for order cancellation cannot be accepted at this time.
AcuityComment In, Out A general comment is being posted to the history of an order.
AcuityDelay In, Out An existing order is being placed on hold.
AcuityFeeApproval In, Out A prior request for a fee adjustment is accepted or rejected.
AcuityFeeRequest In, Out A request for a fee adjustment is being made on an open order.
AcuityInspectionAppointment In, Out An appointment to inspect a subject property has been scheduled by the service provider.
AcuityInspectionComplete In, Out An agent has completed the required onsite inspection of the subject property.
AcuityOrder In, Out A new order is being placed. The Acuity system can ingest a new order placed with this message. It can also generate an outgoing AcuityOrder message to an integrated vendor.
AcuityOrderAcceptance In, Out A newly received order is accepted.
AcuityOrderRejection In, Out A newly received order is rejected.
AcuityOrderUpdate In, Out New or updated information is being provided on an existing order.
AcuityPayment In, Out The status of a payment or refund on an existing order has been updated.
AcuityQuoteRequest In, Out Request a price for a given product and subject property.
AcuityQuoteResponse In, Out The response to a prior fee request with the anticipated price.
AcuityReport In, Out A completed report is being delivered in fulfillment of an order.
AcuityResume In, Out An existing order is being resumed after previously being on hold.
AcuityRevisionAcceptance In, Out The request for revisions on a completed order has been accepted.
AcuityRevisionRejection In, Out The request for revisions on a completed order has been rejected.
AcuityRevisionRequest In, Out A request for revisions is being made on an order that was previously completed and delivered.
AcuitySubmission In, Out A field agent has submitted a report in fulfillment of an order.
AcuityUpgrade In, Out An existing order is being upgraded to a new product.

AcuityAcknowledgement - Acknowledging an Incoming Message

Each message should result in the synchronous return of an acknowledgement message, providing an indication of success of failure. In the case of a failure, the acknowledgement should provide additional detail on the problems encountered.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityAcknowledgement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-01-12T09:22:33.3791719-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.3</MessageVersion>
  <PartnerReferenceNumber>192894.1</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Success>false</Success>
  <Error>
    <ErrorCode>3009</ErrorCode>
    <ErrorMessage>Handle Request Failed.</ErrorMessage>
  </Error>
</AcuityAcknowledgement>

AcuityAssignment - An Order has been Assigned to a Provider

When a provider has assigned work to a field agent for completion, the provider may notify the customer using the assignment message. This message may be repeated if the provider is forced to re-assign the order to an alternate agent.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityAssignment>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2021-10-30T15:49:25.2070942-07:00</MessageDate>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Fee>550.00</Fee>
  <DueDate>2022-02-15</DueDate>
  <Agent>
    <FirstName>Anna</FirstName>
    <LastName>Praizer</LastName>
    <Address1>1014 N. NoWhere ln</Address1>
    <Address2>Apt #16</Address2>
    <City>Chandler</City>
    <State>Arizona</State>
    <PostalCode>85286</PostalCode>
    <LicenseNumber>12345</LicenseNumber>
    <LicenseState>AZ</LicenseState>
    <LicenseType>LicensedAppraiser</LicenseType>
    <ExpirationDate>2025-10-30T15:49:25.2070942-07:00</ExpirationDate>
  </Agent>
</AcuityAssignment>

AcuityCancellation - Cancel an Existing Order

Customers may initiate an order cancellation process by submitting a request to cancel. The request may require some operational attention, and the cancellation may not be immediately effective despite acknowledgement of the cancellation request.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityCancellation>
	<SenderID>SENDER</SenderID>
	<RecipientID>RECIPIENT</RecipientID>
	<MessageDate>2021-10-30T15:49:25.0790869-07:00</MessageDate>
	<PartnerReferenceNumber>acb123</PartnerReferenceNumber>
	<LineItemNumber>1</LineItemNumber>
	<Reason>AssignedToAnotherProvider</Reason>
	<Comments>This order was assigned to another vendor because we did not receive your acceptance within the allotted time.</Comments>
</AcuityCancellation>

AcuityCancellationAcceptance - Accept a Request for Order Cancellation

Accept a party's request for cancellation of an existing order. This is an asynchronous message sent once a determination has been made whether it is appropriate to cancel an outstanding order.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityCancellationAcceptance xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-01-12T09:22:33.1078923-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.3</MessageVersion>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Comments>This order has been cancelled according to your request.</Comments>
</AcuityCancellationAcceptance>

AcuityCancellationRejection - Reject a Request for Order Cancellation

Reject a party's request for cancellation of an existing order. This is an asynchronous message sent once a determination has been made whether it is appropriate to cancel an outstanding order. This message indicates that an order may have progressed too far in its lifecycle, often with associated expenses, for a cancellation to be granted.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityCancellationRejection xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-01-12T09:22:33.1228522-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.3</MessageVersion>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Comments>This order cannot be cancelled at this time.</Comments>
</AcuityCancellationRejection>

AcuityComment - Post a General Comment on an Order

Customers may submit general comments to be associated with an order, or to answer inquiries from other Acuity users in an automated fashion. Such comments may be up to 8,000 characters in length, and are submitted in a comment request as shown below.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityComment>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2021-10-30T15:49:25.0560856-07:00</MessageDate>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Comments>The property appears to be vacant.</Comments>
  <ActionRequired>false</ActionRequired>
</AcuityComment>

AcuityDelay - Place an Order on Hold

Orders can be placed on hold, during which operational processing is discontinued until further notification. During the period that an order has been placed on hold, no work is performed on the ordered product by the management company or its assigned field agent, and turnaround time will not be accrued. The order may be resumed at a later time. An order that is on hold can also be cancelled by sending a cancellation request.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityDelay>
	<SenderID>SENDER</SenderID>
	<RecipientID>RECIPIENT</RecipientID>
	<MessageDate>2021-10-30T15:49:24.7820699-07:00</MessageDate>
	<PartnerReferenceNumber>acb123</PartnerReferenceNumber>
	<LineItemNumber>1</LineItemNumber>
	<HoldReason>WeatherDelay</HoldReason>
	<Comments>The inclement weather has limited accessibility to the subject property.  Place this order temporarily on hold. </Comments>
</AcuityDelay>

AcuityFeeApproval - Approve a Request a Service Fee Modification

Accept or reject a party's request for adjusting the fee on an open order. This is an asychronous message sent once a determination has been made whether the adjusted service fee is acceptable.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityFeeApproval xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-01-12T09:22:32.9533027-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.3</MessageVersion>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Approved>true</Approved>
  <Comments>The fee request has been approved.</Comments>
</AcuityFeeApproval>

AcuityFeeRequest - Request a Service Fee Modification

During the course of order fulfillment, the nature of the subject property, the requested turnaround time, or other factors may prompt a service provider to request an increase in the fee determined at the time of order placement. If approval is required for a fee change, this message presents that request.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityFeeRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-01-12T09:22:32.9373449-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.3</MessageVersion>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <BillingType>Invoice</BillingType>
  <Fee>50.00</Fee>
  <TotalFee>380.00</TotalFee>
  <Comment>This is a complex property.</Comment>
</AcuityFeeRequest>

AcuityInspectionAppointment - An Appointment has been Scheduled to Inspect a Subject Property

If the field agent performing the requested service needs to schedule an inspection of the subject property, then the appointment time can be communicated back to the customer using the inspection appointment message. This message may be repeated if the agent is forced to re-schedule the appointment.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityInspectionAppointment>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2021-10-30T15:49:25.2820985-07:00</MessageDate>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <AppointmentTime>2021-10-31T15:49:25.2820985-07:00</AppointmentTime>
</AcuityInspectionAppointment>

AcuityInspectionComplete - An Agent has Completed a Subject Property Inspection

The assigned agent has completed the onsite inspection of the subject property. This message is intended to confirm that the scheduled inspection has taken place, generally as a precursor to completing an appraisal, property condition report, or other material.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityInspectionComplete xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-01-12T09:22:32.9183957-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.3</MessageVersion>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <AppointmentTime>2022-01-12T09:22:32.9183957-07:00</AppointmentTime>
  <Comments>This was completed on schedule.</Comments>
</AcuityInspectionComplete>

AcuityOrder - Placing a new Order

New orders can be placed using a data format that describes the desired product, date required, loan information, and other details required for order processing.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityOrder xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<SenderID>SENDER</SenderID>
	<RecipientID>RECIPIENT</RecipientID>
	<MessageDate>2021-10-30T15:49:24.3480451-07:00</MessageDate>
	<PartnerReferenceNumber>acb123</PartnerReferenceNumber>
	<LineItemNumber>1</LineItemNumber>
	<ProductCode>1004</ProductCode>
	<BillingType>Invoice</BillingType>
	<Loan>
		<LoanType>Conventional</LoanType>
		<LoanPurpose>Purchase</LoanPurpose>
		<LoanNumber>ABC-12345</LoanNumber>
		<LoanAmount>0</LoanAmount>
		<FHACaseNumber />
	</Loan>
	<SubjectProperty>
		<Address1>123 Any Street</Address1>
		<City>AnyTown</City>
		<State>AZ</State>
		<PostalCode>12345</PostalCode>
		<SalesPrice>200000</SalesPrice>
		<PropertyType>SingleFamilyResidence</PropertyType>
	</SubjectProperty>
	<ServiceFee>0</ServiceFee>
	<VendorInstructions>Please take photographs of any visible property damage.</VendorInstructions>
	<VendorManagerInstructions>Do not accept if photographs are not included.</VendorManagerInstructions>
	<Contact ContactType="Borrower">
		<FirstName>Joe</FirstName>
		<LastName>Borrower</LastName>
		<DaytimePhone>602-555-1212</DaytimePhone>
		<EveningPhone>602-555-1213</EveningPhone>
	</Contact>
	<Contact ContactType="ClientOrderContact">
		<FirstName>Sally</FirstName>
		<LastName>Broker</LastName>
		<DaytimePhone>480-555-1212</DaytimePhone>
		<EmailAddress>sally.broker@acme.com</EmailAddress>
	</Contact>
	<SuggestedAppointmentTime>2014-11-01T15:49:24.3500452-07:00</SuggestedAppointmentTime>
	<SuggestedAppointmentTime>2014-11-02T20:37:24.3500452-07:00</SuggestedAppointmentTime>
	<Document DocumentType="SalesContract">
		<MimeType>application/pdf</MimeType>
		<Content>JVBERi0xLjMNJeLjz9MNCjYgMCBvYmoNPDwgDS9MaW5lYXJpemVkIDEgDS9PIDggDS9IIFsgNzczIDE3OCBdIA0vT
			CA3NTgyIA0vRSA2MzU0IA0vTiAxIA0vVCA3MzQ1IA0+PiANZW5kb2JqDSAgICAg
			ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg
			ICB4cmVmDTYgMTcgDTAwMDAwMDAwMTYgMDAwMDAgbg0KMDAwMDAwMDY4NCAwMDAwMCBuDQowMDAw
			…
			YWIyYmI4NDBjMjc2ZTAxNjk2NWVlNDg4NTAzMDdhZmE+XQ0+Pg1zdGFydHhyZWYNMTczDSUlRU9G
			DQ==
		</Content>
	</Document>
	<TestTransaction>false</TestTransaction>
	<CostCenter>CostCenter-Echo</CostCenter>
	<IssueTo />
	<CreditCardPayment>
		<CreditCardNumber>0000-0000-0000-0000</CreditCardNumber>
		<ExpirationMonth>1</ExpirationMonth>
		<ExpirationYear>16</ExpirationYear>
		<CVVCode>000</CVVCode>
		<FirstName>Joe</FirstName>
		<LastName>Borrower</LastName>
	</CreditCardPayment>
</AcuityOrder>

AcuityOrderAcceptance - Indicate Acceptance of a New Order

When an order has been sent to the provider, and the provider chooses to accept it, an order acceptance message must be exchanged. Failure to return such a message may result in the customer placing the same order with another provider.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityOrderAcceptance>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2021-10-30T15:49:25.1270896-07:00</MessageDate>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Conditions>
    <RevisedDueDate>2014-11-05T15:49:25.1270896-07:00</RevisedDueDate>
    <RevisedFee>60</RevisedFee>
  </Conditions>
</AcuityOrderAcceptance>

AcuityOrderRejection - Indicate Rejection of a New Order

Occasionally a provider wishes to decline an order sent to it by a customer. A provider may not cover the indicated geographic area or may not offer the requested service. Rejection of an order is deemed a closing event for that order, and no further communication should be received by the provider for the same transaction.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityOrderRejection>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2021-10-30T15:49:25.1730923-07:00</MessageDate>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Comments>This order is for a product type we do not support.</Comments>
</AcuityOrderRejection>

AcuityOrderUpdate - Update Information on an Existing Order

Following placement of a new order, there may be additional or corrected information that needs to be exchanged between parties. This message allows for the update of subject property, loan, contact and other information associated with an order. It also accommodates the exchange of additional documents.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityOrderUpdate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-01-12T09:22:33.1378124-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.3</MessageVersion>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Contacts ContactType="ClientOrderContact">
    <FirstName>Ben-Updated</FirstName>
    <LastName>Broker-Updated</LastName>
    <DaytimePhone>480-555-1717-Updated</DaytimePhone>
    <EveningPhone>480-555-5111-Updated</EveningPhone>
    <MobilePhone>480-555-2222-Updated</MobilePhone>
    <EmailAddress>Ben.broker@acme-Updated.com</EmailAddress>
  </Contacts>
  <Contacts ContactType="Borrower">
    <FirstName>Ben-Updated</FirstName>
    <LastName>Broker-Updated</LastName>
    <DaytimePhone>480-555-1717-Updated</DaytimePhone>
    <EveningPhone>480-555-5111-Updated</EveningPhone>
    <MobilePhone>480-555-2222-Updated</MobilePhone>
    <EmailAddress>Ben.broker@acme-Updated.com</EmailAddress>
  </Contacts>
  <Loan>
    <LoanType>FHA</LoanType>
    <LoanPurpose>HomeEquity</LoanPurpose>
    <LoanNumber>ABC-4-Updated</LoanNumber>
  </Loan>
  <Documents>
    <Document DocumentType="SalesContract">
      <MimeType>application/pdf</MimeType>
		<Content>JVBERi0xLjMNJeLjz9MNCjYgMCBvYmoNPDwgDS9MaW5lYXJpemVkIDEgDS9PIDggDS9IIFsgNzczIDE3OCBdIA0vT
			CA3NTgyIA0vRSA2MzU0IA0vTiAxIA0vVCA3MzQ1IA0+PiANZW5kb2JqDSAgICAg
			ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg
			ICB4cmVmDTYgMTcgDTAwMDAwMDAwMTYgMDAwMDAgbg0KMDAwMDAwMDY4NCAwMDAwMCBuDQowMDAw
			…
			YWIyYmI4NDBjMjc2ZTAxNjk2NWVlNDg4NTAzMDdhZmE+XQ0+Pg1zdGFydHhyZWYNMTczDSUlRU9G
			DQ==
		</Content>
    </Document>
  </Documents>
  <Comments>
    <Comment>
      <SenderID>SENDER</SenderID>
      <RecipientID>RECIPIENT</RecipientID>
      <MessageDate>2022-01-12T09:22:33.1378124-07:00</MessageDate>
      <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
      <LineItemNumber>1</LineItemNumber>
      <Comments>The property appears to be vacant.</Comments>
      <ActionRequired>false</ActionRequired>
    </Comment>
    <Comment>
      <SenderID>SENDER</SenderID>
      <RecipientID>RECIPIENT</RecipientID>
      <MessageDate>2022-01-12T09:22:33.1378124-07:00</MessageDate>
      <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
      <LineItemNumber>1</LineItemNumber>
      <Comments>Test Test.</Comments>
      <ActionRequired>false</ActionRequired>
    </Comment>
  </Comments>
</AcuityOrderUpdate>

AcuityPayment - Indicate Payment has been made on an Existing Order

A payment has been made, refund has been processed, or the settlement status has been updated for an existing order.

copy 

<?xml version="1.0" encoding="utf-16"?>
<AcuityPayment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-01-12T09:22:33.2674682-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.3</MessageVersion>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <PaymentStatus>PaymentSubmitted</PaymentStatus>
  <Amount>100</Amount>
  <ApprovalCode>0137</ApprovalCode>
  <PaymentType>Cash</PaymentType>
  <PaymentTrackingNumber>623478900787</PaymentTrackingNumber>
  <AuthorizingUser />
  <Comments>The payment was processed successfully.</Comments>
</AcuityPayment>

AcuityQuoteRequest - Request a Price

To determine the anticipated cost for a given product and subject property, a customer can request a fee quote.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityQuoteRequest>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-08-11T08:58:07.8644462-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.5</MessageVersion>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
</AcuityQuoteRequest>

AcuityQuoteResponse - Receive a Response to a Quote Request

If a quote has been requested, this message provides the asynchronous response providing the anticipated fee.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityQuoteResponse>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-08-11T08:58:07.8993595-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.5</MessageVersion>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Fee>80</Fee>
</AcuityQuoteResponse>

AcuityReport - A Report has been Completed by the Provider

When the provider has deemed a service complete, the report message is exchanged. It may include any final deliverable documents, including an invoice for services rendered. Several of these items may be optional, depending on the requirements of your trading partners. In particular, the ValuationInformation section can typically be omitted. The FormField elements would only be necessary when you've been specifically instructed to pass data fields for a custom Acuity form. In such cases, additional documentation would be provided that lists all of the data points and their respective data types.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityReport>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2021-10-30T15:49:25.4821099-07:00</MessageDate>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Correction>false</Correction>
  <Fees>
    <VendorFee>30</VendorFee>
    <ManagementFee>50</ManagementFee>
    <TotalFees>80</TotalFees>
  </Fees>
  <License>
    <LicenseNumber>28548</LicenseNumber>
    <BusinessLicenseType>AppraisalManagementCompany</BusinessLicenseType>
  </License>
  <ValuationInformation>
    <Condition>AboveAverage</Condition>
    <BuiltUp>At25to75Percent</BuiltUp>
    <AppraisedValue>1000000</AppraisedValue>
    <Bedrooms>3</Bedrooms>
    <Bathrooms>1</Bathrooms>
    <DateOfPriorSale>0001-01-01T00:00:00</DateOfPriorSale>
    <DateOfContract>2021-10-30T15:49:25.48311-07:00</DateOfContract>
  </ValuationInformation>
  <Document DocumentType="AppraisalReport">
    <MimeType>application/pdf</MimeType>
    <Content>JVBERi0xLjMNJeLjz9MNCjYgMCBvYmoNPDwgDS9MaW5lYXJpemVkIDEgDS9PIDggDS9IIFsgNzcz
DQ==
</Content>
  </Document>
  <FormField Form="FNMA-1004-v2005" Field="ORDER_NUMBER" Value="acb123" />
  <FormField Form="FNMA-1004-v2005" Field="SUBJ_STREET_ADDRESS" Value="123 Main St" />
  <FormField Form="FNMA-1004-v2005" Field="SUBJ_CITY" Value="Tempe" />
  <FormField Form="FNMA-1004-v2005" Field="SUBJ_STATE" Value="AZ" />
  <FormField Form="FNMA-1004-v2005" Field="SUBJ_POSTAL_CODE" Value="85282" />
</AcuityReport>

AcuityResume - Resume an Order Currently on Hold

An order that has been previously placed on hold can be resumed by sending a resume request. Sending a resume request for an order that is not currently on hold has no effect.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityResume>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2021-10-30T15:49:24.8350729-07:00</MessageDate>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Comments>The weather has abated and the subject property is now accessible.  Please schedule the inspection as soon as possible.</Comments>
</AcuityResume>

AcuityRevisionAcceptance - Accept a Prior Request for Revisions on a Completed Order

This message indicates approval and an intent to proceed with revisions requested after delivery of the final product.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityRevisionAcceptance xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-01-12T09:22:32.6720545-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.3</MessageVersion>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Comments>The revision has been accepted.</Comments>
</AcuityRevisionAcceptance>

AcuityRevisionRejection - Reject a Prior Request for Revisions on a Completed Order

This message indicates that revisions requested to a final product are not necessary or applicable.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityRevisionRejection xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2022-01-12T09:22:32.7059626-07:00</MessageDate>
  <System>Acuity</System>
  <MessageVersion>5.3</MessageVersion>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Comments>Comparable properties are the closest available in this rural area.  No better comparables exist at closer proximity to the subject.</Comments>
</AcuityRevisionRejection>

AcuityRevisionRequest - Initiate a Correction Request on a Completed Order

Following delivery of the final product, clients may indicate that some correction is required. A review will commence following receipt of the request, and if necessary the field agent will be notified to make adjustments to the final product.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityRevisionRequest>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2021-10-30T15:49:24.8670747-07:00</MessageDate>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Comments>The comparable property sales prices do not bracket the subject.  Are alternate comparable properties available?</Comments>
  <Document DocumentType="AppraisalReport">
    <MimeType>application/pdf</MimeType>
    <Content>JVBERi0xLjMNJeLjz9MNCjYgMCBvYmoNPDwgDS9MaW5lYXJpemVkIDEgDS9PIDggDS9IIFsgNzcz
…
YWIyYmI4NDBjMjc2ZTAxNjk2NWVlNDg4NTAzMDdhZmE+XQ0+Pg1zdGFydHhyZWYNMTczDSUlRU9GDQ==
    </Content>
  </Document>
</AcuityRevisionRequest>

AcuitySubmission - A Report has been Submitted by the Field Agent

When the service is complete and a document is submitted by the agent in fulfillment of that service, the provider can alert the customer that the report has been submitted. Of course, some additional processes may remain, such as the provider’s quality control mechanism. However, this provides some interim information to keep the client informed of progress.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuitySubmission>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2021-10-30T15:49:25.2510967-07:00</MessageDate>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <Comments>Final report submitted by vendor, awaiting any pending quality control.</Comments>
</AcuitySubmission>

AcuityUpgrade - Upgrade an Existing Order

Once an order is placed, the requested product cannot be altered. The Acuity platform provides for product changes by either (1) cancellation of the original order and placement of a new order with the desired product, or (2) a product upgrade path in which an upgrade request causes the original order to be automatically replaced with the new product, utilizing the original field agent when possible. Business leaders can discuss the operational and accounting details of the upgrade process during an integration project.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityUpgrade>
  <SenderID>SENDER</SenderID>
  <RecipientID>RECIPIENT</RecipientID>
  <MessageDate>2021-10-30T15:49:25.1020882-07:00</MessageDate>
  <PartnerReferenceNumber>acb123</PartnerReferenceNumber>
  <LineItemNumber>1</LineItemNumber>
  <ProductCode>1073</ProductCode>
  <Instructions>Please beware of dog in back yard.</Instructions>
  <DueDate>2014-11-09T15:49:25.1020882-07:00</DueDate>
  <PropertyType>Other</PropertyType>
  <LoanType>Other</LoanType>
</AcuityUpgrade>

Product Type-Specific Content

Some types of products can contain information that is unique. In particular, valuation, title, and flood products can each house data elements that are not common. While none of the sections described in this section are required per the schema, your specific trading partners may request this information in fulfillment of orders. These sections are part of the AcuityReport message that is used to deliver a completed product to the requester. The content of these sections is described below.

AcuityFlood - Provide information specific to flood determination products

A trading partner requesting a flood determination product may request the following information.

copy 

<FloodInformation>
  <StateCode>AZ</StateCode>
  <CountyCode>013</CountyCode>
  <CensusTract>6059.02</CensusTract>
  <MSACode>10000</MSACode>
  <FEMACommunityName>Presidio Ranch</FEMACommunityName>
  <SpecialFloodHazardArea>true</SpecialFloodHazardArea>
  <FloodCertCompany>Flood Masters LLC</FloodCertCompany>
  <NFIPStatusType></NFIPStatusType>
  <FloodMapPanelNumber>1090</FloodMapPanelNumber>
  <MapRevisedDate>2024-06-28</MapRevisedDate>
  <NFIPCommunityNumber>48300</NFIPCommunityNumber>
  <FloodInsNotAvailable>false</FloodInsNotAvailable>
  <InsDeterminationNumber>Unknown</InsDeterminationNumber>
  <InsDeterminationDate>2024-07-01</InsDeterminationDate>
  <FloodCertNumber>43809991</FloodCertNumber>
  <FloodZoneCode>A</FloodZoneCode>
  <FloodZone>false</FloodZone>
  <LOMALOMR>false</LOMALOMR>
  <LOMALOMRDate>2024-03-15</LOMALOMRDate>
  <LOMALOMRCaseNumber>12333090290</LOMALOMRCaseNumber>
  <FloodProgramCode></FloodProgramCode>
</FloodInformation>

AcuityTitle - Provide information specific to title insurance products

A trading partner requesting a title insurance product may request the following information.

copy 

<TitleInformation>
  <Lot>133</Lot>
  <Block>53</Block>
  <Section>555</Section>
  <TaxNotes>None</TaxNotes>
  <SpecialEndorsements>N/A</SpecialEndorsements>
  <RecordingJurisdictionType></RecordingJurisdictionType>
  <RecordingJurisdictionName>Jurisdiction Name</RecordingJurisdictionName>
  <TitleFileNumber>53-400015</TitleFileNumber>
  <EscrowNumber>80993011</EscrowNumber>
  <AgentReferenceNumber>None</AgentReferenceNumber>
  <TitleCompany>
    <Company>ACME Title</Company>
    <Address1>123 Title Way</Address1>
    <Address2>Suite 101</Address2>
    <City>Chandler</City>
    <State>AZ</State>
    <PostalCode>85286</PostalCode>
  </TitleCompany>
  <TitleContact>
    <ContactType>TitleOfficer</ContactType>
    <FirstName>Joey</FirstName>
    <LastName>McClintock</LastName>
    <DaytimePhone>602-555-1000</DaytimePhone>
    <FaxNumber>602-555-1001</FaxNumber>
    <EmailAddress>jmcclintock@acmetitle.com</EmailAddress>
  </TitleContact>
  <EscrowCompany>
    <Company>ACME Escrow</Company>
    <Address1>123 Title Way</Address1>
    <Address2>Suite 102</Address2>
    <City>Chandler</City>
    <State>AZ</State>
    <PostalCode>85286</PostalCode>
  </EscrowCompany>
  <EscrowContact>
    <ContactType>EscrowContact</ContactType>
    <FirstName>Susan</FirstName>
    <LastName>Escrow</LastName>
    <DaytimePhone>800-555-1002</DaytimePhone>
    <FaxNumber>800-555-1003</FaxNumber>
    <EmailAddress>susan@acmeescrow.com</EmailAddress>
  </EscrowContact>
  <SettlementAgent>
    <Company>ACME Closing Services</Company>
    <Address1>123 Title Way</Address1>
    <Address2>Suite 103</Address2>
    <City>Chandler</City>
    <State>AZ</State>
    <PostalCode>85286</PostalCode>
  </SettlementAgent>
  <SettlementContact>
    <ContactType>ClosingAgent</ContactType>
    <FirstName>Clarence</FirstName>
    <LastName>Closing</LastName>
    <DaytimePhone>800-555-1004</DaytimePhone>
    <FaxNumber>800-555-1005</FaxNumber>
    <EmailAddress>clarence@acmeclosing.com</EmailAddress>
  </SettlementContact>
</TitleInformation>

UAD 3.6-Specific Content

The new Uniform Appraisal Dataset (UAD) provides a single, standardized report for any residential property. Appraisals where previously divided into different form types largely based on property type. The replacement of the legacy forms changes the property data that should be disclosed to an appraiser to determine the scope of work and corresponding appraisal fee. The integration schema described herein provides for the inclusion of these data points to accurately facilitate the ordering of UAD 3.6 appraisals.

The data points added to the schema to specifically support UAD 3.6 are defined below. None of these data points will be initially required, even when ordering UAD 3.6 appraisals, while the valuation industry progresses through the transition period. That said, failure to include these data points may result in fulfillment delays. These data points are not required for other types of products, though it is perfectly acceptable to include them.

It should be noted that requesting a UAD 3.6 appraisal will result in a completed report delivered in the UAD 3.6 report format, which is a compressed (zipped) file containing a MISMO 3.6 XML file and other artifacts. This is markedly different than the MISMO 2.6 format currently delivered with traditional numbered appraisal forms.

Data Point Data Type
Accessory Dwelling Units Positive Integer
Attachment Type Enumeration (see Data Dictionary for allowed values)
Construction Method Enumeration (see Data Dictionary for allowed values)
Estate Type Enumeration (see Data Dictionary for allowed values)
Land Owned in Common Boolean (True or False)
Living Units Excluding ADUs Positive Integer
Project Legal Structure Enumeration (see Data Dictionary for allowed values)
Project Number of Units Positive Integer
PUD Boolean (True or False)
Rent Schedule Boolean (True or False)
Valuation Method Enumeration (see Data Dictionary for allowed values)

This information would be provided within the aforementioned AcuityOrder message. The elipses in the example provided below are intended to act as placeholders for the information that would normally appear in this message. The only XML elements shown are the ones referred to above for the procurement of UAD 3.6 appraisals.

copy 

<?xml version="1.0" encoding="utf-8"?>
<AcuityOrder>
  ...
  <AccessoryDwellingUnits>0</AccessoryDwellingUnits>
  <AttachmentType>Detached</AttachmentType>
  <ConstructionMethod>SiteBuilt</ConstructionMethod>
  <EstateType>FeeSimple</EstateType>
  <LandOwnedInCommon>true</LandOwnedInCommon>
  <LivingUnitsExcludingADU>1</LivingUnitsExcludingADU>
  <ProjectLegalStructure></ProjectLegalStructure>
  <ProjectUnits></ProjectUnits>
  <PUD>false</PUD>
  <RentSchedule>false</RentSchedule>
  <ValuationMethod>TraditionalAppraisal</ValuationMethod>
  ...
</AcuityOrder>

Data Dictionary

There is a collection of allowed values for certain data elements. Those fields with data elements that adhere to such restrictions are provided in the data dictionary below.

Message Data Point Allowable Values
AcuityCancellation Reason AssignedToAnotherProvider
CoverageUnavailable
CustomerRequestedCancellation
CustomerUnresponsive
DataUnavailable
DuplicateOrder
IncorrectLoanNumber
IncorrectProductOrdered
InvalidPropertyAddress
LoanApplicationWithdrawn
NoPropertyAccess
OrderedInError
Other
PropertyNotComplete
RepairsNotComplete
RightOfRescission
AcuityDelay Reason AccessContactInvalid
AccessContactMissedAppointment
AccessContactUnknown
AccessContactUnresponsive
AwaitingAdditionalInformation
AwaitingCondominiumInformation
AwaitingCooperativeInformation
AwaitingFeeApproval
AwaitingSalesContract
BorrowerDelayedInspection
CancellationPending
DataUnavailable
LenderDelay
NoPropertyAccess
NoPropertyVisibility
OccupantResistsInspection
Other
ProductIncorrect
PropertyAddressInvalid
PropertyConditionProhibitive
PropertyNotComplete
PropertyNotFound
RealtorDelay
RepairsNotComplete
PropertyVacant
RuralArea
SuspectedDuplicateOrder
WeatherDelay
AcuityOrder AttachmentType Attached
Detached
AcuityOrder BillingType Deferred
Invoice
Prepaid
AcuityOrder ConstructionMethod Container
Manufactured
Modular
OnFrameModular
Other
SiteBuilt
ThreeDimensionalPrintingTechnology
AcuityOrder ContactType Attorney
Borrower
BorrowerRepresentative
BorrowerTranslator
Builder
BuyingAgent
CaseFileDataService
ClientOrderContact
ClosingAgent
Coborrower
CoborrowerSecond
CoborrowerThird
EscrowContact
Lender
ListingAgent
LoanOfficer
MortgageBroker
PaymentContact
PropertyAccess
PropertyManager
QuaternaryClientOrderContact
QuinaryClientOrderContact
Realtor
SecondaryClientOrderContact
Seller
SellerOwner
TertiaryClientOrderContact
TitleOfficer
Underwriter
AcuityOrder
AcuityReport		 DocumentType AppraisalData
AppraisalReport
AutomatedForm
AutomatedValuationData
AutomatedValuationReport
BrokerPriceOpinion
BrokerPriceOpinionReport
ClientEngagementLetter
GoodFaithEstimate
Invoice
InsuranceTerminationDisputeForm
InsuranceTerminationDisputeDocument
LoanApplication
MultipleListingServiceSheet
Other
PayoffStatement
Photograph
PlansAndSpecifications
PriorAppraisal
PropertyImprovementsList
PropertyInspection
QualityControlReport
SalesContract
Sketch
TaxAssessment
UCDPSubmissionSummaryReport
VendorEngagementLetter
AcuityOrder EstateType FeeSimple
Leasehold
Other
AcuityOrder LoanPurpose Auction
AssetValuation
Bridge
ChargeOff
Construction
DebtConsolidation
DeedInLieu
Foreclosure
HomeEquity
Leasehold
LoanModification
None
Other
Preforeclosure
Purchase
Refinance
Relocation
Renewal
REO
ShortSale
AcuityOrder LoanType Conventional
FHA
FHA203K
FMHA
HELOC
None
Other
PublicHousing
ReverseMortgage
USDA
VA
AcuityOrder ProjectLegalStructure Condominium
Condop
Cooperative
AcuityOrder ValuationMethod AutomatedValuationModel
BrokerPriceOpinion
DesktopAppraisal
ExteriorAppraisal
HybridAppraisal
None
Other
TraditionalAppraisal
AcuityAssignment LicenseType LicensedAppraiser
CertifiedGeneralAppraiser
CertifiedResidentialAppraiser
None
NotaryPublic
ProvisionalAppraiser
RealEstateAgent
RealEstateBroker
AcuityReport NeighborhoodBuiltUp Over75Percent
At25To75Percent
Under25Percent
AcuityReport NeighborhoodGrowthRate Rapid
Stable
Slow
AcuityReport NeighborhoodPropertyValues Increasing
Stable
Declining
AcuityReport NeighborhoodSupplyAndDemand Shortgage
InBalance
OverSupply
AcuityReport AverageMarketingTime UnderThreeMonths
ThreeToSixMonths
OverSixMonths
AcuityReport ZoningComplianceType NoZoning
Legal
LegalGrandfathered
Illegal
AcuityReport FoundationType ConcreteSlab
CrawlSpace
FullBasement
PartialBasement
AcuityReport PropertyRightsAppraised FeeSimple
Leasehold
Other
AcuityReport StructureType Attached
Detached
SDetEndUnit
AcuityReport PropertyType Agricultural
Apartment
Commercial
CondoHotel
Condominium
Cooperative
Duplex
Manufactured
MobileHome
Modular
MultiFamilyResidence
Other
PlannedUrbanDevelopment
Quadplex
SingleFamilyResidence
Townhouse
Triplex
VacantLand
AcuityReport PropertyCondition AboveAverage
Average
BelowAverage
Excellent
Fair
Good
Poor
AcuityReport PropertyOccupancy Abandoned
Destroyed
Other
Owner
Secondary
Tenant
Unknown
Vacant
AcuityReport PropertyLocation Rural
Suburban
Urban
AcuityReport CorrespondenceType FinalReportNotification
FinalReportDownloaded

Error Codes

Several error messages are possible during the submission of requests. Most error conditions are self-explanatory and typically occur due to (1) network communication problems, (2) data formatting errors, (3) incomplete or inaccurate information, or (4) the state of an order does not allow the request to be completed. The first digit of the error code classifies the problem into one of those groups. Error messages that may be returned are listed below.

Error Code Error Type Description
0401 Network (HTTP) Communication Unauthorized, i.e. Incorrect Credentials Provided
0500 Network (HTTP) Communication Internal Server Error
0501 Network (HTTP) Communication Not Implemented
1000 Invalid Message Format Invalid Message Format
1002 Invalid Message Format Unsupported Transport Format
1003 Invalid Message Format Unsupported Transport Request Format
1004 Invalid Message Format Unsupported Partner Number Format
1005 Invalid Message Format Unsupported Transport Sender Format
1006 Invalid Message Format Missing Acuity Transport Partner Number
1007 Invalid Message Format Required Response Format
1008 Invalid Message Format The sender of the message is required
1009 Invalid Message Format The intended recipient is required
1010 Invalid Message Format A cancellation reason code is required
1011 Invalid Message Format A comment is required
1012 Invalid Message Format An appointment time is required
1013 Invalid Message Format A product identifier is required
1014 Invalid Message Format A comment when rejecting a revision request is required
1015 Invalid Message Format A comment regarding the requested revision is required
1016 Invalid Message Format A desired product code is required
1017 Invalid Message Format A street address is required
1018 Invalid Message Format A city is required for an address
1019 Invalid Message Format A state is required for an address
1020 Invalid Message Format A postal code is required for an address
1021 Invalid Message Format A last name is required, at a minimum, for any contact person
1022 Invalid Message Format You are required to specify the document's MIME type or FileName to identify the type of file being included.
1023 Invalid Message Format The document content is required
1024 Invalid Message Format An FHA Case Number is required for this transaction
1025 Invalid Message Format A form name is required for any field
1026 Invalid Message Format A field name is required for any field
1027 Invalid Message Format A client identifier is required
1028 Invalid Message Format A client branch identifier is required
1029 Invalid Message Format AcuityTransport is Required.
1030 Invalid Message Format IntegratedURL is Required.
1031 Invalid Message Format AcuityExchange is Required.
1032 Invalid Message Format A borrower is required for this transaction.
1033 Invalid Message Format Request data is required
1034 Invalid Message Format AcuityDocument content or FormField is required
1035 Invalid Message Format Unsupported XML format
1036 Invalid Message Format An XML element contains no value. Remove the element or specify a value.
1037 Invalid Message Format A submission date is required.
1038 Invalid Message Format A value for the passed flag is required
1039 Invalid Message Format IgnoredProcessReason Required.
1040 Invalid Message Format The payment status was not specified
1041 Invalid Message Format A fee is required
1042 Invalid Message Format A due date is required
1044 Invalid Message Format Recipient IntegrationURL required
1045 Invalid Message Format GenericMessageType is required
1046 Invalid Message Format GenericDataField Name is required
1047 Invalid Message Format GenericDataField Value is required
2000 Invalid Data General Invalid Data Format
2001 Invalid Data Invalid date/time format
2002 Invalid Data Invalid date format
2003 Invalid Data Invalid Time Format
2004 Invalid Data Invalid Order Format
2005 Invalid Data Invalid Order Item Format
2006 Invalid Data Invalid Content Format
2007 Invalid Data ServiceFee out of Range
2008 Invalid Data Unable to handle this message
2009 Invalid Data Invalid order id.
2010 Invalid Data No corresponding order with the supplied information was found.
2011 Invalid Data No corresponding order item with the supplied information was found.
2012 Invalid Data Invalid or missing on hold reason
2013 Invalid Data No loan purposes found.
2014 Invalid Data Invalid or missing loan purpose
2015 Invalid Data No property types found
2016 Invalid Data Invalid or missing on property ID
2017 Invalid Data No property types found
2018 Invalid Data Invalid or missing property type
2019 Invalid Data A contact type is required
2020 Invalid Data Invalid or missing contact type
2021 Invalid Data Invalid vendor account
2022 Invalid Data Expired vendor membership
2023 Invalid Data Unable to handle this message
2024 Invalid Data The supplied partner reference number is invalid
2025 Invalid Data Invalid PaymentTrackingNumber
2026 Invalid Data The specified payment status is unsupported.
3000 Operational Error General Rejection
3001 Operational Error Invalid order identifier
3002 Operational Error Invalid order item identifier
3003 Operational Error The client profile associated with this order cannot be determined
3004 Operational Error The branch profile associated with this order cannot be determined
3005 Operational Error The specified client profile is marked as inactive
3006 Operational Error The specified branch profile is marked as inactive
3007 Operational Error A loan number is required for the specified product
3008 Operational Error A borrower’s name is required for the specified product
3009 Operational Error Handle Request Failed.
3010 Operational Error The requested product code is not recognized
3011 Operational Error The client profile associated with this request is not configured for the requested product
3012 Operational Error A client order contact or payment contact is required for all prepaid orders
3013 Operational Error No on hold reasons are configured.
3014 Operational Error Order state is completed or cancelled, cannot perform this operation on this order
3015 Operational Error The current order state does not permit this operation.
3016 Operational Error Log service Unavailable.
3017 Operational Error The specified form set is not recognized
3018 Operational Error Invalid Provider.
3019 Operational Error An order already exists with the specified partner reference number
3020 Operational Error Not a prepaid order.
3021 Operational Error The specified order item has not yet been completed.
3022 Operational Error AcuityPartner Required.
3023 Operational Error Credentials not configured for client.
3024 Operational Error Account credentials not configured for client.
3025 Operational Error The specified order item has not yet been completed.
3026 Operational Error Invalid PaymentTrackingNumber.
3027 Operational Error Unable to obtain printed report.
3028 Operational Error No record using the given ProviderReferenceNumber could be found or created.
3029 Operational Error Message transaction could not be logged.
3030 Operational Error Vendor is not assigned to this order.
3031 Operational Error SingleOrder record missing a valid senderID or valid AcuityBulkorder SenderID
3032 Operational Error SingleOrder missing a valid ProductID
3033 Operational Error No SingleOrders are prorvided in the AcuityBulkorder
3034 Operational Error A lockbox code or at least one access contact phone number or email address is required for this product.
3035 Operational Error This product is no longer available
3036 Operational Error Vendor does not have sufficient capacity to accept this order
3037 Operational Error Vendor does not have a qualifying license for this order
3038 Operational Error This product does not allow negotiation
3039 Operational Error This order cannot be upgraded to the same product

FAQ

The answers to many common questions can be found in the section below.

  • Where do I get the sender and recipient values?

    If you are creating an Acuity integration directly between two known Acuity platforms, then only the sender is relevant and you can agree on the value(s) you want to use. If Acuity is acting as the client system, then vendors should use their corresponding VendorIDs as the sender of any messages. However, if ClearValue is acting as a relay agent between multiple Acuity systems, then both sender and recipient codes are required and will be assigned by ClearValue.

  • What is a partner reference number (PartnerReferenceNumber in the schema)?

    A partner reference number is merely a foreign transaction number. It is a means for another trading partner to specify their own identifier, or order number, for which a message is being sent. This value will be echoed in the acknowledgement and supplied with all outgoing messages.

  • What is a line item number (LineItemNumber in the schema)?

    A line item number is an optional mechanism for grouping several different orders under a single umbrella. This might be useful when multiple products, such as appraisal, title, and closing services are all being procured for the same loan. The partner reference number would identify the loan, and the line item number would identify which product within that loan was the subject of the message.

  • Is message content sent in the body of the POST?

    Yes, the integration messages described in this guide are sent in the body and not as a form field.

  • How large can documents be?

    The size of a document depends heavily on the type of document and, for the final deliverables, on the product requested. Most inspections and valuations can be several megabytes in size, with commercial products generally being larger because of the increased number of photographs present. Acuity has a default maximum document size of 100MB, but it is best to consult with your trading partners in case they have augmented that value.

  • Can messages be sent repeatedly, such as sending the AcuityAssignment message more than once if the order has been assigned to different agents?

    Absolutely. You do not need to suppress messages of the same type if the triggering event occurs multiple times.