GET/////
Use this endpoint to retrieve a Visa Alias by its Visa Alias ID.
Header parameter
| Fields | Description |
|---|---|
| req-sys-id string Required | Identifier generated by the card program. These identifiers are used for troubleshooting requests between the card program and Marqeta. Allowable Values: 36 char max |
| participant-id string Required | Visa Business Identifier (BID) that is assigned to the program. Allowable Values: Existing participant ID |
URL path parameters
| Fields | Description |
|---|---|
| aliasId string Required | Unique identifier of the Visa Alias. Allowable Values: Existing Visa Alias ID |
Response body
| Fields | Description |
|---|---|
| aliasValue string Returned | Visa Alias value, which can be an email, a phone number, ID of an alias directory, or a payname. If a phone number is used for the Visa Alias, it must follow ITU-T E.164 (2010) number structure. NOTE: In the E.164 format, the ”+” sign is not included. Allowable Values: 1–128 chars |
| profile object Returned | Alias Directory Service (ADS) profile information. Allowable Values: - firstName- lastName- contactInfo- dateOfBirth- firstNameLocal- lastNameLocal- middleName- middleNameLocal- preferredName |
| profile.firstName string Returned | First name in the Alias Directory Service (ADS) profile. Allowable Values: 1–35 chars |
| profile.lastName string Returned | Last name in the Alias Directory Service (ADS) profile. Participants in the CEMEA and EU regions must only use the initial of the consumer’s last name followed by a period to create or modify a Visa Alias record. Allowable Values: 1–35 chars |
| profile.contactInfo array of objects Conditionally returned | Contact information in the Alias Directory Service (ADS) profile. This array is returned if the Visa Alias’ contact information details exist. Allowable Values: A valid array of contact information details |
| profile.contactInfo[].type string Returned | Type of contact information in the Alias Directory Service (ADS) profile. Allowable Values: EMAIL, PHONE, DIRECTORY_ALIASID |
| profile.contactInfo[].value string Returned | Contact information value, which is the email address or phone number. Allowable Values: 1–320 chars |
| profile.dateOfBirth string Conditionally returned | Date of birth in the Alias Directory Service (ADS) profile. This field is returned if it exists in the resource. Allowable Values: 10 chars |
| profile.firstNameLocal string Conditionally returned | First name in the Alias Directory Service (ADS) profile, expressed in the user’s local language. This field is returned if it exists in the resource. Allowable Values: 1–35 chars |
| profile.lastNameLocal string Conditionally returned | Last name in the Alias Directory Service (ADS) profile, expressed in the user’s local language. This field is returned if it exists in the resource. Allowable Values: 1–35 chars |
| profile.middleName string Conditionally returned | Middle name in the Alias Directory Service (ADS) profile. This field is returned if it exists in the resource. Allowable Values: 1–35 chars |
| profile.middleNameLocal string Conditionally returned | Middle name in the Alias Directory Service (ADS) profile, expressed in the user’s local language. This field is returned if it exists in the resource. Allowable Values: 1–35 chars |
| profile.preferredName string Conditionally returned | Preferred name in the Alias Directory Service (ADS) profile, as provided by the user. This field is returned if it exists in the resource. Allowable Values: 1–35 chars |
| aliasType string Conditionally returned | Type of Visa Alias in the Alias Directory Service (ADS) profile. Visa supports phone and email as Visa Alias types that can be used in place of sensitive payment credentials. This field is returned if it exists in the resource. Allowable Values: EMAIL, PHONE, DIRECTORY_ALIASID, PAYNAME |
| additionalAliases array of objects Conditionally returned | Additional aliases associated with the Visa Alias. Allowable Values: aliasType, aliasValue, status |
| additionalAliases[].aliasType string Conditionally returned | Type of Visa Alias associated with the cardholder. Allowable Values: EMAIL, PHONE, DIRECTORY_ALIASID, PAYNAME |
| additionalAliases[].aliasValue string Conditionally returned | Value of the Visa Alias, such as an email address or phone number. Allowable Values: 1–128 chars |
| additionalAliases[].status string Conditionally returned | Status of the Visa Alias. Allowable Values: ACTIVE, DISABLED, BLOCKED, EXPIRED, DELETED |
| consent object Conditionally returned | Visa Alias Directory Service (ADS) consent information. Allowable Values: presenter, validFromDateTime, version, expiryDateTime, intermediaries |
| consent.presenter string Returned | Presenter of the Visa Alias Directory Service (ADS) consent. Allowable Values: 1–120 chars |
| consent.validFromDateTime datetime Returned | Date and time when the validity of the Visa ADS consent begins. Allowable Values: 20 chars Format: YYYY-MM-DDThh:mm:ssZ |
| consent.version string Returned | Version of the Visa ADS consent. Allowable Values: 1–9 chars |
| consent.expiryDateTime datetime Conditionally returned | Date and time when the validity of the Visa ADS consent ends. This field is returned if it exists in the resource. Allowable Values: 20 chars Format: YYYY-MM-DDThh:mm:ssZ |
| consent.intermediaries array of strings Conditionally returned | Intermediaries of the Visa ADS consent. Allowable Values: 1–120 chars |
| createdOn datetime Conditionally returned | Date and time when the Visa Alias was created. Allowable Values: 24 chars Format: YYYY-MM-DDThh:mm:ss.000Z |
| identification object Conditionally returned | Identification of the user associated with the Visa Alias. Allowable Values: type, value, verificationDetails |
| identification.type string Returned | Type of identification provided by the user associated with the Visa Alias. Allowable Values: DNI, CE, PASSPORT, PTP, FFPP, FFAA, CCD, COI, PN, CIE, CPF, DL, DPI, NIDN |
| identification.value string Returned | Value of the identification provided by the user associated with the Visa Alias, which is used to validate the user. Passport number, for example. Allowable Values: 1–35 chars |
| identification.verificationDetails object Conditionally returned | Verification details associated with the Visa Alias. This field is returned if it exists in the resource. Allowable Values: authDateTime, authMethodReference, creationDateTime, verifiedEmail, verifiedPhone |
| identification.verificationDetails.authDateTime datetime Conditionally returned | Time when the user provided the credentials for verification in ISO UTC format. Allowable Values: format: YYYY-MM-DDThh:mm:ss.000Z |
| identification.verificationDetails.authMethodReference string Conditionally returned | Authentication method used when the user provided the credentials for verification. Allowable Values: 256 char |
| identification.verificationDetails.creationDateTime datetime Conditionally returned | Time when the user was created or enrolled in ISO UTC format. Allowable Values: format: YYYY-MM-DDThh:mm:ss.000Z |
| identification.verificationDetails.verifiedEmail boolean Conditionally returned | Returns true if an email was verified during the verification process. This email does not need to match the Alias or contact info if an email was used.Allowable Values: true, false |
| identification.verificationDetails.verifiedPhone boolean Conditionally returned | Returns true if a phone number was verified during the verification process. This phone number does not need to match the Alias or contact info if a phone number was used.Allowable Values: true, false |
| lastModifiedOn datetime Conditionally returned | Date and time when the Visa Alias was last modified. Allowable Values: 24 chars Format: YYYY-MM-DDThh:mm:ss.000Z |
| status string Conditionally returned | Status of the Visa Alias. Allowable Values: ACTIVE, DISABLED, BLOCKED, EXPIRED |
Sample response body
JSON
{
"aliasValue": "1231231234",
"profile": {
"lastName": "Miller",
"firstName": "Alex",
"middleName": "Robert",
"contactInfo": [
{
"type": "PHONE",
"value": "1231234321"
}
],
"dateOfBirth": "1980-02-01",
"lastNameLocal": "Miller",
"preferredName": "Miller's Shop",
"firstNameLocal": "Alexander",
"middleNameLocal": "Roberto"
},
"aliasType": "PHONE",
"consent": {
"version": "1.0",
"presenter": "Bank A",
"expiryDateTime": "2025-06-20T10:00:00Z",
"intermediaries": [
"Client A"
],
"validFromDateTime": "2024-12-01T10:00:00Z"
},
"identification": {
"type": "PASSPORT",
"value": "A123456",
"verificationDetails": {
"authDateTime": "2026-01-01T22:52:46Z",
"verifiedEmail": true,
"verifiedPhone": false,
"creationDateTime": "2026-01-01T22:52:46Z",
"authMethodReference": "EXTERNAL, SMS OTP, Email OTP"
}
},
"createdOn": "2026-01-01T22:52:46.000Z",
"lastModifiedOn": "2026-01-01T22:52:46.000Z",
"status": "ACTIVE"
}