Get Alias ID from Value

The Get Alias ID from Value endpoint enables you to retrieve the internal id associated with the Alias value. The id required in this endpoint can be then used in the lifecycle management APIs.

You can get an alias ID by making a POST request to the Get Alias ID from Value endpoint. For example:

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

The body must include the unique identifier the represent the customer in the payment ecosystem where the user moves funds. See the below example.

{
  "aliasValue": "1231231234"
}

If successful, a 200 response is returned with a trackingId and AliasId for the customer.

{
  "status": "success",
  "response": {
    "trackingId": "alias#-64111a56-20250602063331",
    "aliasId": "e336c8c8-2945-4be3-af3e-951ec2d01219"
  }
}

📘

More Information

• To view this endpoint in the API Explorer, see Get Alias ID From Value
• To view descriptions for this endpoint, see Get Alias ID from Value - Field Descriptions.