V2 Migration Guide | Parallel Developer Documentation
Version: Current – v2.x
On this page
note
This guide is intended to be used by existing partners who have integrated with the V1 Identity and/or Accreditation APIs and are looking to migrate to the V2 Case Management API.
If you are a new partner, you already have access to the Case Management product and should start with the Server API Introduction.
deprecation warning
We will sunset legacy V1 API support on December 1st, 2024.
The Case Management API is part of the modern Case Management product offered by Parallel Markets. New partners will have access to the Case Management product by default.
If you are an existing partner and are interested in upgrading to the Case Management product, please contact sales.
Integrating with the Case Management API
Certain use cases previously supported by the Identity and Accreditations API are supported by the single Case Management API. For example, obtaining a subject's current identity information and accreditation status can be done with a single API call to the Retrieve a record endpoint.
The same id that is used to call the existing Identity and Accreditation APIs can be used to call the Case Management API's. For example, the id used in a call to the /v1/identity/{id} Identity API endpoint can be used to call to the /v2/partner-records/{id} Case Management API endpoint.
| Use Case | V1 Identity API | V1 Accreditation API | V2 Case Management API |
|---|---|---|---|
| Obtain subject's identity-related information | ✅ | ❌ | ✅ |
| Obtain subject's accreditation status | ❌ | ✅ | ✅ |
| Obtain risk match information | ✅ | ❌ | ✅ |
| Obtain a history of changes to a subject's record | ❌ | ❌ | ✅ |
Before You Migrate
If you are upgrading to the Case Management product, your integration may need to be updated to handle additional functionality that the Case Management product offers. To avoid errors or unexpected behavior after migration, these changes should be implemented and tested before turning on Case Management. Below are some things to be aware of before you migrate to Case Management.
V2 API
All partners still relying on any V1 APIs must immediately migrate to use V2 APIs. If you don't already have a sandbox environment with Case Management enabled for development and testing, get in touch with our sales team.
Risk Monitoring
Case Management performs risk monitoring for all records that are created in the system. This includes records for investors that have only shared accreditation information with you.
You can use the V2 API to obtain a list of risk matches, or get a specific risk match, for any record in your case management instance.
Risk Monitoring Webhooks
If you have webhooks configured, you may receive additional webhook events shortly after your migration to Case Management due to risk monitoring that will begin to be performed on accreditation-only records. Refer to the Webhooks section for more information.
Webhooks
Partners who utilize legacy per-client webhooks should migrate to modern webhooks to benefit from additional webhook events.
Note: Case Management performs risk monitoring for all records, including records for investors that have only shared accreditation information. This may result in your webhook being triggered for Risk Monitoring events that you previously may not have been listening to. Partners should ensure they are handling these additional events if these were not being handled previously.