Preview the boarding record

GET

/v1/loans/{ref}/boarding/preview

curl --request GET \
  --url http://localhost:8080/v1/loans/example/boarding/preview

Dry run: maps the loan’s extracted values through the active core field map of the configured core adapter and validates them, recording nothing. Returns each core field with its value and provenance plus the validation result; money values are decimal strings. Any staff role or an API key with status:read. 404 for an unknown loan, 422 when the provider has no active field map.

Parameters

Path Parameters

ref

required

string

Responses

200

OK

Media typeapplication/json

A dry run of the map over the loan’s values before anything is recorded (GET …/boarding/preview, field map editor preview).

object

loanRef

required

string

provider

required

string

fieldMapId

required

string format: uuid

fieldMapVersion

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

fields

required

Array<object>

One core field ready to post: code, wire value and where it came from. string? CoreFieldValue.Value is null when the map found no source.

object

coreField

required

string

canonical

required

string

transform

required

string

value

required

null | string

source

required

One of:

null

null

object

Where a boarded value came from ( “every core field + source provenance”).

object

documentId

required

string format: uuid

documentName

required

string

docType

required

string

canonical

required

string

pageNo

required

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

x

required

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

y

required

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

w

required

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

h

required

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

validation

required

object

ok

required

boolean

errors

required

Array<object>

object

coreField

required

string

message

required

string

Example^generated

{
  "loanRef": "example",
  "provider": "example",
  "fieldMapId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "fieldMapVersion": 1,
  "fields": [
    {
      "coreField": "example",
      "canonical": "example",
      "transform": "example",
      "value": "example",
      "source": {
        "documentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "documentName": "example",
        "docType": "example",
        "canonical": "example",
        "pageNo": 1,
        "x": 1,
        "y": 1,
        "w": 1,
        "h": 1
      }
    }
  ],
  "validation": {
    "ok": true,
    "errors": [
      {
        "coreField": "example",
        "message": "example"
      }
    ]
  }
}