deactivateSourceWs

  • Web Services
  • UMPI
  • API Documentation
  • Universal Identity

The deactivateSourceWs web service is used to deactivate (logically delete) a source record from your instance of Universal Identity.

Deactivated records are no longer considered in subsequent matching decisions. These records can be reactivated using the reactivateSourceWS web service. Deactivated records are visible in the user interface and in the deactivatedSourceRecords section of the identity object on API responses.

Sample URL

The URL for this request is of the format https://custXXXX.verato-connect.com/link-ws/svc/deactivateSourceWs, where XXXX is a 4-digit number.

deactivateSourceWs JSON request

  • The request includes:

    • A tracking ID (an optional identifier that the client can supply to track the response)
    • The Source+Native ID of the source record you wish to deactivate
  • {
        "trackingId": "string",
        "content": {
            "sourceToDeactivate": {
                "name": "string",
                "id": "string"
            }
        }
    }

deactivateSourceWs JSON response

  • The response includes:

    • An ‘echo’ of the same tracking ID from the request
    • Several Boolean and string values with more information about the success/failure of the service
    • The Link ID of the Universal Identity entity that was modified (in the case where the Universal Identity entity also included other source records which remain active)
    • The Link ID of the Universal Identity entity that was deactivated (only in the case where the Universal Identity entity contained a single source record, the source record you deactivated)
  • {
      "trackingId": "string",
    "auditId": UUID, "success": boolean, "retryableError": boolean, "message": "string", "errors": [ "string" ], "content": { "linkIdsModified": ["string"], "linkIdsDeactivated": ["string"] } }

For more information, please refer to article Delete and Deactivate Records.