Visa Platforms Login

Use the Visa Platforms Login API to implement user registration, authentication, profile updates, and administrative management with secure workflows for both standard and guest users. It supports multi-factor authentication, session management, and compliance validation for seamless access to platform services.

Before proceeding, ensure you have completed the prerequisites outlined in the Getting Started guide, including OAuth2 credentials and Site ID configuration.

The Visa Platforms Login API supports multiple user management workflows. This guide covers the most common implementation patterns for user registration, authentication, and profile management.

Standard User Registration Workflow

1. Submit user registration request to /user/registration

   Include required fields: primaryUserIdentifier, email, userSiteRegistrationRequest with siteId and attributes including locale.

2. Handle registration response and user activation.

   The system sends an activation email to the user. The response includes a user ID for tracking.

3. Process account activation via /user/activate-token/{userId}.

   Users activate their accounts using the token received via email. This completes the registration process.

4. Enable user login through /user/site/{siteId}/login.

   Once activated, users can authenticate using their credentials and access platform services.

Guest User Enrollment Workflow

5. Prepare guest enrollment request with user assets.

   Include PAN information in userAssets array and required site attributes. For external enrollments, encrypt payload using Message Level Encryption.

6. Submit enrollment to /user/guest/enrollments or /user/v2/enrollments.

   The system validates user data against OFAC screening automatically during enrollment.

7. Handle OFAC validation results.

   Accounts are auto-activated if OFAC validation passes. Users denied by OFAC will not be activated and require manual review.

8. Guide users through password reset for full access.

   Guest users must reset their password on the GMAP website to obtain login credentials and access full functionality.

User Authentication and Session Management

9. Authenticate users via /user/site/{siteId}/login.

   Provide username, password, and siteId. Include optional MFA parameters (otp, otpType) if multi-factor authentication is enabled.

10. Extend user sessions using /user/extend-login.

    Maintain active sessions by calling this endpoint with valid user authentication tokens before session expiration.

11. Retrieve user details with /user/find.

    Access current user profile information using the user's authentication token.

Multi-Factor Authentication Setup

12. Initialize MFA setup via /user/mfa/totp/setup.

    This generates a TOTP key for users with NOT_ENROLLED MFA status.

13. Complete MFA enrollment using /user/mfa/totp/enroll.

    Users provide their TOTP code to complete the enrollment process and activate MFA protection.

14. Manage MFA status with unenroll endpoints

    Use /user/mfa/totp/unenroll for user-initiated removal or /user/mfa/totp/unenroll/dashboard for administrative removal.

Administrative User Management

15. Search for users using /user/queries.

    Locate users by userDetailsId or email address. Include siteId and set includeAttributes flag for comprehensive user data.

16. Update user profiles via /user/update or /user/{userId}.

    Modify user details such as firstName, lastName, title, and dateOfBirth using appropriate authentication tokens.

17. Handle batch operations for user migration

    Use /migrate endpoints for bulk user data migration and /user/re-validate for OFAC or MOE synchronization.

Following these workflows enables comprehensive user management across Visa platforms, including secure registration, authentication, profile management, and administrative oversight capabilities.

Monitor API responses for error conditions and implement appropriate retry logic. Refer to the Error Codes documentation for detailed troubleshooting guidance.