This migration streamlines client endpoints, query parameters, and response structures for greater consistency and extensibility.

​
Client Screening and Monitoring — Response Structure

For the following endpoints: the response payload has been updated as follows:

​
Creation status

The client creation result is now represented by the creationStatus enum. The boolean field created is still returned for backward compatibility but is deprecated and will be removed in a future release.

​
Response wrapping

The created entity is now returned under the data property. For client creation, the client property is still included for compatibility but is deprecated and will be removed soon.

​
Query Parameter — withMatches

The withMatches query parameter is now available on all single-client (non-bulk) operations — retrieval, creation, or update. When set to true, the response will include two additional fields on the client object:
  • localMatches
  • publicMatches
The withMatches parameter is supported on the following endpoints:

​
Parameter Deprecation — allowAutoOnboarding

The allowAutoOnboarding parameter is deprecated and will be removed in a future release. For backward compatibility, it is temporarily supported in the request body along with the query parameters. Clients relying on this parameter should migrate to the new behavior as soon as possible.

​
What you need to know

  • Still supported (temporarily)
  • Will be fully removed in a future version which might be a breaking change if you don’t update
  • You should have recieved emails or slack messages to notify you with the changes

​
Required Action

Remove allowAutoOnboarding from body and include it in the query parameter during the transition period.