v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

Book Queries

Book from loan

This API endpoint lets you retrieve the Ocrolus <glossary:Book> associated with a specific Encompass loan. You can query it using either the Encompass loan_id (GUID) or the loan_number, depending on which identifier you have available.

📘 Note: The system accepts either loan_id or loan_number to identify the loan. If both parameters are provided, or if neither is included in the request payload, the API returns a 400 error.

get/v2/los-connect/encompass/book

Query parameters

loan_idstring

The unique Encompass loan identifier expressed in Globally Unique Identifier (GUID) format.

loan_numberstring

The numeric identifier assigned to an Encompass loan.

Response

Success

statusinteger

A numerical code that indicates the status of the request.

Example response

{
  "status": 200,
  "response": {
    "loan_number": "TEST250918342",
    "loan_guid": "c3f7e84d-8a91-4b1c-9460-192a746ad3c9",
    "client_instance_id": "DEMO99887766",
    "client_name": "Encompass QA Sandbox",
    "book_details": {
      "book_pk": 472391,
      "name": "Encompass QA Sandbox-c3f7e84d-8a91-4b1c-9460-192a746ad3c9-521",
      "book_status": "ACTIVE",
      "created_ts": "2025-02-12T15:23:47.382194"
    },
    "message": "OK"
  }
}