---
title: "Patch alias"
method: PATCH
path: "/v1/aliases/{alias}"
tags: ["/v1/aliases"]
---

# Patch alias

`PATCH /v1/aliases/{alias}`

Update existing aliases and provision Network Tokens.

## Path parameters

- `alias` string, required

## Request body

- AliasPatchRequest
  - `removePlain` boolean — Remove the pan from storage.
  - `expiryMonth` string — The expiry month of the card.
  - `expiryYear` string — The expiry year of card.
  - `cardholder` CardholderData
    - `ipAddress` string — IP address.
    - `phoneNumber` string — Phone number.
    - `emailAddress` string — Email address.
  - `createNetworkToken` boolean — Create a Network Token.
  - `cardOnFile` CardOnFile — Card On File
    - `id` string — Card on file Id
  - `cardHolderNameVerification` CardHolderNameVerification — Cardholder name
    - `firstName` string — Cardholder firstname
    - `lastName` string — Cardholder lastname
    - `middleName` string — Cardholder middle name

## Response `200`

Successfully patched alias

- AliasInfoResponse
  - `alias` string — The requested alias.
  - `fingerprint` string — An unique identifier of the card number. Useful to identify multiple customers' or the same customer's transactions where the same card was used.
  - `type` 'CARD' | 'CERTIFICATE' | 'PFC' | 'REK' | 'IBAN' | 'TWI' | 'KLN' | 'INT' | 'PAP' | 'ESY' | 'MFX' | 'MPX' | 'SWP' | 'MDP' | 'ALP' | 'PLU' | 'PFP'
  - `masked` string — The nonsensitive masked representation of the value behind the alias (e.g. `490000xxxxxx0003` for aliases of type `CARD`)
  - `dateCreated` string, date-time — Creation date
  - `validUntil` string, date-time — Valid until
  - `card` AliasInfoCardInfoDetail — Information about the card behind the alias if available. For some cards (e.g. Boncard) no information will be returned.
    - `usage` 'SIMPLE' | 'REGISTRATION'
    - `expiryMonth` string — The expiry month of the card. Currently not available when the Convert API was used before.
    - `expiryYear` string — The expiry year of the card. Currently not available when the Convert API was used before.
    - `last4` string
    - `bin` string
    - `panRemoved` boolean — Indicates if PAN has been removed.
    - `cardInfo` CardInfo — The card information if the request was done with a card object
      - `brand` string — The brand of the credit card (e.g. VISA CREDIT).
      - `coBrand` string — The coBrand of the card
      - `type` string — The type of the card (`credit`, `debit` or `prepaid`). The property will not be present if the card type is unknown.
      - `usage` string — The usage of the card (`consumer`, `corporate` or `unknown`).
      - `country` string — 2 letter ISO 3166-1 alpha-2 country code.
      - `issuer` string — The issuer of the card.
      - `accountType` 'PAN' | 'TOKEN'
      - `binLength` integer — The bin length, if known.
    - `cardOnFile` CardOnFile — Card On File
      - `id` string — Card on file Id
    - `networkToken` TokenInfo — Scheme token details. This information is only available if the card behind the alias has been tokenized.
      - `expiryMonth` string — The expiry month of the scheme token
      - `expiryYear` string — The expiry year of the scheme token
      - `status` 'INACTIVE' | 'ACTIVE' | 'SUSPENDED' | 'DELETED' | 'PENDING' | 'FAILED' — The status of the scheme token
      - `paymentAccountReference` string — The Payment Account Reference of the scheme token
      - `tokenRequestorId` string — The token requestor id
      - `token` string — Scheme token
      - `reason` NetworkTokenError
        - `code` 'SERVICE_NOT_ALLOWED' | 'TOKEN_PROVIDER_UNAVAILABLE' | 'MISSING_FIELD' | 'DECLINED' | 'REQUIRE_ADDITIONAL_AUTHENTICATION' | 'WAITING_ACTIVATION' | 'INTERNAL_ERROR' | 'UNKNOWN_ERROR'
        - `message` string
    - `altId` TokenInfo — Scheme token details. This information is only available if the card behind the alias has been tokenized.
      - `expiryMonth` string — The expiry month of the scheme token
      - `expiryYear` string — The expiry year of the scheme token
      - `status` 'INACTIVE' | 'ACTIVE' | 'SUSPENDED' | 'DELETED' | 'PENDING' | 'FAILED' — The status of the scheme token
      - `paymentAccountReference` string — The Payment Account Reference of the scheme token
      - `tokenRequestorId` string — The token requestor id
      - `token` string — Scheme token
      - `reason` NetworkTokenError
        - `code` 'SERVICE_NOT_ALLOWED' | 'TOKEN_PROVIDER_UNAVAILABLE' | 'MISSING_FIELD' | 'DECLINED' | 'REQUIRE_ADDITIONAL_AUTHENTICATION' | 'WAITING_ACTIVATION' | 'INTERNAL_ERROR' | 'UNKNOWN_ERROR'
        - `message` string
    - `walletIndicator` 'APL' | 'PAY'
    - `applePay` ApplePay
      - `deviceManufacturerIdentifier` string
    - `3D` ThreeDInfo — The 3D information of the card.
      - `cavv` string — The cavv of the card.
      - `eci` string — The eci of the card.
      - `multiToken` MultiToken[]
        - `cavv` string
        - `merchantIdentifier` string
        - `amount` integer
    - `cardHolderNameVerification` CardHolderNameVerificationResults — Cardholder name verification results
      - `nameMatch` 'NONE' | 'PARTIAL' | 'FULL'
      - `firstNameMatch` 'NONE' | 'PARTIAL' | 'FULL'
      - `lastNameMatch` 'NONE' | 'PARTIAL' | 'FULL'
      - `middleNameMatch` 'NONE' | 'PARTIAL' | 'FULL'
  - `PFP` PostfinancePayAliasInfoResponse — The PostfinancePay payload.
    - `maskedIban` string — The PostfinancePay masked IBAN of the according account to identify the token's account by the shopper.

## Other responses

- `400` — Invalid request

---

[API](https://skmtc.dev/pci-proxy/apis/pci-proxy-api-reference-datatrans-endpoints.md) · [All operations](https://skmtc.dev/pci-proxy/apis/pci-proxy-api-reference-datatrans-endpoints/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pci-proxy/pci-proxy-api-reference-datatrans-endpoints/revisions/1f4f905fd175/schema)