Initiate synchronous dedupe

POST

/party-dedupe

Dedupe execution

A synchronous deduplication (dedupe) call refers to a process where the system performs a real-time duplicate check during customer creation or existing customer's data update. The system waits for the deduplication result before proceeding. In this type of operation, the deduplication process is integrated into the party onboarding or party update workflow. You can initiate a synchronous dedupe call using this endpoint. The request body consists of party details received from the external system. The system validates the details in this request against the party data existing in the FYNDNA system.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
  "dedupeResultId": "535164202",
  "status": "ACTIVE",
  "version": 1,
  "createdOn": "2024-08-24T14:15:22.123Z",
  "createdBy": "system",
  "updatedOn": "2024-10-24T14:15:22.123Z",
  "updatedBy": "system",
  "jsonContent": {
    "extensionFields": {},
    "searchPolicyType": "CONFIRMED",
    "dedupeStatus": "NOT_STARTED",
    "matchedParties": [
      {
        "partyId": "71048919203474",
        "matchedPartyCriteria": [
          {
            "matchedAttributes": {
              "partyId": "71048919203474",
              "status": "ACTIVE",
              "version": 1,
              "jsonContent": {
                "extensionFields": {},
                "partyType": "INDIVIDUAL",
                "externalReferences": [
                  {
                    "id": "811_00_9786_78y647q36",
                    "externalSystem": "MiRevenue",
                    "externalId": "9511115e-af51-43fb-9027-700cfabdffe2",
                    "internalReferenceId": "811_00_9786_78y647q36"
                  }
                ],
                "phoneNumberDetails": {
                  "phoneNumber": "8765435678",
                  "countryCode": "+91"
                },
                "alternatePhoneNumberDetails": [
                  {
                    "mobileTypes": [
                      "OFFICIAL"
                    ],
                    "phoneNumber": "8876578967",
                    "countryCode": "+91"
                  }
                ],
                "email": "yuvraj.singh@abc.com",
                "alternateEmailDetails": [
                  {
                    "emailTypes": [
                      "PERSONAL"
                    ],
                    "emailId": "yuvraj@gmail.com"
                  }
                ],
                "fullName": "Bablu Kumar Singh",
                "dateOfBirth": "01-11-1987",
                "partyInIndividualCapacity": true,
                "roleBasedAttributes": [
                  {
                    "internalReferenceId": "3f30390d-1dc4-432b-909e-768fdf52e735",
                    "phoneNumberDetails": {
                      "phoneNumber": "8765435678",
                      "countryCode": "+91"
                    },
                    "alternatePhoneNumberDetails": [
                      {
                        "mobileTypes": [
                          "OFFICIAL"
                        ],
                        "phoneNumber": "8876578967",
                        "countryCode": "+91"
                      }
                    ],
                    "email": "babu.singh@mbc.com",
                    "alternateEmailDetails": [
                      {
                        "emailTypes": [
                          "PERSONAL"
                        ],
                        "emailId": "yuvraj@gmail.com"
                      }
                    ]
                  }
                ],
                "identifications": [
                  {
                    "id": "096a4789-c624-4a2d-8afa-7a53ac433c13",
                    "type": "AADHAAR",
                    "value": "690134516213"
                  }
                ]
              },
              "nonStandardData": {
                "extensionFields": {},
                "partyType": "INDIVIDUAL",
                "externalReferences": [
                  {
                    "id": "811_00_9786_78y647q36",
                    "externalSystem": "MiRevenue",
                    "externalId": "9511115e-af51-43fb-9027-700cfabdffe2",
                    "internalReferenceId": "811_00_9786_78y647q36"
                  }
                ],
                "phoneNumberDetails": {
                  "phoneNumber": "8765435678",
                  "countryCode": "+91"
                },
                "alternatePhoneNumberDetails": [
                  {
                    "mobileTypes": [
                      "OFFICIAL"
                    ],
                    "phoneNumber": "8876578967",
                    "countryCode": "+91"
                  }
                ],
                "email": "yuvraj.singh@abc.com",
                "alternateEmailDetails": [
                  {
                    "emailTypes": [
                      "PERSONAL"
                    ],
                    "emailId": "yuvraj@gmail.com"
                  }
                ],
                "fullName": "Bablu Kumar Singh",
                "dateOfBirth": "01-11-1987",
                "partyInIndividualCapacity": true,
                "roleBasedAttributes": [
                  {
                    "internalReferenceId": "3f30390d-1dc4-432b-909e-768fdf52e735",
                    "phoneNumberDetails": {
                      "phoneNumber": "8765435678",
                      "countryCode": "+91"
                    },
                    "alternatePhoneNumberDetails": [
                      {
                        "mobileTypes": [
                          "OFFICIAL"
                        ],
                        "phoneNumber": "8876578967",
                        "countryCode": "+91"
                      }
                    ],
                    "email": "babu.singh@mbc.com",
                    "alternateEmailDetails": [
                      {
                        "emailTypes": [
                          "PERSONAL"
                        ],
                        "emailId": "yuvraj@gmail.com"
                      }
                    ]
                  }
                ],
                "identifications": [
                  {
                    "id": "096a4789-c624-4a2d-8afa-7a53ac433c13",
                    "type": "AADHAAR",
                    "value": "690134516213"
                  }
                ]
              },
              "errorsInNonStandardData": [
                {
                  "code": "string",
                  "message": "string",
                  "params": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "timestamp": "2019-08-24T14:15:22Z"
                }
              ],
              "guid": "10837558072"
            },
            "criteriaId": "37ed6422-68ac-44bd-9ab9-75c9ced5a202",
            "criteriaName": "PAN"
          }
        ],
        "additionalDetails": {
          "property1": {},
          "property2": {}
        }
      }
    ],
    "owningEntityType": "PARTY_ID",
    "owningEntityId": "189001551",
    "partyEventCode": "RE_KYC_UPDATE"
  },
  "workflowId": "692603465"
}

Request

Body Params application/json

string

required

This is a unique identifier of the dedupe execution task. This ID is used to query the dedupe result. In case this is not provided, the system auto generates this ID.

Example:

189701551

owningEntityType

enum<string>

optional

This indicates the type of entity that owns the party data. It could be a prospect or an existing party.

Allowed values:

PARTY_IDPROSPECT_ID

owningEntityId

string

optional

This indicates the unique identifier of the owning entity. It could be the Prospect ID or Party ID.

Example:

189001551

partyEventCode

enum<string>

optional

This indicates the party event that is triggering deduplication. It could be party onboarding or any update to party data.

Allowed values:

RE_KYC_UPDATEPARTY_POSTAL_ADDRESS_UPDATEPARTY_MOBILE_UPDATEPARTY_EMAIL_ID_UPDATEPARTY_IDENTIFICATION_UPDATEMINOR_TO_MAJOR_UPDATEMAJOR_TO_SENIOR_CITIZENDECEASED_STATUS_UPDATE_CONFIRMEDDECEASED_STATUS_UPDATE_INTIMATEDDECEASED_STATUS_REMOVALBLACKLISTING_OF_A_CUSTOMERBANKRUPTCY_STATUS_UPDATE_INTIMATEDBANKRUPTCY_STATUS_UPDATE_CONFIRMEDBANKRUPTCY_STATUS_REMOVALACCOUNT_OPENINGPARTY_TAG_UPDATEPARTY_NAME_SIGNATURE_UPDATEPARTY_IDENTIFICATION_TAX_UPDATEPARTY_GENERIC_DETAILS_UPDATEPARTY_ONBOARDINGPARTY_RESIDENTIAL_STATUS_UPDATEPARTY_MIGRATIONPARTY_MERGEPARTY_NON_INDIVIDUAL_GENERIC_DETAILS_UPDATE

partyType

enum<string>

required

This indicates the type of party for which dedupe is initiated.

Allowed values:

INDIVIDUALNON_INDIVIDUAL

dedupeAttribute

required

This holds the deduplication criteria for individual and non-individual party types.

One of

IndividualDedupeAttributesDTO

NonIndividualDedupeAttributesDTO

partyType

enum<string>

required

This indicates the type of party for which dedupe is initiated.

Allowed values:

INDIVIDUALNON_INDIVIDUAL

externalReferences

array[object (ExternalReferenceDTO) {6}]

optional

This holds the reference of the party in external systems.

phoneNumberDetails

array[string]

optional

This indicates all phone numbers of the party.

emailDetails

array[string]

optional

This indicates all email addresses of the party.

fullName

string

optional

This indicates the full name of the party.

Example:

Yuvraj Singh

dateOfBirth

string <date>

optional

This indicates the date of birth of the party.

Example:

01-11-1987

identifications

array[object (IndividualIdentificationDTO) {5}]

optional

This holds the identification details of the party.

onlyConfirmedMatches

boolean

optional

If this is set to "true", then deduplication check is run against confirmed match criteria only. If it is set to "false", the system runs the deduplication check against confirmed and potential match criteria.

url

string

required

When the dedupe is complete, the callback URL mentioned here is called using PUT HTTP method with the dedupe status eg: STATUS: POTENTIAL_DUPLICATE_FOUND

Example:

{{API gateway IP address}}/party-onboarding/party-onboarding/{{dedupe result ID}}/update-dedupe-status

Examples

Responses

🟢200OK

*/*

Body

dedupeResultId

string

optional

This is the ID that was passed in the dedupe request. This can also be used to query the dedupe result at a later point in time.

Example:

535164202

status

enum<string>

optional

This indicates the current operational status of a party. For example - ACTIVE or CLOSED.

Allowed values:

ACTIVECLOSED

version

integer <int64>

optional

This represents the version number of the party.

Example:

createdOn

string <date-time>

optional

This indicates the creation timestamp of the party.

Example:

2024-08-24T14:15:22.123Z

createdBy

string

optional

This indicates the name of the user who created the party.

Example:

system

updatedOn

string <date-time>

optional

This indicates the timestamp when the party record was last updated.

Example:

2024-10-24T14:15:22.123Z

updatedBy

string

optional

This indicates the name of the user who updated the party.

Example:

system

jsonContent

object (DedupeResultDTO)

required

This holds the custom content of an entity.

extensionFields

object

optional

This holds additional information about the party.

searchPolicyType

enum<string>

optional

This indicates the policy that was used to search the party. It could be CONFIRMED or POTENTIAL. CONFIRMED indicates that the system validated the incoming request against the Confirmed match criteria and found a confirmed match. POTENTIAL indicates that the system validated the incoming request against the Confirmed criteria but no result was found. Then it validated the incoming request against the Potential match criteria and found a potential match.

Allowed values:

CONFIRMEDPOTENTIAL

dedupeStatus

enum<string>

optional

This indicates the dedupe status. It could be any one of the following - CONFIRMED_DUPLICATE_FOUND, POTENTIAL_DUPLICATE_FOUND, or NO_DUPLICATE_FOUND.

Allowed values:

NOT_STARTEDSTARTEDNO_DUPLICATE_FOUNDCONFIRMED_DUPLICATE_FOUNDPOTENTIAL_DUPLICATE_FOUNDDUPLICATE_IGNORED

matchedParties

array[object (MatchedParty) {3}]

optional

This holds the list of matched parties.

owningEntityType

enum<string>

optional

This indicates the type of entity that owns the party data. It could be a prospect or an existing party.

Allowed values:

PARTY_IDPROSPECT_ID

owningEntityId

string

optional

This indicates the unique identifier of the owning entity. It could be the Prospect ID or Party ID.

Example:

189001551

partyEventCode

enum<string>

optional

This indicates the party event that is triggering deduplication. It could be party onboarding or any update to party data.

Allowed values:

workflowId

string

optional

This indicates the Temporal workflow ID of the dedupe process.

Example:

692603465

🟠400Bad Request

Modified at 2025-02-17 09:41:54

Dedupe execution

Initiate asynchronous dedupe