Documentation for a newer release is available. View Latest
Esta página no está disponible actualmente en Español. Si lo necesita, póngase en contacto con el servicio de asistencia de Icon (correo electrónico)

Processing Archive

For auditability, a processing archive notification is published to a kafka topic for each name match processed. This message can be used to determine the reason for a given result.

The requestId can be used to relate the processing archive to message logs to obtain a complete picture of processing for a particular Verification Of Payee Request

Messages sent to the processing archive topic will comply to the following schema:

{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Verification Of Payee Processing Archive",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "requestId" : {
      "type" : "string"
    },
    "requestPayeeName" : {
      "type" : "string"
    },
    "accountPayeeName" : {
      "type" : "string"
    },
    "matchedName" : {
      "type" : "string"
    },
    "accountType" : {
      "type" : "string"
    },
    "nameType" : {
      "type" : "string"
    },
    "matchCode" : {
      "type" : "string",
      "enum" : [ "MTCH", "NMTC", "CMTC", "NOAP" ]
    },
    "matchScore" : {
      "type" : "number"
    },
    "matchThresholdForRequest" : {
      "type" : "number"
    },
    "noMatchThresholdForRequest" : {
      "type" : "number"
    }
  }
}

Configuration

Property Default Description

ipf.verification-of-payee.responder.processing-archive.kafka.producer.topic

PROCESSING_ARCHIVE

The kafka topic where processing archive messages are published

ipf.verification-of-payee.responder.processing-archive.kafka.producer.health-check-settings.enabled

false

By default, processing archive messages are published on a best effort basis.
If health checks are enabled for the associated send connector, then the actuator health status will go to OUT_OF_SERVICE which may affect liveness/readiness probes

ipf.verification-of-payee.responder.processing-archive.send-connector.resiliency-settings.attempt-timeout

5s

How long to wait for a single attempt to complete before failing it

ipf.verification-of-payee.responder.processing-archive.producer.behaviour

FIRE_AND_FORGET

By default, processing archive messages are published on a best effort basis.

Valid values:

  • FIRE_AND_FORGET - Ignore errors encountered attempting to publish processing archive messages. Such errors will not affect the service responses returned - errors will still be logged

  • FAIL_ON_ERROR - If processing archive message publication fails, the service will not return responses.