Get Alias ID from External ID

The Get Alias ID from External ID endpoint enables you to retrieve the internal id associated with an externalId initially provided during the Create Alias operation.

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

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

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

{
  "externalId": "21267931-7975-4b61-be7a-86915883b2b4",
  "type": "ALIAS"
}

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

{
  "status": "success",
  "response": {
    "trackingId": "alias#-64111a56-20250602063331",
    "id": "e336c8c8-2945-4be3-af3e-951ec2d01219",
    "associatedIds": [
      {
        "id": "string",
        "type": "string"
      }
    ]
  }
}

📘

More Information

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