# Visa Platforms Login

\
API Overview](https://developer.visa.com/capabilities/visa-platforms-login) \
API Reference](https://developer.visa.com/capabilities/visa-platforms-login/reference)

## Getting Started

Visa Platforms Login reduces friction and fragmentation in consumer enrollment and access to
Visa Marketing & Benefits programs. The API ensures security and privacy compliance while enabling issuer banks to increase consumer participation and engagement. Customers can opt in and access multiple Visa programs through a single, unified account without repetitive registrations or leaving the issuer's channels.

The target audience is issuer banks that manage cardholder profiles and have obtained consumer consent to share data with Visa.

### Standard VDP setup

Complete the following tasks in the Visa Developer Portal before attempting any Visa
Platforms Login API calls.

- Register for a VDP account at [developer.visa.com](https://developer.visa.com/).
- Complete the application approval process, if applicable to your products.
- Create a project and add the products and APIs required for your integration.
- Obtain API credentials from your project, such as client certificates or keys required
by the authentication method you are using.

Where to find these standard steps in the [Visa Developer Quick Start Guide](https://developer.visa.com/pages/working-with-visa-apis/visa-developer-quick-start-guide#section2).

- Create Account
- Request Access for restricted products
- Start Project
- Credentials

### Visa Platforms Login onboarding and provisioning

Use of the Visa Platforms Login API in production is restricted to issuer banks. The
product is explicitly classified as Restricted and is not available for general public
use, merchants, or independent developers acting on their own.

Production eligibility is limited to approved issuer banks with an active Visa relationship, appropriate commercial agreements in place, and the ability to meet Visa's consent, security, and data validation requirements.

Technical prerequisites include OAuth2 client credentials with appropriate scopes, Site
ID configuration in the GMAP system, email delivery system integration for activation emails,
and understanding of user account status lifecycle.

### Environment Hosts and URL Recipe

#### Standard VDP environment hosts

Use the [Visa Developer Quick Start Guide](https://developer.visa.com/pages/working-with-visa-apis/visa-developer-quick-start-guide#section2) to select the
correct environment host for your testing stage.

- Sandbox for VPL calls: `https://sandbox.api.visa.com/`
- Certification endpoint pattern:
`https://cert.api.visa.com/<URI>`
- Production endpoint pattern: `https://api.visa.com/<URI>`

Relevant Quick Start Guide sections include Testing in Sandbox Environment, Testing in
Certification Environment, and Testing in Production Environment.

#### URL recipe

Construct the full request URL by combining the environment host, the product base path,
and the endpoint path.

- Environment host (sandbox, certification, or production)
- Product base path `/user`
- Endpoint path (such as `/find`)

Example production request.

`GET https://api.visa.com/user/find`

### Headers and Authentication

#### Required headers

All requests require Bearer token authentication and specify an
`application/json` content type.

- `Authorization: Bearer access_token`
- `Content-Type: application/json` for requests with a body

Some endpoints require additional headers such as `clientId` for guest
enrollment operations.

#### Custom authentication guidance

Visa Platforms Login uses specialized OAuth2 scopes beyond standard VDP authentication.
See the Authentication Methods section for detailed setup instructions including scope
configuration and bearer token generation.

### Make your first API call

Use this call first to confirm authentication and retrieve user profile information.

**Request:**

`GET https://api.visa.com/user/find`

Headers:

- `Authorization: Bearer {your_access_token}`

**Expected responses:**

- `200 OK` returns user details including userDetailsId, account status,
and profile information
- `404 Not Found` indicates the user was not found
- `401 Unauthorized` indicates authentication failure or invalid
token
- `403 Forbidden` indicates insufficient permissions
- `500 Internal Server Error` indicates a server error. Retry the request
or [contact support](https://developer.visa.com/pages/support)