V3 Pull Loan Field Audit Data

post

https://api.elliemae.com/encompass/v3/loans/{loanId}/auditTrail

Pulls field audit data from the Encompass Reporting Database.

Path Params

loanId

string

required

The unique identifier assigned to the loan.

Query Params

includeHistoricalData

boolean

Defaults to false

Indicates whether to bring all historical updates to a field versus only the latest update. Default is false.

ignoreInvalidFields

boolean

Defaults to false

Indicates whether to ignore the invalid field ids. If the query parameter is set as false, then the API will fail with error when the request contains the invalid field Ids. Default is false.

start

string

0 based index of the starting record.

limit

string

Maximum number of records to return in the response. Maximum limit is 1000.

Body Params

Supported attribute is “fieldIds”. Value is an array of loan field ids, separated by commas. This is the list of loan field ids from which to retrieve the audit data.

Headers

Authorization

string

required

Bearer token

Responses

400

Bad Request

403

Forbidden

404

Not Found

200OK