V3 Get Loan

Returns the entire loan or specific entities of a loan.

Usage Notes

  • To retrieve UCD field mappings, refer to the Get UCD Fields API.
  • If you do not have permission to a requested field, the field will not be returned.
Path Params
string
required

The unique identifier assigned to the loan.

Query Params
string

Comma-separated list of loan entities to retrieve from the loan.

boolean

Specify true to include fields and objects that are empty.

boolean

Indicates to include records removed from entities.

string

Specify entity for core loan data, logs for log records, and full for both.
For more details, see About Loan Views.

Headers
string
required

Bearer token

Responses

400

Bad Request

403

Forbidden

404

Not Found

Language
URL
LoadingLoading…
Response
Choose an example:
application/json