Download Postman Collection
API Reference

Flood Partners and Samples

Use the Services API to submit Flood Service requests and retrieve Flood reports/certificates from Flood Service partners.

This page contains the common product attributes used by Flood Service partners, as well as attributes and samples that are specific to each partner.

Product Attributes

The attributes listed in the table below are required by all Flood Service partners unless otherwise specified.

ATTRIBUTEDESCRIPTION
entityRef
object		References the entity ID and entity type. Since this is a loan level service, we do not need to reference a specific borrower pair in our service request. Both entity ID and entity type are returned by getLoan.
entityRef.entityId
string		The entity identifier. For example, the loan ID:
{loanId}
entityRef.entityType
string		The type of entity expressed in URN format. For example:
urn:elli:encompass:{loanId}
name
string		Name of the service to order. See the Partner Information section to get the correct name value for the partner; either the Transaction_Resource object or Transaction object name.
credentials
object		Object that encapsulates credentials and/or verification information with the Flood service provider.
credentialStore
string

Optional
Indicates that the API user will use credentials stored in the Encompass Services Password Manager at a user-level. Currently, user is the only supported value.

Note: The credentials object and the credentialStore attribute can not be passed simultaneously in a request - they are mutually exclusive.
options
object		Important! The parameters defined by the options object may be different depending on the service provider you choose.

To view options attributes and samples for ServiceLink Flood, see [ServiceLink Flood Product Attributes](ref:flood-partners-and-samples#servicelink-flood product).

To view options attributes and samples for CoreLogic Flood Service, see CoreLogic Flood Product Attributes.
resources
object


Optional. This object contains the resources (documents and attachments) associated with the loan that are being shared with the service partner with respect to the service request. You may send documents and attachments if necessary.
resources.entityId
string

Optional. The entity identifier for the resource.

If the resource you are passing is an eFolder attachment, the attachmentId is required.

If the resource you are passing is an eFolder document, the documentId is required.

You can retrieve these from using the eFolder Attachment and eFolder Document APIs.
resources.entityType
string		Optional. The entity type/format of the resource. Possible values include:

For an Encompass eFolder attachment:
urn:elli:encompass:attachment

 For and Encompass eFolder document:
urn:elli:encompass:document

Partner Information

Use the Product Name listed under the Transaction_Resource or Transaction columns to create transactions that follow the respective schema.

Partner NamePartner IDProduct Name - Transaction_ResourceProduct Name - Transaction
ServiceLink10000176Flood-ServiceLink Flood
CoreLogic Flood Service274365Flood-CoreLogic Flood

ServiceLink Flood Service

Product Attributes

The following section lists the request attributes used by the ServiceLink Flood service.

ATTRIBUTEDESCRIPTION
credentials.accountId
string		This is the account identifier assigned by ServiceLink to authenticate your organization and track service requests. To retrieve your account ID, contact ServiceLink.
options
object		Service options for placing a Flood service request with ServiceLink.
options.requestType
string		The type of Flood service request being placed. Possible values are:

newRequest: A request for a new Flood certification for the subject property
 retrieve: A request to retrieve a previously issued Flood certification for the subject property
cancel: Cancel a previously issued Flood certification for the subject property
 upgrade: Upgrade a previously issued Basic Flood certification to a Life of Loan Flood Certification
transfer: Transfer the Flood certification to another servicer
 change: Make changes to a previously issued Basic Flood certificate
2ndMortgage: Reissue a Flood certificate for a 2nd mortgage on the subject property
 refinance: Reissue a Flood certificate when refinancing an existing mortgage on the subject property
options.productDetails
object		The product details object contains information about the Flood product to order.
options.productDetails.name
string		The name of the flood product being ordered.
Available products are:

Basic Determination
 Basic Determination w/ HMDA Information
Life of Loan Determination
 Life of Loan Determination w/ HMDA Information
Life of Loan Upgrade
 2nd Mortgage
* Refinance
options.productDetails.id
string		ServiceLink product identifier for the specific Flood product being requested.
Product identifiers corresponding to each Flood product are:

25: Basic Determination
 40: Basic Determination w/ HMDA Information
26: Life of Loan Determination
 41: Life of Loan Determination w/ HMDA Information
129: Life of Loan Upgrade
 206: 2nd Mortgage
* 205: Refinance
options.newServicerAccountId
string		Conditionally Required. The ServiceLink Account identifier for the servicer to whom the Flood certification is being transfered to.

Required when requestType is Transfer.
options.referenceTransactionId
string		Conditionally Required. Reference to a previously placed service request. Conditionally required for the following request types:

retrieve
 cancel
upgrade
 transfer
change
 2ndMortgage
* refinance

Sample API Workflow

Step 1: Place a new ServiceLink Flood service request.

{  
  "product":{  
    "entityRef":{  
      "entityId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "entityType":"urn:elli:encompass:loan"
    },
    "credentials":{  
      "accountId":"xxxxxxxxxx"
    },
    "name":"Flood-ServiceLink",
    "options":{  
      "requestType":"newRequest",
      "productDetails":{  
        "name":"Basic Determination",
        "id":"25"
      },
    }
  }
}

{  
  "product":{  
    "entityRef":{  
      "entityId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "entityType":"urn:elli:encompass:loan"
    },
    "credentials":{  
      "accountId":"xxxxxxxxxx"
    },
    "name":"FLOOD",
    "options":{  
      "requestType":"newRequest",
      "productDetails":{  
        "name":"Basic Determination",
        "id":"25"
      },
    }
  }
}

Step 2: Retrieve details of a completed ServiceLink Flood Service request.

{  
  "status":"success",
  "documents":{  
    "id":"",
    "name":"",
    "resources":[  
      {
        "id": "Attachment-e500acfb-fb7e-467c-b964-9c49e6f63027.pdf",
        "name": "Attachment-e500acfb-fb7e-467c-b964-9c49e6f63027",
        "mimeType": "application/pdf"
      }
    ]
  },
  "product":{  
    "partnerID":"10000176",
    "productName":"Flood-ServiceLink",
    "displayName":"",
    "category":"Flood",
    "entityRef":{  
      "entityId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "entityType":"urn:elli:encompass:loan"
    }
  }
}

{  
  "status":"success",
  "documents":{  
    "id":"",
    "name":"",
    "attachments":[  
      {  
        "mimeType":"emmedia/pdf",
        "name":"Attachment-e500acfb-fb7e-467c-b964-9c49e6f63027",
        "content":{  
          "createdDateTime":"2018-03-09T12:01:53.5306708-08:00",
          "attachmentFile":"Attachment-e500acfb-fb7e-467c-b964-9c49e6f63027.pdf"
        }
      }
    ]
  },
  "product":{  
    "partnerID":"10000176",
    "productName":"FLOOD",
    "displayName":"",
    "category":"Flood",
    "entityRef":{  
      "entityId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "entityType":"urn:elli:encompass:loan"
    }
  }
}

CoreLogic Flood Service

Product Attributes

The following section lists the request attributes used by the CoreLogic Flood Service.

ATTRIBUTEDESCRIPTION
credentials
object		Login credentials for the CoreLogic.

Note: You must have an account with CoreLogic. You'll use the same account credentials required by CoreLogic to order Flood services.
credentials.userName
string		Username for the CoreLogic account.
credentials.password
string		Password for the CoreLogic account.
options
object		Service options for placing a Flood service request with CoreLogic.
options.requestType
string		The type of Flood service request being placed. Possible values are:

newRequest: A request for a new Flood certification for the subject property
 retrieveReport: A request to retrieve a previously issued Flood certification for the subject property
cancelRequest: Cancel a previously issued Flood certification for the subject property
 requestUpdate: Update a previously issued Flood certification
options.productName
string		Name of the Flood product being requested. Possible values are:

Basic Flood Certification
 Basic with Census Data
Life of Loan Flood Determination
 Life of Loan with Census Tract
Life of Loan Related Loan
 Life of Loan Related Loan with Census Data
Life of Loan Special Property
 Life of Loan Special Property with Census

For example, Basic Flood Certification.
options.productIdentifier
string		Product code corresponding to the Flood product being requested. Possible values are:

F: Basic Flood Certification
 FC: Basic with Census Data
FL: Life of Loan Flood Determination
 FLC: Life of Loan with Census Tract
FLR: Life of Loan Related Loan
 FLCR: Life of Loan Related Loan with Census Data
FLO: Life of Loan Special Property
 FLCO: Life of Loan Special Property with Census

For example, F.
options.referenceTransactionId
string		Conditionally Required. Reference to a previously placed service request. Conditionally required for the following request types:

retrieveReport
 requestUpdate
* cancelRequest

Sample API Workflow

Step 1: Place a new CoreLogic Flood Service request.

{
  "product": {
    "entityRef": {
      "entityId": " 5b3b305f-c2b5-4592-ae24-3cbb1ae4d6f9",
      "entityType": "urn:elli:encompass:loan"
    },
    "name": "Flood-CoreLogic",
    "options": {
      "requestType": "newRequest",
      "productName":"Basic Flood Certification",
      "productIdentifier": "F"
    },
    "credentials": {
      "userName": "username",
      "password": "password"
    }
  }
}

{
  "product": {
    "entityRef": {
      "entityId": " 5b3b305f-c2b5-4592-ae24-3cbb1ae4d6f9",
      "entityType": "urn:elli:encompass:loan"
    },
    "name": "FLOOD",
    "options": {
      "requestType": "newRequest",
      "productName":"Basic Flood Certification",
      "productIdentifier": "F"
    },
    "credentials": {
      "userName": "username",
      "password": "password"
    }
  }
}

Step 2: Retrieve details of the completed CoreLogic Flood service request.

{
  "status": "success",
  "resources": [
    {
      "id": "Attachment-5ae32766-ca69-4c1b-81a4-ca092f15b26b.pdf",
      "name": "Attachment-5ae32766-ca69-4c1b-81a4-ca092f15b26b",
      "mimeType": "application/pdf"
    },
    {
      "id": "pResponse-int_294b8851-c97b-461b-8e09-5fc4b2e9937b_3b58VQ9.xml",
      "name": "NativePartnerResponse",
      "mimeType": "application/vnd.mismo-2.4+xml;charset=ISO-8859-1"
    }
  ],
  "product": {
    "partnerID": "10000071",
    "productName": "FLOOD",
    "displayName": "",
    "category": "FLOOD",
    "entityRef": {
      "entityId": "5b3b305f-c2b5-4592-ae24-3cbb1ae4d6f9",
      "entityType": "urn:elli:encompass:loan"
    },
    "creationDate": "2018-07-09T17:13:19Z",
    "lastUpdatedDate": "2018-07-09T17:13:54Z",
    "orderedBy": "urn:elli:encompass:BE11200922:user:eppslouser_evp"
  }
}

{
  "status": "success",
  "documents":{  
    "id":"",
    "name":"",
    "attachments":[  
      {  
        "mimeType":"emmedia/pdf",
        "name":"Attachment-5ae32766-ca69-4c1b-81a4-ca092f15b26b",
        "content":{  
          "createdDateTime":"2018-03-09T12:01:53.5306708-08:00",
          "attachmentFile":"Attachment-5ae32766-ca69-4c1b-81a4-ca092f15b26b.pdf"
        }
      }
    ]
  },
  "product": {
    "partnerID": "10000071",
    "productName": "FLOOD",
    "displayName": "",
    "category": "FLOOD",
    "entityRef": {
      "entityId": "5b3b305f-c2b5-4592-ae24-3cbb1ae4d6f9",
      "entityType": "urn:elli:encompass:loan"
    },
    "creationDate": "2018-07-09T17:13:19Z",
    "lastUpdatedDate": "2018-07-09T17:13:54Z",
    "orderedBy": "urn:elli:encompass:BE11200922:user:eppslouser_evp"
  }
}
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use