Skip to content
BookendBookend Docs

Approve a staged wire

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

Checker step. Requires a signed-in admin or boarding_checker who did not stage the wire (the stager gets 403). 404 when the loan is unknown or no wire has been staged, 409 when the wire is not in the staged state.

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
object
id
required
string format: uuid
loanId
required
string format: uuid
loanRef
required
string
amount
required
string
currency
required
string
fields
required
Array<object>

One wire field with the provenance it was populated from.

object
name
required
string
value
required
string
source
required
string
documentId
required
null | string format: uuid
pageNo
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
state
required
string
stagedBy
required
string format: uuid
stagedAt
required
string format: date-time
approvedBy
required
null | string format: uuid
approvedAt
required
null | string format: date-time
exportedAt
required
null | string format: date-time
exportTarget
required
null | string
requiredApprovalRole
required
string
Examplegenerated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "loanId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "loanRef": "example",
  "amount": "example",
  "currency": "example",
  "fields": [
    {
      "name": "example",
      "value": "example",
      "source": "example",
      "documentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "pageNo": 1
    }
  ],
  "state": "example",
  "stagedBy": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "stagedAt": "2026-04-15T12:00:00Z",
  "approvedBy": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "approvedAt": "2026-04-15T12:00:00Z",
  "exportedAt": "2026-04-15T12:00:00Z",
  "exportTarget": "example",
  "requiredApprovalRole": "example"
}