Purpose
Back To HomeThis Provider Implementation Guide provides the information required for a successful implementation of receiving and returning Lien Release orders and order status using the MortgageSats API integration.
This document is created, maintained, and distributed by Avanze Tech Labs Inc. to communicate the implementation requirements to their vendors/partners. Avanze supports the contents included in the Provider Implementation Guide when the document originates from Avanze.
Partner ID
Archwell will be sending order request and other respective events with the following Mortgage Partner IDs. Providers should confirm that all Archwell MortgageSats Partner IDs are configured in their appropriate environment.
Production Environment
Partner ID | Partner Name |
---|---|
MSats**** | ***** |
UAT Environment
Party ID | Party Name |
---|---|
MSats**** | ***** |
Products
Archwell will be ordering the following products through MortgageSats. Providers should verify that their MortgageSats interface supports these products and represents the correct geographic coverage to meet Archwell needs. This product listing contains all possible products that Archwell will be ordering on the MortgageSats platform. Providers should refer to their specific service level agreement with Archwell and configure the products that are applicable to their MortgageSats interface for this implementation.
Product Code | Product Name |
---|---|
1 | Lien Release |
2 | Assignment |
Note: In future we can have dynamic setup for the product based upon business needs.
Connectivity Detail
HTTP Post
The HTTP Post Method may be implemented for the purpose of inbound event transmission. Partner can send files via HTTP and will receive an XML Response informing them of the status of their submission. This is most frequently used in integrations for the posting. HTTP Posting can also be used as a delivery method for integration partners who choose to receive files via HTTP. HTTPS or SSL (Secure Sockets Layer) is the most common implementation of this method, due to SSL’s security benefits.
Integration partners may also choose to develop an HTTP Receiver of their own, in which they would receive via HTTP Post. Following URL will be used by integration to post inbound events to Msats API application which will route the events to Msats application.
UAT URL:
https://avanzeapi.com/mortgagesats/organization/PartnerName
PRODUCTION URL:
https://avanzeapi.com/mortgagesats/organization/PartnerName
Authorization through POST Parameters
Two parameters are required in order submit requests through HTTPs POST.
Username = [USER]
Password = [PASSWORD]
Username and password value used to authenticate incoming request. These values are defined in Msats API application for each integrator.
Authorization through Header
Instead of sending credentials in plain text through post parameters, an authenticated request includes the Authorization Header Variable. If this header is not included, the request is anonymous and may not succeed against API services.
To authenticate a request, you must encode the combined username and password in the request.
The format for the Authorization header is as follows:
Authorization: Basic [Encoded-Base64-String]
Constructing the Basic Authentication
Username and password are combined into a string “username:password”
The result string is then encoded using Base64.
In Header authorization, add “Basic” before the encoded string. There should be space in between “Basic” and encoded string
API Events
Event Code | Event Name | Event Originator | MSATS Sending | MSATS Receiving | Event Definition |
---|---|---|---|---|---|
AT01 | PlaceOrder | MSATS | R | MSats sends this event to initiate an order request to CoreLogic. | |
AT02 | AcceptOrder | Partner | R | CoreLogic sends this event to MSats to inform MSats the CoreLogic accepts the order request. | |
AT03 | RejectOrder | Partner | R | CoreLogic sends this event to MSats to inform MSats the CoreLogic does not accept the order request. | |
AT04 | ProductDelivery | Partner | R | CoreLogic sends this event to MSats with the order documents. | |
AT05 | AddNotes | Both | O | O | MSats and/or CoreLogic send this event to provide a note on an order request. |
AT06 | OnHoldOrder | Both | O | O | MSats and/or CoreLogic send this event to place the order request on hold. |
AT07 | CancelOrder | Both | R | R | MSats and/or CoreLogic send this event to cancel the order request. |
AT08 | ResumeOrder | Both | O | O | MSats or CoreLogic sends this event to resume a service order request that has been cancelled or put on hold. |
AT16 | Add Document | Both | O | O | MSats and/or CoreLogic send this event to provide a document on an order request. |
AT10 | CompleteOrder | Partner | R | The CoreLogic sends this event to the MSats to notify the MSats that the order request is complete. | |
AT40 | OrderStatus | Partner | R | The CoreLogic sends this event to the MSats periodically to notify the current status the order. | |
AT41 | GetStatus | MSats | R | The MSats sends this event to the CoreLogic periodically to notify the current status the order. |
*Mandatory R - Required Events that will occur on all Orders. O - Optional Events that if they occur on an Order, CoreLogic is required to support.
MortgageSats API WorkFlow
Archwell has documented the workflow process they require of their Partners which includes the ordering and completion of products.
API Events & Description
Order Placement 1. MSats will create the Order Requests (MSatsAPI Event AT01) 2. Msats API will route the orders to CoreLogic.
Confirmation of the orders 3. CoreLogic will confirm the request (MSatsAPI Event AT02) for the order. 4. If CoreLogic does not accept the order, CoreLogic will decline the order by sending Order Not Accepted by CoreLogic (MSatsAPI Event AT03) on the order.
Order Process 5. When the order is complete, CoreLogic will upload the documents using Document Delivered by CoreLogic (MSatsAPI Event AT04).
Completion of Order 6. Upon completion of the order, CoreLogic will send Order Completed (MSatsAPI Event AT10) to the order to indicate the order is complete.
General Use Events 7. CoreLogic should post any notes or events to MSats by sending Note (MSatsAPI Event AT05) on the applicable order. Note (MSatsAPI Event AT05) will also be utilized by the MSats on the applicable order to relay information to CoreLogic. 8. The MSats and/or CoreLogic may communicate that the order is on hold by sending Order On-Hold (MSatsAPI Event AT06) event. The Order Resume (MSatsAPI Event AT06) is sent to resume an order that has been put on hold (MSatsAPI Event AT08). 9. The CoreLogic sends this Order Status (MSatsAPI Event AT40) event to the MSats periodically to notify the current status the order. 10. The Msats sends this Get Status (MSatsAPI Event AT41) event to the CoreLogic periodically to get the current status the order from CoreLogic. 11. If either the CoreLogic or MSats needs to cancel the order at any time, Order Cancelled (MSatsAPI Event AT07) should be sent on the order to be cancelled. 12. The MSats and/or CoreLogic sends this Add Document (MSatsAPI Event AT16) event to MSats and/or CoreLogic to share the Documents for the order.
Event XMLs
*Mandatory R - Required Fields that will occur on all Orders. O - Optional Fields that they may or may not occur on an Order. D - Dependent Fields that will occur based on the Partner requirement.
AT01 - PlaceOrder:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT01 |
EventName | R | Name of the event. Eg: PlaceOrder |
Transaction | ||
OrderNumber | R | Order number of the provider |
LoanNumber | R | Loan number of the order |
ProductName | R | Name of the product for which order requested. ie) Lien Release/ Assignment |
PaidInFullDate | D | Date of loan amount paid (yyyy-mm-dd) |
OriginalLoanDate | D | Actual loan date (yyyy-mm-dd) |
OriginalLoanBalance | D | Actual loan amount pending |
BorrowerPaidFee | D | Borrower paid amount |
Comment | O | Comments |
Transaction > Property | ||
Addr1 | R | Property address |
Addr2 | R | Property address |
City | R | Property city |
State | R | Property state code |
Zip | R | Property zipcode |
Transaction > BorrowerList | ||
Count | D | No. of borrowers |
Transaction > BorrowerList > Borrower | ||
Name | D | Borrower name |
D | Borrower email id | |
Transaction > BorrowerList > CoBorrower | ||
Name | D | Co-Borrower name |
D | Co-Borrower email id | |
Transaction > DocumentList | ||
Count | R | No. of documents attached |
Transaction > DocumentList > Document | ||
FileName | R | File name |
FileType | R | Document type. Eg: PDF |
Content | R | Encoded content of the file |
EncodeType | R | Encoded format. Eg: Base64 |
AT02 - Accept Order:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT02 |
EventName | R | Name of the event. Eg: AcceptOrder |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | R | Partner Unique Order Number |
Comment | O | Comments |
AT03 - Reject Order:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT03 |
EventName | R | Name of the event. Eg: RejectOrder |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | R | Partner Unique Order Number |
Comment | O | Comments |
AT04 - Product Delivery:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT04 |
EventName | R | Name of the event. Eg: ProductDelivery |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | R | Partner Unique Order Number |
Comment | O | Comments |
Transaction > ProductData | ||
PropertyAddress1 | R | Property address |
PropertyAddress2 | R | Property address |
PropertyCityName | R | Property located city |
PropertyStateName | R | State code |
PropertyCountyName | R | County |
PropertyZipCode | R | Zipcode |
BorrowerNameFirst | D | Borrower first name |
BorrowerNameMiddle | D | Borrower middle name |
BorrowerNameLast | D | Borrower last name |
NoteDate | D | Date (yyyy-mm-dd) |
LoanAmount | D | Loan amount |
MaturityDate | D | Date (yyyy-mm-dd) |
MERSDescription | D | MERS Description |
ReturnToOrg | D | Return Organization |
ReturnAddress1 | D | Address line 1 |
ReturnAddress2 | D | Address line 2 |
ReturnCityName | D | City |
ReturnStateCode | D | State code |
ReturnZipCode | D | Zip code |
TaxID | D | Tax ID |
MERSPhoneNo | D | Phone |
AssignorName | D | Assignor name |
MortgageDated | D | Mortgage Date |
DocumentNumber | D | Document Number |
Trustee | D | Trustee |
MIN | D | MIN number |
LenderName | D | Lender Name |
LenderAddress | D | Lender Address |
RecordedDate | D | Recorded Date |
LegalDescription | D | Legal description |
NotaryDateOfExpiration | D | Date |
Notary | D | Notary Name |
NotaryAck | D | Notary ACK Description |
NotaryStateName | D | State |
NotaryCountyName | D | County |
SignorTitle | D | Signor Title Information |
Signor | D | Signor Name |
EndorserName | D | Endorser Name |
AssignorAddress1 | D | Assignor Address1 |
AssignorAddress2 | D | Assignor Address2 |
AssignorCityName | D | Assignor city |
AssignorStateName | D | Assignor state |
AssignorZipCode | D | Assignor Zipcode |
AssigneeName | D | Assignee Name |
AssigneeAddress1 | D | Assignee Address1 |
AssigneeAddress2 | D | Assignee Address2 |
AssigneeCityName | D | Assignee city |
AssigneeStateName | D | Assignee state |
AssigneeZipCode | D | Assignee Zipcode |
BorrowerName | D | Borrower Name |
Book | D | Book |
Page | D | Page |
PropertyStateName | D | State code |
Instrument | D | Instrument |
PrintDate | D | Print Date (yyyy-mm-dd) |
Witness1 | D | Witness Name1 |
Witness2 | D | Witness Name2 |
DeedOfTrustDated | D | Deed of Trust Dated (yyyy-mm-dd) |
SecurityDeedDate | D | Security Deed Date (yyyy-mm-dd) |
LoanNumber | D | Loan number |
SIS | D | SIS |
Mortgagor | D | Mortgagor Name |
Mortgagee | D | Mortgagee Name |
DatedDate | D | Dated Date (yyyy-mm-dd) |
ExecutedDate | D | Executed Date (yyyy-mm-dd) |
OwnerName | D | Owner name |
Designation | D | Designation |
ReturnPhoneNo | D | Phone number |
MERSMailingAddress | D | MERS Mailing Address |
PreparedBy | D | The person who prepared the document |
PreparedByOrg | D | The organization who prepared the document |
PreparedByAddress1 | D | Address line1 |
PreparedByAddress2 | D | Address line2 |
PreparedByCityName | D | City name |
PreparedByStateCode | D | State |
PreparedZipCode | D | Zipcode |
PreparedByPhoneNo | D | Phone number |
Transaction > DocumentList | ||
Count | R | No. of documents attached |
Transaction > DocumentList > Document | ||
FileName | R | File name |
FileType | R | Document type. Eg: PDF |
Content | R | Encoded content of the file |
EncodeType | R | Encoded format. Eg: Base64 |
AT05 -Add Notes:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT05 |
EventName | R | Name of the event. Eg: AddNotes |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | R | Partner Unique Order Number |
Comment | O | Comments |
AT06 - Hold Order:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT06 |
EventName | R | Name of the event. Eg: OnHoldOrder |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | R | Partner Unique Order Number |
Comment | O | Comments |
AT07 - Cancel Order:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT07 |
EventName | R | Name of the event. Eg: CancelOrder |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | R | Partner Unique Order Number |
Comment | O | Comments |
AT08 - Resume Order:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT08 |
EventName | R | Name of the event. Eg: ResumeOrder |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | R | Partner Unique Order Number |
Comment | O | Comments |
AT10 - Complete Order:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT10 |
EventName | R | Name of the event. Eg: CompleteOrder |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | R | Partner Unique Order Number |
Comment | O | Comments |
AT16 - Add Document:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT10 |
EventName | R | Name of the event. Eg: CompleteOrder |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | R | Partner Unique Order Number |
Comment | O | Comments |
Transaction > Documents > DocumentType | ||
Name | R | Name of the Document Type |
Transaction > Documents > DocumentType > Docs > Doc | ||
FileName | R | File Name |
FileSource | R | File Source Eg : S3 |
FileType | R | Document Type Eg : PDF |
FilePath | R | File Path .Eg : Path/Filename1.pdf |
FileDPI | O | File DPI Eg : 300 |
AT40 - OrderStatus:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT40 |
EventName | R | Name of the event. Eg: OrderStatus |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | R | Partner Unique Order Number |
Comment | O | Comments |
AT41 - GetStatus:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: AT41 |
EventName | R | Name of the event. Eg: GetStatus |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | R | Partner Unique Order Number |
Comment | O | Comments |
Acknowledgement Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: ACK |
EventName | R | Name of the event. Eg: Acknowledgement |
Transaction | ||
OrderNumber | R | Order number of the provider |
ProviderOrderNbr | O | Corelogic Unique Order Number |
Negative Acknowledgement Sample:
Field Name | R/O | Description |
---|---|---|
Header | ||
Created | R | Request created date time (2021-06-10T14:18:42+00:00 (W3C)) |
SourceApp | R | Name of application |
SourceVer | R | Application version |
SourceEnv | R | Source application environment. Eg: UAT/DEV/PROD |
PartnerID | R | Partner Identification – it is mandatory to process the request |
EventCode | R | Requested Event Code. Eg: NACK |
EventName | R | Name of the event. Eg: Negative Acknowledgement |
Transaction | ||
ProviderOrderNbr | R | Partner Unique Order Number |
Transaction > Errors | ||
ErrorCode | R | Error Code |
ErrorType | R | Type of error received |
Description | R | Describes about the error |