Skip to main content

Screening – Added

Affected Endpoints​

New field OtherInformation added to the SecondaryIdentifiers of a Screening Provider's Configuration.

  • POST /api/configuration
  • POST /api/configuration/provider
  • PATCH /api/configuration/provider/\{providerId\}
  • GET /api/configuration
  • GET /api/configuration/provider/\{providerId\}

New field OtherInformation added to the Screening Entity Search Criteria.

  • POST /api/batch
  • POST /api/entity
  • PUT /api/entity/\{entityId\}
  • GET /api/batch/\{id\}
  • GET /api/batch/journey/\{journeyId\}
  • GET /api/batch/journey/\{journeyId\}/process/\{processId\}
  • GET /api/batch/\{batchId\}/entity
  • GET /api/batch/\{batchId\}/entity/\{entityId\}
  • GET /api/entity/\{entityId\}
  • POST /api/entity/getentitieslist

Screening – Updated

When calling the create batch endpoint, if the new batch is overriding any previous batches for the journey, it will now send the AdditionalSettings as part of each of the overridden batches to the adapters. Also updated the LexisNexis adapter Screen endpoint to use these AdditionalSettings for the AcceptList deletion, so entities are removed from the correct AcceptLists of the overridden batches.

Screening – Updated

When calling the create batch endpoint, if the new batch is in the same journey as another existing batch with resolved matches, the match resolution of the repeated matches will be reused. More details can be found on the Reopening Screening Processes and Screening Resolution Reuse section of the Screening User Guide. Note that this new feature does not apply for WCO matches as the described behavior is inherently supported natively.

Screening – Added

Added a new boolean field called CommentsMandatory to the Screening Configuration, set to true by default. Added a new endpoint called PatchConfiguration to the Screening Command API, which enables updating the value of the new CommentsMandatory field. Note that PatchConfiguration currently supports updating only this one field. To update other fields within a Screening Configuration, please refer to the other endpoints in this API.

Policy – Changed

Changed the endpoint GetRequirementSetVersionLightById to include IdvName and UBOThreshold properties as part of requirements in the response