Purpose
Back To HomeThis Client Integration Guide provides the information required for a successful implementation of receiving and returning stacked/indexed/audited Loan Packages and order status using the CLIENT API integration.
This document is created, maintained, and distributed by Avanze Tech Labs Inc. to communicate the implementation requirements to their vendors. Avanze supports the contents included in the Provider Implementation Guide when the document originates from Avanze.
Client ID
Client will be sending the order request and other respective events with the following ClientID’s. Client should confirm that all CLIENT ClientID’s are configured in their appropriate environment.
UAT Environment
Client ID | Client Name |
---|---|
XYZTEST123 | XYZ |
Production Environment
Will be share when we go live
Products
Client will be ordering the following products through CLIENT. This product listing contains all possible products that Avanze will deliver through the CLIENT platform. Customers should refer to their specific subscription agreement with Avanze and configure the products that are subscribed for this implementation
Product Name |
---|
Current Owner |
Update Search |
Search Type
Based on the search type client will be ordering through API. This search type listing contains two different search method that Avanze will deliver through the CLIENT platform.
Search Type |
---|
Address |
BookAndPage |
InstrumentNumber |
Connectivity Detail
HTTP Post
The HTTP Post Method may be implemented for the purpose of inbound event transmission. CLIENT can send files via HTTP and will receive a JSON Response informing them of the status of their submission. HTTP Posting can also be used as a delivery method for integration ABSTRACTNOW.
CLIENT 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 CLIENT to post inbound events to AVANZE API which will route the events to ABSTRACTNOW application.
UAT URL:
http://apistage.direct2title.com/Abstractnow/organization/integration
PRODUCTION URL:
Will be share when we go live
Authorization through POST Parameters
OAuth 2.0 for authentication and authorization. The first step is to direct the user to the authorization endpoint supplying the query parameters described below
https://stage.avanzeapi.com/oauth2/token?grant_type=client_credentials&client_id=[YOUR ID]&client_secret=[YOUR SECRET]&scope=[YOUR SCOPE]
Client ID | Abstractnow Admin |
---|---|
client_secret | @bstr@ctnow_@dmin |
scope | abstractnow |
The CLIENT sends a POST request with following body parameters to the authorization server:
- grant_type with the value client_credentials
- client_id with the client’s ID
- client_secret with the client’s secret
- scope with a space-delimited list of requested scope permissions.
The authorization server will respond with a JSON object containing the following properties:
- token_type with the value Bearer
- expires_in with an integer representing the TTL of the access token
- access_token is the 32 bit hash Bearer Token used for authentication.
The access token is active for 15 minutes, up to a maximum of 120 minutes (2 hours). To avoid expiration, the access token must be used (by calling an API) at least once every 15 minutes. Active minutes and expiration duration are configurable based on the CLIENT requirements.
API Events
Event Code | Event Name | Event Originator | CLIENT Sending | CLIENT Receiving | Event Definition |
---|---|---|---|---|---|
AT11 | PlaceOrder | CLIENT | R | CLIENT sends this event to initiate an order request to ABSTRACTNOW. | |
AT14 | ProductDelivery | ABSTRACTNOW | R | ABSTRACTNOW sends this event to CLIENT with the order documents with product data. | |
AT15 | AddNotes | Both | O | O | CLIENT and/or ABSTRACTNOW send this event to provide a note on an order request. |
AT30 | GetStatus | CLIENT | R | The Client sends this event to the ABSTRACTNOW to get the current status of the order. | |
AT31 | OrderStatus | ABSTRACTNOW | R | The ABSTRACTNOW sends this event to the CLIENT to notify the current status of the order. | AT50 | CompleteOrder | ABSTRACTNOW | R | The ABSTRACTNOW sends this event to the CLIENT to notify the CLIENT that the order request is complete. |
*Mandatory R - Required Events that will occur on all Orders. O - Optional Events that if they occur on an Order, ABSTRACTNOW is required to support.
CLIENT has documented the workflow process they require of their ABSTRACTNOWs which includes the ordering and completion of products.
Order Placement
1. CLIENT will create the Order Requests (CLIENT API Event AT11)
2. CLIENTAPI will route the orders to ABSTRACTNOW and return back the response to CLIENT with ACK.
Order Process
3. When the order is complete, ABSTRACTNOW will upload the documents using Document Delivered by ABSTRACTNOW with product data (CLIENTAPI Event AT14).
Completion of Order
4. Upon completion of the order, ABSTRACTNOW will send Order Completed (CLIENTAPI Event AT50) to the order to indicate the order is complete.
General Use Events
5. The Client sends this event to the ABSTRACTNOW to get the current status of the order (CLIENTAPI Event AT30) event.
6. The ABSTRACTNOW sends this event to the CLIENT to notify the current status of the order (CLIENTAPI Event AT31) event
Client API Workflow:
ABSTRACT NOW Client Integration Guide - XYZ
Header
Field Name
R/O
Description
Header
Created
R
Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp
R
Name of Source application
SourceVer
R
Application version
SourceEnv
R
Source application environment. Eg: UAT/DEV/PROD
ClientID
R
ClientID (mentioned under purpose section)
EventCode
R
Requested Event Code. Eg: AT11
EventName
R
Name of the event. Eg: PlaceOrder
CorrelationIdentifier
R
Unique number/Hash for the event
AT11 - Place Order:
Field Name
R/O
Description
Transaction
TransactionID
R
Order number of the client application
Comments
R
Comments
Priority
R
Priority of Transaction (HIGH, MEDIUM, LOW)
ParcelNumber
R
Parcel Number
SearchType
R
Search type for the transaction (Address/ BookAndPage/ InstrumentNumber)
ProductType
R
Product type of the transaction (Current Owner/ Update Search)
InstrumentNumber
R
Instrument Number
BookNumber
R
Book Number
PageNumber
R
Page Number
StartDate
R
Starting Date of the transaction (eg. MM/DD/YYYY)
Property
Address1
R
Property Address line 1
Address2
O
Property Address line 2
State
R
Property State Code
County
R
Property County
City
R
Property City
Zipcode
R
Property Zip Code
BorrowerList > Borrowers
FirstName
R
Borrower First Name
MiddleName
R
Borrower Middle Name
LastName
O
Borrower Last Name
IndividualStartDate
R
Individual Start Date (eg. MM/DD/YYYY)
CompanyList > Company
Name
R
Company Name
CompanyStartDate
R
Company Start Date (eg. MM/DD/YYYY)
AT14 - ProductDelivery:
Field Name
R/O
Description
Transaction
TransactionID
R
Order number of the client application
Comments
R
Comments
OrderNumber
R
Order number of the AbstractNow application
FileSource
R
Source of the file (e.g. S3,Link,Base64,SFTP)
FileType
R
Type of the file (e.g. PDF)
DocumentList > Document
FileName
R
Name of the file
FilePath
O
Path of the file
FileSize
R
Size of the file
AT50 - CompleteOrder:
Field Name
R/O
Description
Transaction
TransactionID
R
Order number of the client application
Comments
R
Comments
OrderNumber
R
Order number of the STACX application
AT30 - GetStatus
Field Name
R/O
Description
Transaction
TransactionID
R
Order number of the client application
Comments
R
Comments
OrderNumber
R
Order number of the AbstractNow application
AT30 Response
Field Name
R/O
Description
Transaction
TransactionID
R
Order number of the client application
OrderStatus
R
Current status of an order
OrderNumber
R
Order number of the AbstractNow application
AT31 – OrderStatus
Field Name
R/O
Description
Transaction
TransactionID
R
Order number of the client application
Comments
R
Comments
OrderNumber
R
Order number of the AbstractNow application
Status
R
Current status of an ordern
ACK-Acknowledgement
Field Name
R/O
Description
Header
Created
R
Request created date time (2021-06-10T14:18:42+00:00 (W3C))
SourceApp
R
Name of the application
SourceVer
R
Application version
SourceEnv
R
Source application environment. Eg: UAT/DEV/PROD
Status
R
ACK
Transaction
TransactionID
R
Order number of the sclient application
NACK-Negative Acknowledgement Response:
Field Name
R/O
Description
Header
Created
R
Request created date time (2021-06-10T14:18:42+00:00 (W3C)
SourceApp
R
Name of the application
SourceVer
R
Application version
SourceEnv
R
Source application environment. Eg: UAT/DEV/PROD
Status
R
NACK
Transaction
TransactionID
R
Order number of the client application
Errors
Type
R
Type of error received
Description
R
Describes about the error
Samples Download: