Skip to content

Upload the loan approval record

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

Accepts the LAR either as multipart/form-data (the file, in any supported LAR format) or as a raw JSON body in the canonical LAR format; it is parsed with the configured LAR profile and its fields recorded with provenance. Replacing the LAR while the loan is in review re-runs reconciliation. Admin, manager or specialist, or an API key with intake:write. 404 for an unknown reference, 409 unless the loan is in intake, processing or review, 400 for an empty body, 422 when the package would exceed documents.max_package_mb or the license has expired.

ref
required
string

OK

Media typeapplication/json
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
Examplegenerated
[
{
"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"
}
]