Get Alias

The Get Alias endpoint enables you to retrieve information on a specific alias.

You can retrieve details of an alias by making a GET request to the Get Alias endpoint, with the identifier generated by Alias Directory included. For example:

{{baseUrl}}/ads/api/v1/aliases/{aliasId}

If successful, a 200 response is returned with details of the alias. See the below example.

{
  "status": "success",
  "response": {
    "status": "ACTIVE",
    "trackingId": "alias#-64111a56-20250602063331",
    "aliasType": "PHONE",
    "createdOn": "2021-01-01T22:52:46.000Z",
    "aliasValue": "1231231234",
    "lastModifiedOn": "2021-01-01T22:52:46.000Z",
    "consent": {
      "version": "1.0",
      "presenter": "Bank A",
      "expiryDateTime": "2022-06-20T10:00:00Z",
      "intermediaries": [
        "Client A"
      ],
      "validFromDateTime": "2021-12-01T10:00:00Z"
    },
    "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"
    },
    "identification": {
      "type": "PASSPORT",
      "value": "A123456",
      "verificationDetails": {
        "authDateTime": "2021-01-01T22:52:46Z",
        "verifiedEmail": true,
        "verifiedPhone": false,
        "creationDateTime": "2021-01-01T22:52:46Z",
        "authMethodReference": "EXTERNAL, SMS OTP, Email OTP"
      }
    }
  }
}

📘
More Information

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

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

Updated 11 days ago