Manage Duplicates

Currently we do not allow users to create multiple profiles within your environment in our system. So we use various techniques to detect duplicates in our system. In instance you run into a profile that was closed because it's a duplicate profile, the following API calls will enable you to recover a closed profile. The only way you can accomplish that is by swapping the profile by the open duplicate profile. So the closed profile opens and the open profile takes it place.

Duplicates

GET https://api.synapsefi.com/v3.1/users/:user_id/get-duplicates

This endpoint returns all the accounts that are duplicates of the user.

Headers

Name	Type	Description
X-SP-USER	string	OAuth key and device fingerprint, separated by a pipe.
X-SP-USER-IP	string	IP address of your device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

200 User Successfully Created.

{
    "closed_users_id": [
        "5eb054749f1eef380b833932",
        "5eb054d879e883412fbe8c79"
    ],
    "open_users_id": [
        "5f651b0284f2d000568557e2"
    ],
    "reason": "duplicate_name_and_address",
    "status": "CLOSED",
    "user_id": "5fd7acfd8677040053ad486d"
}

400 Request Failing.

{
    "error": {
        "code": "missing_user_credentials",
        "en": "User credentials are missing from the request."
    },
    "error_code": "200",
    "http_code": "400",
    "success": false
}

Example Request

HTTP

GET /v3.1/users/5fd7acfd8677040053ad486d/get-duplicates HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

cURL

curl --location --request GET 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/get-duplicates' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json'

Python

JS

PHP

GO

Possible reason Values

reason	Description
duplicate_tin	User profile detected as duplicate due to same TINs.
duplicate_ssn	User profile detected as duplicate due to same SSNs.
duplicate_name_and_address	User profile detected as duplicate due to same name and address.
duplicate_name_and_email	User profile detected as duplicate due to same name and email.
duplicate_name_and_date_of_birth	User profile detected as duplicate due to same name and dob.
duplicate_name_and_drive_license_number	User profile detected as duplicate due to same name and DLN.
blacklisted_user	User profile is closed because this user is blacklisted in our system.
not_known	Reason unknown.

Swap Duplicates

PATCH https://api.synapsefi.com/v3.1/users/:user_id/swap-duplicate-users

This endpoint allows you to swap one closed user profile with another in instances of duplicate profiles.

Headers

Name	Type	Description
X-SP-USER	string	OAuth key and device fingerprint, separated by a pipe.
X-SP-USER-IP	string	IP address of your device.
X-SP-GATEWAY	string	Your Client ID and Secret, separated by a pipe.

Request Body

Name	Type	Description
swap_to_user_id	string	User ID you'd like to swap the open status with.

200 User Successfully Created.

{
  "user_swapped": "user 5d7fc541ea4d4b007461adc8 swapped with 5ddc57cb3c4e2800756baa97",
  "user_id": "5d7fc541ea4d4b007461adc8", 
  "swapped_to": "5ddc57cb3c4e2800756baa97"
  
}

409 Request Failing.

{
    "error": {
        "code": "invalid_permission",
        "en": "invalid permissions for user 5eb054749f1eef380b833932"
    },
    "error_code": "400",
    "http_code": "409",
    "success": false
}

Example Request

HTTP

PATCH /v3.1/users/5fd7acfd8677040053ad486d/swap-duplicate-users HTTP/1.1
Host: uat-api.synapsefi.com
X-SP-USER-IP: 255.127.79.76
X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc
Content-Type: application/json

{
    "swap_to_user_id":"5eb054749f1eef380b833932"
}

cURL

curl --location --request PATCH 'https://uat-api.synapsefi.com/v3.1/users/5fd7acfd8677040053ad486d/swap-duplicate-users' \
--header 'X-SP-USER-IP: 255.127.79.76' \
--header 'X-SP-USER: oauth_Z3YDaGPNz2CWpgVck8L9jIxKR7odTSui5eFEt10X|e83cf6ddcf778e37bfe3d48fc78a6502062fc' \
--header 'Content-Type: application/json' \
--data-raw '{
    "swap_to_user_id":"5eb054749f1eef380b833932"
}'

Python

JS

PHP

GO