Skip to content
BookendBookend Docs

Get a loan package

GET
/v1/loans/{ref}
curl --request GET \
  --url http://localhost:8080/v1/loans/example

Returns the latest package version for the loan reference, its documents and the list of package versions that exist. Any staff role or an API key with status:read. 404 for an unknown reference.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ref
required
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

GET /v1/loans/{ref}: the latest package version plus its documents and the versions that exist.

object
loan
required
object
id
required
string format: uuid
externalRef
required
string
packageVersion
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
borrowerName
required
string
expectedPrincipal
required
null | string
state
required
string
hasExceptions
required
boolean
assigneeId
required
null | string format: uuid
createdBy
required
null | string format: uuid
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
documents
required
Array<object>
object
id
required
string format: uuid
loanId
required
string format: uuid
docType
required
string
originalName
required
string
sha256
required
string
byteSize
required
integer | string format: int64
/^-?(?:0|[1-9]\d*)$/
pageCount
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
isScanned
required
null | boolean
isLar
required
boolean
larProfileId
required
null | string format: uuid
uploadedAt
required
string format: date-time
versions
required
Array<integer | string>
Examplegenerated
{
  "loan": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "externalRef": "example",
    "packageVersion": 1,
    "borrowerName": "example",
    "expectedPrincipal": "example",
    "state": "example",
    "hasExceptions": true,
    "assigneeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdBy": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdAt": "2026-04-15T12:00:00Z",
    "updatedAt": "2026-04-15T12:00:00Z"
  },
  "documents": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "loanId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "docType": "example",
      "originalName": "example",
      "sha256": "example",
      "byteSize": 1,
      "pageCount": 1,
      "isScanned": true,
      "isLar": true,
      "larProfileId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "uploadedAt": "2026-04-15T12:00:00Z"
    }
  ],
  "versions": [
    1
  ]
}