Things to Know

Before you begin integrating with the Visa Platforms Login API, it is important to understand the underlying logic and key structural concepts that drive successful enrollment and authentication workflows.

Resource Hierarchy

Understanding how data is structured helps prevent integration errors.

Resource Role Dependency
User Account Primary Foundation entity for all operations; must be active status for most functions
Site Registration Parent Requires existing user account; enables site-specific features and data
User Assets (PANs) Child Associated with user accounts; includes metadata and default asset designation
MFA Enrollment Child Requires active user account; follows NOT_ENROLLED → SETUP → ENROLLED sequence
DTS Tokens Child Linked to userDetailsId; managed separately from main authentication

Business Rules

Core Business Rules

  • Mature Issuer Organization Assumption: Visa Platforms Login implicitly assumes that the client is a mature issuer organization with established cardholder data, consent management, and operational readiness. Most integration failures occur from misalignment of these underlying assumptions around consent ownership, data readiness, validation handling, and authentication responsibility.
  • Enrollment-Centric Design: Visa Platforms Login responses represent definitive enrollment decisions, not transient or preliminary states. Successful integrations account for strict validation, expected rejections, decoupled consumer login behavior, and Visa-owned authentication flows.
  • User Account Status Lifecycle: Users must be active status to perform most operations. Pending activation users can only activate or resend activation emails. On-hold statuses prevent certain operations until resolved through proper channels.
  • Site-Specific Data Isolation: User attributes and site registrations are isolated per site ID. Site-specific data requires proper site configuration and cannot be accessed across site boundaries without appropriate permissions.
  • OFAC Sanctions Screening Mandatory: All guest enrollments trigger mandatory OFAC sanctions screening with eventual consistency. Failed OFAC screening prevents account activation and requires business process alignment.

Enterprise Business Rules

  • Role-Based Access Controls: Different authentication requirements apply for concierge vs cardholder roles. Concierge access is restricted by issuer site associations and requires proper permissions for cardholder information access.
  • Asset Management Controls: User assets (primarily PANs) include metadata arrays and default asset designation. Asset values are hashed for security storage and require site-specific permissions for modification.
  • Campaign and Marketing Integration: Marketing opt-ins support multiple channels (SMS, email, online, transactional, cashback) with timestamp tracking. Campaign opt-ins support various types (CAUSES, PROGRAM, CLO, SWEEPSTAKES, TOPX) across different platforms (IMP, VDV).
  • Audit and Compliance Requirements: All user modifications track updatedByUser for audit trails. Account creation, update timestamps, last successful login, lockout dates, and password update dates are maintained separately for compliance monitoring.

Guardrails & Limitations

  • Design for Event-Driven Usage: Visa Platforms Login implicitly constrains usage through its enrollment-centric design, strict validation model, and production commercial requirements. Design for event-driven, low-frequency, high-quality API usage rather than high throughput or bulk retry patterns.
  • Payload Correctness Priority: Prioritize payload correctness over call volume. The API is optimized for accurate enrollment data rather than high-frequency operations or real-time consumer interaction patterns.
  • Environment-Specific Site Domains: Site domain values are strictly restricted by environment. QA environments use rvcom-qa.visa.com variants, Sandbox uses review.visa.com variants, and Production uses www.visa.com country-specific variants.
  • Message Level Encryption: External guest enrollments require message-level encryption for sensitive data. Internal enrollments do not require additional encryption beyond standard API security.
  • Migration Batch Processing: Migration operations are designed for batch processing with detailed status tracking. Individual record failures can be retried by batch ID without reprocessing successful records.
  • Search Pagination Limits: Cardholder search operations support pagination with maximum 500 records per page and maximum 1000 pages total. Search criteria require issuer filtering and status validation.

User Type Considerations

  • Basic Integration Developers: Focus on user registration, activation, authentication, and profile management workflows using standard endpoints.
  • Partner Integration Developers: Require understanding of guest enrollment variations, encryption requirements, and external vs internal API differences.
  • Enterprise Integration Teams: Need access to migration tools, batch processing capabilities, administrative functions, and system monitoring endpoints.
  • Customer Service Teams: Require concierge tools for cardholder lookup, interaction history, and customer support workflow integration.