ConfigurationItem
A ConfigurationItem object represents a Authentix configuration and it corresponds to a set of settings used to define and send an authentication code to a user. This includes for exemple, the code length, the service name, the message template, the SMTP settings, ...
Message Templates
Reach Authentix API allows to customize the message sent to your user for the purpose of authentication. Message templates are predefined messages that serve this objective. They can be defined for both sms and email channels and this is done through the web console.
When defining a message template, one can introduces templates variables that will be populated later when performing authentications to achieve customization.
Template variables are in the form of ${VARIABLE_NAME}. Here, VARIABLE_NAME represents the name of the variable. It is alphanumeric, case-insensitive, and must start by a letter.
There exists some predefined variables that could be used within message templates with some particular meanings:
${SERVICE_NAME}: It corresponds to the service name associated with the configuration used to perform the authentication.
${CODE}: It corresponds to the generated one-time code sent to the user. It must be part of all message templates.
${EXPIRY_TIME}: It corresponds to the expiration time of the one-time code in minutes.
${PAYEE}: It corresponds to the payee of the financial transaction. It is required for digital payment authentications.
${AMOUNT}: It corresponds to the amount of the financial transaction being authenticated. It is required for digital payment authentications.
${CURRENCY}: It corresponds to the currency of the financial transaction being authenticated. It is required for digital payment authentications.
In addition, there exist email related variables that could be used to customize your message:
${SENDER_EMAIL}: The email used to send the message. If not specified, the username of the SMTP Setting will be used.
${SENDER_NAME}: The name of the sender.
${EMAIL_SUBJECT}: The subject of the message. The default is: "Your authentication code".
If no message template is specified during an authentication process, the following default is used:
In case of digital payment verification:
${SERVICE_NAME}: your authentication code for the payment of ${CURRENCY} ${AMOUNT} to ${PAYEE} is ${CODE}.Otherwise:
${SERVICE_NAME}: your authentication code is ${CODE}.
SMTP Settings
Reach Authentix API allows to send authencication code via email. To leverage this channel, you need to provide the SMTP settings that will be used for that purpose. This includes the SMTP host, port, username, password, and so on ...
For an step-by-step guide on how to add SMTP settings in the web console, see here.
ConfigurationItem Attributes
appletIdstring
The identifier of the applet creating the configuration.
apiVersionstring
The API version used to create the configuration.
configurationIdstring
The identifier of the configuration.
serviceNamestring
The name of the authentication service.
codeLengthinteger
The length of the code to be generated.
allowCustomCodeboolean
A flag indicating if the configuration allows sending custom and pre-generated codes.
usedForDigitalPaymentboolean
A flag indicating if the configuration is used to authenticate digital payments.
defaultExpiryTimeinteger
The default expiry time of the authentication code.
defaultMaxTrialsinteger
The default maximum number of authentication trials for an authentication process.
defaultMaxControlsinteger
The default maximum number of code controls for an authentication process.
smtpSettingIdstring
The ID of the SMTP settings used by the configuration.
emailTemplateIdstring
The default email template ID used by this configuration.
smsTemplateIdstring
The default sms template ID used by this configuration.
dateCreateddate-time
The date and time in UTC that the configuration was created.
dateUpdateddate-time
The date and time in UTC that the configuration was last updated.