Update Alias

Updates the information associated with an Alias, such as identification, profile, or consent details.

The request requires the aliasId path parameter in a valid GUID format.

Sample request:

PUT ads/api/v1/aliases/{aliasId}
{
  "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"
    ]
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

Documentation

For more information on this endpoint, see Update Alias.

Path Params
string
required

The unique identifier assigned to an alias

Body Params

The request body containing updated alias information

Request model for updating an Alias, including identification, profile, and consent information.

identificationInfo
object

Identification information for the alias owner.

profileInfo
object
required

Profile information details for the customer that owns the alias.

consentInfo
object
required

Consent details for the alias owner.

Responses
204

Updated

Language
URL
LoadingLoading…
Response
Choose an example:
application/json