Get Alias ID from External ID - Field Descriptions

The following tables describe the fields in the request and the response for the Get Alias ID from External ID endpoint.

Request

The following table describes the fields that can be included in the request.

FieldDescriptionTypeMin LengthMax LengthMandatory
externalIdThe External Id (maintained by client) associated to the entity type.AN1100Yes
typeThe entity type associated to the external Id.ANYes

Response

If successful, a 200 response is returned.

Field

Description

trackingId

The UUID generated by Thredd which identifies each transaction.

id

The requested internal ID.

associatedIds

Object that contains the payment credential IDs associated with the ID.

id

The UUID associated to the external id.

type

The associated ID type. For example PAYMENT_CREDENTIAL.

associatedIds