FYNDNA retail banking suite
  1. Dedupe configuration
FYNDNA retail banking suite
  • Party deduplication
    • Dedupe configuration
      • Create dedupe configuration
        POST
      • Retrieve all dedupe configurations
        GET
      • Update a dedupe configuration
        PUT
      • Delete a dedupe configuration
        DELETE
      • Modify a dedupe configuration
        POST
      • Update a specific criterion in a dedupe configuration
        PATCH
      • Retrieve a specific dedupe configuration
        GET
      • Delete a specific dedupe configuration
        DELETE
      • Retrieve the dedupe configuration for a party type
        GET
    • Dedupe execution
      • Initiate synchronous dedupe
      • Initiate asynchronous dedupe
    • Dedupe results
      • Retrieve dedupe results
  1. Dedupe configuration

Create dedupe configuration

POST
/party-dedupe-criteria-configuration
Dedupe configuration
Deduplication is based on specific criteria defined in the dedupe configuration. You can define a dedupe configuration using this endpoint.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://dev.your-api-server.com/party-dedupe-criteria-configuration' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "criteriaId": "37ed6422-68ac-44bd-9ab9-75c9ced5a202",
        "status": "CLOSED",
        "version": 0,
        "createdOn": "2024-08-24T14:15:22.123Z",
        "createdBy": "system",
        "updatedOn": "2024-10-18T14:15:22.123Z",
        "updatedBy": "system",
        "dirty": false,
        "deleted": false,
        "jsonContent": {
            "extensionFields": {},
            "partyType": "INDIVIDUAL",
            "partySearchPolicyType": "POTENTIAL",
            "criteriaName": "PAN",
            "attributes": [
                "panNumberIndividual",
                "panNumberIndividual"
            ]
        }
    }
]'
Response Response Example
200 - Success
[
  {
    "criteriaId": "37ed6422-68ac-44bd-9ab9-75c9ced5a202",
    "status": "CLOSED",
    "version": 0,
    "createdOn": "2024-08-24T14:15:22.123Z",
    "createdBy": "system",
    "updatedOn": "2024-10-18T14:15:22.123Z",
    "updatedBy": "system",
    "dirty": false,
    "deleted": false,
    "jsonContent": {
      "extensionFields": {},
      "partyType": "INDIVIDUAL",
      "partySearchPolicyType": "CONFIRMED",
      "criteriaName": "PAN",
      "attributes": [
        "panNumberIndividual",
        "panNumberIndividual"
      ]
    }
  },
  {
    "criteriaId": "37ed6422-68ac-44bd-9ab9-75c9ced5a202",
    "status": "CLOSED",
    "version": 0,
    "createdOn": "2024-08-24T14:15:22.123Z",
    "createdBy": "system",
    "updatedOn": "2024-10-18T14:15:22.123Z",
    "updatedBy": "system",
    "dirty": true,
    "deleted": false,
    "jsonContent": {
      "extensionFields": {},
      "partyType": "INDIVIDUAL",
      "partySearchPolicyType": "CONFIRMED",
      "criteriaName": "PAN",
      "attributes": [
        "panNumberIndividual"
      ]
    }
  }
]

Request

Body Params application/json
array of:
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:
0
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
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
*/*
OK
Body
array of:
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:
0
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
jsonContent
required
Json content of an Entity
One of
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."
🟠400Bad Request
Modified at 2025-03-05 11:02:20
Previous
Dedupe configuration
Next
Retrieve all dedupe configurations
Built with