Acknowledge a board

Request

Record that the core boarded the loan. The loan leaves the boarding queue and the event is audited. Only a loan a banker released can be acknowledged — a loan that never reached the queue returns 400. Safe to repeat: a second call returns the boarding that already stands rather than overwriting it, so a retry after a lost response cannot rewrite when the core boarded the loan. Send coreRecordNumber to store the core’s own identifier for the loan on the Pioneer record.

Security

ApiKeyAuth

Path

idstringrequired

Idempotency-Keystring, <= 255 characters

Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect.

Bodyapplication/jsonrequired

coreRecordNumberstring, [ 1 .. 255 ] characters

curl -i -X POST \
  'https://api.pioneerft.com/api/public/v1/loans/{id}/boarding' \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -d '{
    "coreRecordNumber": "string"
  }'

Responses

Boarding recorded (or already recorded)

Bodyapplication/json

dataobject(PublicLoanBoarding)

Response

{
  "data": {
    "loanId": "string",
    "status": "string",
    "releasable": true,
    "released": true,
    "releasedAt": "string",
    "releasedBy": "string",
    "boarded": true,
    "boardedAt": "string",
    "coreRecordNumber": "string"
  }
}