Identity & Onboarding v2 Upgrade
Overview
We are upgrading our Identity and Onboarding module from v1 to v2. This migration is driven by evolving regulatory compliance requirements that necessitate enhanced identity verification capabilities, as well as the opportunity to deliver a significantly faster onboarding experience through improved automated processes.
The new v2 module introduces an updated onboarding API that enhances the registration and KYC experience for both Individual and Business user types. As a partner running an active program on our platform, your integration with the onboarding and identity services will require updates. This guide outlines the scope, preparation steps, and migration process to ensure a smooth transition for your users.
API Change
New v2 Identity & Onboarding API
- Replaces all v1 onboarding endpoints for user registration and KYC submission
User Types Affected
Individual & Business
- Both user types will be migrated. Re-KYC may apply to select users.
Migration Workflow
1
Preparation
Your UAT stack will be provisioned with the v2 Identity API to allow you to begin integration work.
UAT stack V2 Identity & Onboarding module enablement
- We will enable the v2 Identity API on your designated UAT environment. You will be able to access the endpoints using your existing API credentials.
2
v2 Identity & Onboarding API Integration
API integration and retrofit updated features
- Integrate your application against the new v2 Identity endpoints. Test the full registration and KYC submission flows for both Individual and Business user types.
Refer to the Implementation checklist for the integration and workflow guides.
Take note of the following key changes:
Modularized base URL (update is required for all modules) | API endpoint URL format:
The format is applicable to all APIs | API endpoint URL format:
e.g.
The format is modularized per API category. All stack APIs must use this modularized base URL across all modules. To know more about these new base URLs, refer to the Begin technical integration guide for more details. |
Endpoint credentials | No changes | No changes |
Individual user creation
| Create User (/v1/users) has a limited set of user profile fields that can be passed in the request. | Create User (/v2/users) has an expanded set of user profile fields that can be passed in the request. To know which fields are required for you, refer to Region-specific Onboarding. |
Individual user creation
| Update the parent-child identifiers partner_id, agent_id, and customer_id to track entity linkage. | Use the Create (Sub-business) Individual User |
Individual eKYC
| Call Process KYC Verification | Call Process KYC Verification (POST /users/authentications/documents/process) without the need to pass an eKYC provider ID. All document uploads and EDD requirements (for high-risk users) have been added to the eKYC workflows. |
Individual eKYC
| Subscribe to | Subscribe to |
Business user creation
| Create User (/v1/businesses) has a limited set of user profile fields that can be passed in the request. | Create User (/v2/businesses) has an expanded set of user profile fields that can be passed in the request. To know which fields are required for you, refer to Region-specific Onboarding. |
Business user creation
| Update the parent-child identifiers partner_id, agent_id, and customer_id to track entity linkage. | Use the Create (Sub-business) Individual User |
Business user creation
| Capability unavailable | Create Business-Associated Parties |
Business eKYC
| Capability unavailable | Call Process KYC Verification |
Business eKYC - Associated Parties
| Capability unavailable | Call Process Associated Party KYC Verification |
Business eKYC
| No webhooks available | Subscribe to |
3
Implementation Verification
Joint sign-off to confirm readiness before proceeding to production migration.
End-to-end testing completion
- Confirm that all onboarding and KYC flows pass acceptance criteria on UAT. Document and resolve any integration issues.
Readiness sign-off
- Both parties confirm implementation is complete and ready for production migration.
4
Deployment and Migration
Moving existing users and routing new users to the v2 module.
PRD stack V2 Identity module enablement
- We will enable the v2 Identity API on your designated PRD environment.
Legacy onboarding cut-off
- A cut-off must be set up, preventing the creation of new users using the v1 Identity API.
Migration of existing users to v2
- All existing users will be migrated to the v2 Identity module by the MatchMove technical team. User data, KYC status, and approval records will be carried over. No partner action is required for this step.
Routing of new users to v2
- Partners are responsible for updating their app integrations to route all new user registrations through the v2 onboarding API. This is a partner action and should be completed in coordination with your deployment schedule.
5
[Post-Migration] Data Compliance and Re-KYC Requirements
Select users may need to undergo re-verification under the v2 module.
Business Users
- Users whose most recent KYC approval is older than 1 year will be required to undergo re-KYC under the v2 module.
Individual Users
- All migrated users must complete any additional required v2 information requirements, which includes:
- New v2 required fields (if any)
- Additional compliance required fields (if any)
- Any additional data requirements must be supplied within an agreed-upon timeframe. Failure to do so will result in a downgrade of their KYC status.
- While users meeting specific criteria (to be defined and communicated separately) will be required to undergo full re-KYC under the v2 module.
Support & Contact:
- For technical questions regarding the v2 API integration, please contact your designated Technical Account Manager or reach out to the integration support team.
- For migration scheduling and coordination, your Account Program Manager will be your primary point of contact throughout the process.
On this page
- Identity & Onboarding v2 Upgrade