Delete a dedupe configuration

DELETE

/party-dedupe-criteria-configuration

Dedupe configuration

Deduplication is based on specific criteria defined in the dedupe policy. Each policy is a dedupe configuration. You can delete a dedupe configuration using this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://dev.your-api-server.com/party-dedupe-criteria-configuration' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

200 - Example 1

{}

Request

Body Params application/json

criteriaId

string

optional

This is a unique identifier of the deduplication criteria.

Example:

37ed6422-68ac-44bd-9ab9-75c9ced5a202

status

enum<string>

optional

This indicates the current operational status of the entity. For example ACTIVE or CLOSED.

Allowed values:

ACTIVECLOSED

version

integer <int64>

optional

This represents the version number of the dedupe configuration.

Example:

createdOn

string <date-time>

optional

This indicates the creation timestamp of the dedupe criteria.

Example:

2024-08-24T14:15:22.123Z

createdBy

string

optional

This indicates the name of the user who created the dedupe criteria.

Example:

system

updatedOn

string <date-time>

optional

This indicates the timestamp when the dedupe criteria were last modified.

Example:

2024-10-18T14:15:22.123Z

updatedBy

string

optional

This indicates the name of the user who last updated the dedupe criteria.

Example:

system

dirty

boolean

write-onlyoptional

This represents an evident "update" operation. It is meant for internal use only.

deleted

boolean

write-onlyoptional

This represents an evident "delete" operation. It is meant for internal use only.

jsonContent

required

Json content of an Entity

One of

IndividualPartyDedupeCriteriaMetadataDTO

NonIndividualPartyDedupeCriteriaMetadataDTO

extensionFields

object

optional

This holds additional information about the party.

partyType

enum<string>

optional

This indicates the type of party. It could be INDIVIDUAL or NON INDIVIDUAL.

Allowed values:

INDIVIDUALNON_INDIVIDUAL

partySearchPolicyType

enum<string>

optional

This indicates the policy used to search for duplicate records. It could be CONFIRMED or POTENTIAL. CONFIRMED indicates that the system validates the incoming request against the Confirmed match criteria to find a confirmed match. POTENTIAL indicates that the system first validates the incoming request against the Confirmed criteria. When no result is found, it validates the incoming request against the Potential match criteria to find a potential match.

Allowed values:

CONFIRMEDPOTENTIAL

criteriaName

string

optional

This indicates the name of the criterion/criteria used for dedupe check.

>= 0 characters<= 180 characters

Example:

PAN

attributes

array[string]

optional

This holds the list of search attributes. For example "panNumberIndividual."

Examples

Responses

🟢200OK

application/json

Body

object {0}

🟠400Bad Request

Modified at 2025-02-17 09:40:52

Update a dedupe configuration

Modify a dedupe configuration