This API is used to create an Alias in the Alias Directory and associate it with one or more payment credentials.

Sample request:

POST ads/api/v1/aliases
{
    "aliasInfo": {
        "type": "PHONE",
        "value": "1231231234",
        "externalId": "21267931-7975-4b61-be7a-86915883b2b4"
    },
    "paymentType": "CARD",
    "paymentInfo": {
        "cardInfo": {
            "nameOnCard": "Alex Miller",
            "issuerName": "Bank A",
            "cardType": "Visa Platinum",
            "expirationDate": "2030-01",
            "externalId": "63421837-d597-4f0f-89e4-930c1a7b9e85",
            "currencyCode": "USD",
            "preferredFor": [ { "type": "RECEIVE" } ],
            "billingAddress": {
                "country": "USA",
                "addressLine1": "1000 Market Street",
                "addressLine2": "Suite 101",
                "buildingNumber": "56",
                "city": "San Francisco",
                "minorSubdivisionCode": "CA",
                "streetName": "12",
                "postalCode": "94105",
                "state": "CA"
            },
            "accountNumber": "411*****455***42"
        },
        "bankInfo": {
            "accountName": "Alex Miller",
            "accountNumber": "411*****455***42",
            "accountNumberType": "DEFAULT",
            "accountType": "SAVING",
            "bankName": "Bank A",
            "bankCode": "173",
            "branchCode": "123456",
            "bankCodeType": "ABA",
            "bic": "AAAABBCC123",
            "countryCode": "USA",
            "currencyCode": "USD",
            "externalId": "63421837-d597-4f0f-89e4-930c1a7b9e85",
            "address": {
                "country": "USA",
                "addressLine1": "1000 Market Street",
                "addressLine2": "Suite 101",
                "buildingNumber": "56",
                "city": "San Francisco",
                "minorSubdivisionCode": "CA",
                "streetName": "12",
                "postalCode": "94105",
                "state": "CA"
            },
            "preferredFor": [ { "type": "RECEIVE" } ]
        },
        "threddInfo": {
            "accountNumber": "238915978",
            "nameOnCard": "Alex Miller",
            "issuerName": "Bank A",
            "cardType": "Visa Platinum",
            "externalIdForCard": "63421837-d597-4f0f-89e4-930c1a7b9e85",
            "currencyCode": "USD",
            "preferredFor": [ { "type": "RECEIVE" } ],
            "billingAddress": {
                "country": "USA",
                "addressLine1": "1000 Market Street",
                "addressLine2": "Suite 101",
                "buildingNumber": "56",
                "city": "San Francisco",
                "minorSubdivisionCode": "CA",
                "streetName": "12",
                "postalCode": "94105",
                "state": "CA"
            }
        }
    },
    "identificationInfo": {
        "type": "PASSPORT",
        "value": "A123456",
        "verificationInfo": {
            "isPhoneVerified": "false",
            "authMethodReference": "EXTERNAL, SMS OTP, Email OTP",
            "authDateTime": "2021-01-01T22:52:46Z",
            "isEmailVerified": "true",
            "creationDateTime": "2021-01-01T22:52:46Z"
        }
    },
    "consentInfo": {
        "presenter": "Bank A",
        "validFromDateTime": "2021-12-01T10:00:00Z",
        "version": "1.0",
        "expiryDateTime": "2025-06-11T10:00:00Z",
        "intermediaries": [ "Client A", "Client B" ]
    },
    "profileInfo": {
        "firstName": "Alex",
        "lastName": "Miller",
        "firstNameLocal": "Alexander",
        "lastNameLocal": "Miller",
        "middleName": "Robert",
        "middleNameLocal": "Roberto",
        "preferredName": "Miller's Shop",
        "dateOfBirth": "1980-02-01",
        "contactInfo": [
            { "type": "PHONE", "value": "1231234321" },
            { "type": "EMAIL", "value": "[email protected]" }
        ]
    }
}