Update Alias - Field Descriptions
The following tables describe the fields in the request and the response for the Update Alias endpoint.
Request
The following table describes the fields that can be included in the request.
| Field | Description | Type | Min Length | Max Length | Mandatory |
|---|---|---|---|---|---|
| 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 | |||||
| profile | An object that contains the profile details of the customer that owns the alias. | ||||
| firstName | First name of the customer. | AN | 1 | 35 | Yes |
| lastName | Last name of the customer. | AN | 1 | 35 | Yes |
| contactInfo | An object that contains the contact information for the profile. | Yes | |||
| type | The contact type. For example, EMAIL or PHONE. | AN | Yes | ||
| value | The phone number or email address to contact the customer. | AN | 1 | 320 | Yes |
| contactInfo | |||||
| dateOfBirth | The date of birth of the customer. | AN | 1 | 10 | No |
| firstNameLocal | The first name in the local language. | AN | 1 | 35 | No |
| lastNameLocal | The last name in the local language. | AN | 1 | 35 | No |
| middleNameLocal | The middle name in the local language. | AN | 1 | 35 | No |
| preferredName | The preferred name (or the 'known-as' name) of the customer. | AN | 1 | 35 | No |
| profile | |||||
| 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 | |||||
| identificationInfo |