Update Alias

The Update Alias endpoint enables you to update the information associated with the Alias, such as the identification, profile, or consent.

You can update an alias by making a PUT request to the Update Alias endpoint, where aliasId is the identifier generated by Alias Directory. For example:

{{base-url}}/ads/api/v1/aliases/{aliasId}

The below displays an example request .

{
  "identificationInfo": {
    "type": "PASSPORT",
    "value": "A123456",
    "verificationInfo": {
      "isPhoneVerified": false,
      "authMethodReference": "EXTERNAL, SMS OTP, Email OTP",
      "authDateTime": "2021-01-01T22:52:46.000Z",
      "isEmailVerified": true,
      "creationDateTime": "2021-01-01T22:52:46.000Z"
    }
  },
  "profileInfo": {
    "firstName": "Alex",
    "lastName": "Miller",
    "firstNameLocal": "Roberto",
    "lastNameLocal": "Miller",
    "middleName": "Robert",
    "middleNameLocal": "Alexander",
    "preferredName": "Miller's Shop",
    "dateOfBirth": "1980-02-01",
    "contactInfo": [
      {
        "type": "PHONE",
        "value": "1231234321"
      }
    ]
  },
  "consentInfo": {
    "presenter": "Bank A",
    "validFromDateTime": "2021-12-01T10:00:00.000Z",
    "version": "1.0",
    "expiryDateTime": "2025-06-11T10:00:00.000Z",
    "intermediaries": [
      "Client A"
    ]
  }
}

If successful, a 204 response is returned.

📘
More Information

To view this endpoint in the API Explorer, see Update Alias.

To view descriptions for this endpoint, see Update Alias - Field Descriptions.

Updated 11 days ago