External metadata¶

externalMetadata is an application-defined string that is written into the generated payload metadata. Use it to correlate a payload with an application session, transaction, request ID, capture step, or other server-side context.

val payloadOptions = PayloadOptions.createPayloadOptions(
    payloadSize = DocumentIadOptions.PayloadSize.Small,
    externalMetadata = "transaction-id-123"
)

cameraController.setPayloadOptions(payloadOptions)
cameraController.takePhoto()

Change metadata between captures¶

externalMetadata is part of PayloadOptions. To attach different metadata to different payloads, create new payload options and set them before each capture.

val frontSidePayloadOptions = PayloadOptions.createPayloadOptions(
    payloadSize = DocumentIadOptions.PayloadSize.Small,
    externalMetadata = "70e5533a-b6e9-4632-b52a-7a7280b62311"
)

cameraController.setPayloadOptions(frontSidePayloadOptions)
cameraController.takePhoto()

val backSidePayloadOptions = PayloadOptions.createPayloadOptions(
    payloadSize = DocumentIadOptions.PayloadSize.Small,
    externalMetadata = "0cee025a-99e9-4a5b-be92-d7c4e59c4e2e"
)

cameraController.setPayloadOptions(backSidePayloadOptions)
cameraController.takePhoto()