Create Alias - Field Descriptions

The following tables describe the fields in the request and the response for the Create Alias endpoint.

Request

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

Field	Description	Type	Min Length	Max Length	Mandatory
paymentType	The payment credential type. Select from CARD, BANK, CARDANDBANK, THREDDTOKEN	AN			Yes
aliasInfo	Object that describes information related to the alias.				Yes
type	The type of Alias provided in aliasValue.	AN			Yes
value	The value of the Alias, for example phone number or email address. If phone number is used for alias, this should be provided in accordance with ITU-T E.164 (2010) number structure. Please note that in the E.164 format, the "+" sign is not included.	AN	1	128	Yes
externalId	It’s a client-provided identifier for the Alias.	AN	1	100	No
aliasInfo	End of aliasInfo object.
consentInfo	Object that describes information related to the alias.	AN			Yes
presenter	Identifies the presenter of consentInfo to the consumer.	AN			Yes
validFromDateTime	Date/Time from which the consentInfo is valid, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z. Only accepts present and past dates.	D			Yes
version	Specific version of the terms and conditions that the customer accepts for the user solution.	AN	1	9	Yes
expiryDateTime	Date/Time when the consentInfo expires, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z.	D			No
intermediaries	Intermediary parties involved in the consentInfo grant.	AN			No
consentInfo	End of consentInfo object.
paymentInfo	The paymentInfo object will either be a cardInfo object, a bankInfo object, a threadInfo object, or a combination of cardInfo and bankInfo objects, depending on the value of paymentType.				Yes
cardInfo	Must be present if the paymentType is either CARD or CARDANDBANK and is used to add the payment card details. For details on this object, see cardInfo Fields.				Conditional
bankInfo	Must be be present if the paymentType is either BANK or CARDANDBANK and is used to add the bank details. For details on this object, see bankInfo Fields.				Conditional
threddInfo	Must be present if the paymentType is THREDDTOKEN and is used to fetch card/bank details based on publicToken. For details on this object, see ThreddInfo Fields.				Conditional
paymentInfo	End of paymentInfo object.
identificationInfo	Object that contains the form of identification information. This object is optional and only used for specific use cases.				No
type	IdentificationInfo type. For example, Driver's License or Passport.	AN			Yes
value	Unique number for the individual who owns the Alias.	AN	1	35	Yes
verificationInfo	Object that contains information of the verification.				No
authDateTime	Time when the user provided the credentials for verification, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z	D			No
authMethodReference	Authentication method used when the user provided the credentials for verification	AN	0	35	No
creationDateTime	Time when the user was created or enrolled, in ISO UTC format YYYY-MM-DDThh:mm:ss.000Z	D			No
isEmailVerified	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.	B	0	5	No
isPhoneVerified	True if a phone was verified during the verification process. This phone does not need to match the Alias or contact info if a phone was used.	B	0	5	No
verificationInfo	End of verificationInfo object.
identificationInfo	End of identificationInfo object.
profileInfo	Object that contains profile details for the customer that owns the Alias.				Yes
firstName	First name of the customer.	AD	1	35	Yes
lastName	Last name of the customer.	AD	1	35	Yes
contactInfo	Object that contains contact information for the customer.				No
type	Contact type. Select from EMAIL, PHONE, DIRECTORY_ALIASID.	AD	5	17	Yes
value	Phone number or email address to contact the customer.	AD	1	320	Yes
contactInfo	End of contactInfo object.
dateOfBirth	Date of birth of the customer.	AD	1	10	No
firstNameLocal	First name in local language.	AD	1	35	No
lastNameLocal	Last name in local language.	AD	1	35	No
middleName	Middle name in English.	AD	1	35	No
middleNameLocal	Middle name in local language.	AD	1	35	No
preferredName	Preferred name (or the 'known-as' name).	AD	1	35	No
profileInfo	End of profileInfo object.

cardInfo Fields

The following table describes the fields in the paymentInfo object when cardInfo object is selected.

Field	Description	Type	Min Length	Max Length	Mandatory
nameOnCard	The name that appears on the card.	AN	1	120	Yes
issuerName	The name of the issuer of the card.	AN	1	150	Yes
cardType	The card type description. For example, Visa Platinum.	AN	1	70	Yes
accountNumber	The primary account number of the card	AN	12	19	Yes
expirationDate	The expiration date for the card. Format is YYYY-MM.	AN	7	7	Yes
externalId	The client-provided identifier for the payment credential.	AN	1	100	No
currencyCode	The recipient card currency code. The format is the 3-character ISO-4217 (Alpha-3) currency code.	AN	3	3	No
preferredFor	Indicates if a payment credential is a preferred Receiving, Sending, or Paying account.	Array			No
billingAddress	Object that contains the billing address details.	Object			Yes
country	The country code of the billing address. Uses the 3-character ISO 3166 (Alpha 3) format.	AN	3	3	Yes
streetName	The street name of the billing address	AN	1	60	No
City	The city of the billing address.	AN	1	35	No
postalCode	The post code of the billing address.	AN	1	16	No
AddressLine1	The first line of the billing address.	AN	0	99	No
buildingNumber	The building number of the billing address.	AN	1	60	No
AddressLine2	The second line of the billing address.	AN	0	99	No
State	The state of the billing address.	AN	1	16	No
minorSubdivisionCode	The minor subdivision code of the billing address.	AN	1	50	No
billingAddress

bankInfo Fields

The following table describes the fields in the paymentInfo object when bankInfo object is selected.

Field	Description	Type	Min Length	Max Length	Mandatory
accountName	The bank account name. For example, the account holder name as recorded on the bank account.	AN	1	70	Yes
accountType	The bank account type. For example, Checking or Saving.	AN			No
accountNumberType	The bank account number type. For example, IBAN.	AN			Yes
accountNumber	The primary account number of the card	AN	12	19	Yes
bankName	The bank name of the payment credential.	AN	1	50	Yes
bankCode	The bank account bank code.	AN	1	12	No
branchCode	The bank account branch code.	AN	1	12	No
bankCodeType	The bank account bank code type. This is conditional for select markets.	AN			No
bic	The bank account's Business Identifier Code (BIC).	AN	8	11	No
countryCode	The bank account's country code.	AN	3	3	Yes
externalId	The client-provided identifier for the payment credential.	AN	1	100	No
currencyCode	The recipient card's currency code. The format is a 3-character ISO-4217 (Alpha-3) currency code.	AN	3	3	No
preferredFor	Indicates if a payment credential is a preferred Receiving, Sending, or Paying account.	Array			No
billingAddress	Object that contains the billing address details.	Object			Yes
country	The country code of the billing address. Uses the 3-character ISO 3166 (Alpha 3) format.	AN	3	3	Yes
streetName	The street name of the billing address	AN	1	60	No
City	The city of the billing address.	AN	1	35	No
postalCode	The post code of the billing address.	AN	1	16	No
AddressLine1	The first line of the billing address.	AN	0	99	No
buildingNumber	The building number of the billing address.	AN	1	60	No
AddressLine2	The second line of the billing address.	AN	0	99	No
State	The state of the billing address.	AN	1	16	No
minorSubdivisionCode	The minor subdivision code of the billing address.	AN	1	50	No
billingAddress

ThreddInfo Fields

The following table describes the fields in the paymentInfo object when the ThreddInfo object is selected.

Field	Description	Type	Min Length	Max Length	Mandatory
nameOnCard	The name that appears on the card.	AN	1	120	Yes
issuerName	The name of the issuer of the card.	AN	1	150	Yes
cardType	The card type description. For example, Visa Platinum.	AN	1	70	Yes
accountNumber	The primary account number of the card	AN	12	19	Yes
externalIdForCard	The client-provided identifier for the payment credential.	AN	1	100	No
preferredFor	Indicates if a payment credential is a preferred Receiving, Sending, or Paying account.	Array			No
billingAddress	Object that contains the billing address details.	Object			Yes
country	The country code of the billing address. Uses the 3-character ISO 3166 (Alpha 3) format.	AN	3	3	Yes
streetName	The street name of the billing address	AN	1	60	No
City	The city of the billing address.	AN	1	35	No
postalCode	The post code of the billing address.	AN	1	16	No
AddressLine1	The first line of the billing address.	AN	0	99	No
buildingNumber	The building number of the billing address.	AN	1	60	No
AddressLine2	The second line of the billing address.	AN	0	99	No
State	The state of the billing address.	AN	1	16	No
minorSubdivisionCode	The minor subdivision code of the billing address.	AN	1	50	No
billingAddress

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.
aliasId	The UUID generated by Alias Directory which identifies the create report request.
externalId	The identifier used by the client to identify the alias.
paymentCredentials	An object that lists the payment credentials for the alias.
id	The UUID generated by Alias Directory which identifies the payment credential.
type	The payment credential type.
externalId	The client-provided identifier for the payment credential.
paymentCredentials