Get Alias - Field Descriptions

The following table details the fields included in the response for the Get Alias endpoint.

Response

The following table describes the fields that are included in the response.

Field

Description

trackingId

The UUID generated by Thredd which identifies each transaction.

status

The status of the alias.

aliasType

The type of Alias provided in aliasValue

aliasValue

The value of the Alias. For example, a phone number or email address. If a phone number is used for the alias, it should be provided in accordance with ITU-T E.164 (2010) number structure. Note that in the E.164 format, the "+" sign is not included.

consent

An object that contains the consent details for the alias.

presenter

Identifies the presenter of consent to the consumer.

validFromDateTime

The Date/Time from which the consent is valid, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z. Only accepts present and past dates.

version

The specific version of the terms and conditions that the customer has accepted for the user solution.

expiryDateTime

The Date/Time when the consent expires, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z.

intermediaries

The intermediary parties involved in the consent grant.

consent

profile

An object that contains the profile details of the customer that owns the alias.

firstName

First name of the customer.

lastName

Last name of the customer.

contactInfo

An object that contains the contact information for the profile.

type

The contact type. For example, EMAIL or PHONE.

contactInfo

dateOfBirth

The date of birth of the customer.

firstNameLocal

The first name in the local language.

lastNameLocal

The last name in the local language.

middleNameLocal

The middle name in the local language.

preferredName

The preferred name (or the 'known-as' name) of the customer.

profile

externalId

The client-provided identifier for the alias.

identification

An object that contains the form of identification for the customer. Note that this object is optional and only used for specific use cases.

type

The identification type. For example, a driver's license or passport.

value

The identification number for the individual who owns the Alias.

verificationDetails

An object that contains details on the verification of the identification.

authDateTime

The time when the user provided the credentials for verification, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z

authMethodReference

The authentication method used when the user provided the credentials for verification.

creationDateTime

The time when the user was created or enrolled, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z.

verifiedEmail

Boolean value. True if an email was verified during the verification process. This email does not need to match the Alias or contact info if an email was used.

verifiedPhone

Boolean value. True if a phone was verified during the verification process.

verificationDetails

identification

lastModifiedOn

The date when the record was last modified, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z.