Amplia Reg Settings
General Settings
Under section General:
-
SiteUrl: publicly accessible URL of the website (e.g.:
https://ampliareg.patorum.com/). This address is used to compose emails with links back to the website. -
EncryptionKey: encryption key.
-
EncryptionCertThumb: encryption key certificate thumbprint.
-
RootPasswordHash: hash of the root password, computed above.
-
AutoUpdateDatabase: by default, the application tries to perform model changes to the database after an update (when needed). Set to
falseif the application does not have owner permissions over the database. -
SupportEmailAddress: the support email address (used in the footer of outgoing emails).
-
Flavour: type of application flavour. This affects various parts of the application like default certificate formats, labels, states, validations, allowed holder file types, etc. Defaults to
Brazil. -
HidePoweredBy: removes "powered by Lacuna" from the home page if set to
true. Defaults tofalse. -
BiometricTokenExpirationMinutes: validity of token from biometric authentication in minutes. Defaults to
720(12 hours). -
DeviceTokenExpirationMinutes: validity of token from device authentication in minutes. Defaults to
720(12 hours). -
DeviceAuthenticationTimeoutSeconds: timeout from the start of device authentication to complete device authentication in seconds. Defaults to
900(15 minutes). -
AcceptedCryptoDeviceProviders: list of accepted crypto providers separated by commas. Leave blank to accept all known crypto providers. Defaults to
null. -
DeviceAuthenticationCertificatePolicy: certificate policy of device certificate. Defaults to
1.3.6.1.4.1.46332.3.3Lacuna's subtree. -
DocumentGenerator: type of document generator. Defaults to
Standard. -
SessionTimeoutMinutes: timeout of the current session due to inactivity in minutes. Defaults to
5. -
SessionTimeoutWarningSeconds: timeout of the warning before logout due to inactivity in seconds. Defaults to
60. -
ExportedFileTicketValidityMinutes: validity of tickets to download exported files in minutes. Defaults to
60. -
ZipCompressionLevel: type of zip compression level. Defaults to
Fastest. -
DenySelfOperations: deny self operations on orders. Defaults to
false. -
AgentCertificateEnabled: enables registration agent certificate authentication. Defaults to
false. -
HsmSerialNumber: HSM serial number that will appear on agreements for cloud orders. Only applied to
Code100DocumentGenerator. Defaults tonull. -
EnableRolesConflict: roles conflict enabled. Defaults to
true. -
UseAuthorityLogosOnDocumentGeneration: uses the authorities' logos on generated documents. Defaults to
false. -
OnlineIssuanceEnabled: enables online issuance, in which the holder issues the certificate using a valid e-CPF A3 certificate. Online issuance must also be enabled on the certificate type. Defaults to
false. -
AutomaticallyFillIcaoWarningsWhenLivenessSucceded: automatically fills the ICAO warnings of the PSBio biometric collection when liveness succeeded. Defaults to
true. -
AutomaticallyFillIcaoWarningsOnPreValidation: automatically fills the ICAO warnings when the holder photo comes from the pre-validation liveness. Defaults to
true. -
CACertificateChainEnabled: installs the CA certificate chain along with the certificate on the public issuance and reinstallation pages. Defaults to
false. -
EnableSelfOrdersFilter: prevents agents from viewing and operating orders in which they are the holder. Defaults to
false. -
UseApprovalDateAsIssuedDateOnReports: uses the order approval date as the issue date on reports. Defaults to
false. -
EnableHolderDeviceLookup: records the machine name and user name where the holder's key pair is generated on issuance (requires Web PKI 1.8.6 or later). Defaults to
false. -
EnableRegistrationAgentRegulation: enables the registration agent regulation step; after approval, the agent stays in regulation pending status until completing the required authentications. Defaults to
false. -
EnableOneIdentifierPerEmail: prevents the same validated email from being used by holders with different CPFs. Defaults to
false. -
EnablePep: enables the check against the imported list of Politically Exposed Persons (PEP) in the holder identification flow. Defaults to
false. -
PepNameMinSimilarity: minimum similarity (from
0to1) between the holder's name and the name of a PEP with the same CPF for the holder to be considered a PEP. Defaults to0.5.
JobSchedules Settings
Under section JobSchedules:
controls job schedules.
- CleanupUsedNonces: desired cron schedule expression that defines when the system cleans up used or expired nonces. Defaults to
*/11 * * * *(at every 11th minute) - CertificateRenewalAlert: desired cron schedule expression that defines when the system checks for certificates close to expiration and triggers renewal alerts. Defaults to
0 10 * * *(at 10:00). - CertificateRenewalAlertTimeZone: time zone used to evaluate the CertificateRenewalAlert cron schedule expression. Defaults to the system time zone.
- SafSync: desired cron schedule expression that defines when SAF data synchronization is executed. Defaults to
*/13 * * * *(at every 13th minute). - SafOccurrencesSync: desired cron schedule expression that defines when SAF occurrence data synchronization is executed. Defaults to
*/17 * * * *(at every 17th minute). - SafOccurrencesProcess: desired cron schedule expression that defines when synchronized SAF occurrences are processed. Defaults to
*/21 * * * *(at every 21st minute). - PkiBrazilDailyReport: desired cron schedule expression that defines when the PKI Brazil daily report is generated. Defaults to
5 3 * * *(at 03:05). - ExpireStalledBryPSBioTcn: desired cron schedule expression that defines when PSBio transactions stalled for longer than
BryPSBio:TcnExpirationDaysare expired. Defaults to0 * * * *(every hour).
If you need help defining a cron schedule expression, visit crontab guru.
Order Settings
Under section Order:
-
MinConfirmationDeadlineHours: min confirmation deadline in hours for orders that will be issued before approval. Defaults to
4. -
MinConfirmationDeadlineToleranceMinutes: min confirmation deadline tolerance in minutes for orders that will be issued before approval. Defaults to
15. -
MaxConfirmationDeadlineHours: max confirmation deadline in hours for orders that will be issued before approval. Defaults to
168(7 days). -
AllowSameValidationAndConfirmationAgent: allows the same registration agent to perform both validation and confirmation of an order. Defaults to
false. -
AdditionalCertificateFormats: list of additional certificate formats separated by commas. Defaults to
null. -
AdditionalHolderFileTypes: list of additional holder file types separated by commas. Defaults to
null. -
ExpirationImminentLimitInHours: expiration imminent limit in hours. Orders with an imminent deadline will have priority in the confirmation queue. Defaults to
24. -
AllowUserCreateOrder: allows order creation without application integration. Defaults to
true. -
OrderNumberSeries: order number series. Will be used as order number prefix. Defaults to
1. -
OrderIndexLength: order index length. Defaults to
7. -
ResendIssueNotificationCooldownMinutes: resend issue notification cooldown in minutes. Defaults to
1. -
IssuePasswordLength: length of issue key one and issue key two. Defaults to
6. -
ApiSessionExpirationMinutes: default API session expiration in minutes. Defaults to
15. -
IssuePreparationSessionExpirationMinutes: issue preparation session expiration in minutes. Defaults to
16. -
IssuingSessionExpirationMinutes: issuing session expiration in minutes. Defaults to
16. -
ValidationSignatureSessionExpirationMinutes: validation signature session expiration in minutes. Defaults to
15. -
ConfirmationSignatureSessionExpirationMinutes: confirmation signature session expiration in minutes. Defaults to
15. -
PrettyIssueUrl: pretty issue URL. Will be used as issue URL over default if no other method (authority issue URL) is set. Defaults to
null. -
CloudIssueUrl: cloud issue URL. Defaults to
null. -
PendencyReasons: order pendency reasons separated by commas. Leave blank to set all default reasons. Defaults to
null. -
DeclineReasons: order declination reasons separated by commas. Leave blank to set all default reasons. Defaults to
null. -
RevocationReasons: order revocation reasons separated by commas. Leave blank to set all default reasons. Defaults to
null. -
FaceValidationProvider: face validation provider. Defaults to
None. -
PublicSearchEnabled: public certificate search enabled. Defaults to
false. -
ConfirmationRequirementMode: confirmation requirement mode.
Always,NeverorOnlyIfRequired(like Registration Agent requires confirmation). Defaults toAlways. -
IssueBeforeApprovalEnabled: set to
trueto allow orders to be issued before approval with future certificate validity. Defaults tofalse. -
AnonymizeAgentData: hides from Registration Authority users the identification data of agents that do not belong to that authority (e.g. the confirmation agent on the order details, events, audit trail and CSV reports). Certification Authority users still see the real data. Defaults to
false. -
CustomNumbersEnabled: by default the application automatically generates order numbers. Set to
trueto allow order number creation. Defaults tofalse. -
SaleNumberEnabled: sale number enabled. Defaults to
true. -
SaleNumberRequired: sale number required. Defaults to
false. -
BiometricCollectionType: type of biometric collection. Defaults to
Photo. -
DeliveryMethodDescriptionForIssueKey1: message displayed with issue key one on the subject authentication form. Defaults to
received at RA or videoconferenceorreceived via SMS(ifFlavourCaboVerde). -
DeliveryMethodDescriptionForIssueKey2: message displayed with issue key two on the subject authentication form. Defaults to
received by email or SMS. -
LivenessEnabled: liveness enabled on biometric validation step. Defaults to
false. -
PresentialLivenessType: liveness provider on presential order. Defaults to
FaceTec. -
VideoconferenceLivenessType: liveness provider on videoconference order. Defaults to
FaceTec. -
PreValidationLivenessType: liveness provider on the pre-validation. Defaults to
FaceTec. -
LivenessTriesBeforeBypass: tries before enabling liveness bypass. Defaults to
1. -
PreValidationLivenessMaxAttempts: maximum liveness attempts on the pre-validation. Defaults to
3. -
PreValidationLivenessPlatformPreference: device preference for the pre-validation liveness.
NoPreference,PreferMobileorRequireMobile. Defaults toNoPreference. -
PreValidationDocumentMaxAttempts: maximum identity document upload attempts on the pre-validation. Defaults to
3. -
PreValidationDocumentMatchLevelRejectionThreshold: document × face match level (scale from
1to16) below which the pre-validation document is rejected and the holder must try again. Leave blank to disable. Defaults tonull. -
PreValidationDocumentMatchLevelConfirmationThreshold: document × face match level (scale from
1to16) below which the order requires confirmation. Must not be lower thanPreValidationDocumentMatchLevelRejectionThreshold. Leave blank to disable. Defaults tonull. -
PreValidationDigitalCnhDataValidEnabled: when
FaceValidationProviderisSerpro, validates the digital CNH submitted on the pre-validation through its QR Code (DataValid). Defaults tofalse. -
VideoConferenceFaceAuthenticationMaxAttempts: maximum holder face authentication attempts during the videoconference. Defaults to
3. -
BrazilIdentificationFieldMode: Brazil identification fields mode. Defaults to
Required. -
EnableValidationReverseGeolocation: enables validation reverse geolocation. Defaults to
false. -
RequireConfirmationForPresentialIssuance: set all presential orders to require confirmation. Defaults to
false. -
AllowVideoConferenceIssueTypeChange: allows changing the issue type of videoconference orders to presential. Defaults to
false. -
EnableConfirmationUpdateDocuments: enables updating holder documents on confirmation, this will generate a new agreement to be signed by the confirmation agent if any documents have changed. Defaults to
false. -
DisableIssueKey1: dispenses issue key one; the holder issues the certificate with issue key two only. Defaults to
false. -
AllowValidationAcrossRegistrationAuthorities: allows presential orders to be validated by agents of other Registration Authorities. Defaults to
false. -
EarlyIssueKey2NotificationEnabled: sends issue key two to the holder before the order is approved. Defaults to
false. -
HolderEmailValidationEnabled: enables the pre-validation, with holder email validation through an OTP code, for presential and videoconference orders. Defaults to
false. -
HolderEmailValidationLinkValidityDays: pre-validation link validity in days. Defaults to
7. -
SubjectAuth: Under section SubjectAuth:
controls holder authentication on the subject authentication form.
- MaxFailedAttempts: maximum failed attempts before locking the order. Defaults to
1. - InitialLockPeriodMinutes: initial lock period in minutes. Defaults to
1.
- MaxFailedAttempts: maximum failed attempts before locking the order. Defaults to
CertificateRenewalAlert Settings
See Configure certificate renewal alert for more details.
Maps Settings
Under section Maps:
Used to retrieve the service place location when configured.
- AzureEndpointUrl: Azure endpoint URL. Defaults to
https://atlas.microsoft.com/. - AzureClientId: Azure client ID. Defaults to
null. - AzurePrimaryKey: Azure primary key. Defaults to
null.
CertificateType Settings
Under section CertificateType:
- KeySizes: Allowed key sizes separated by commas. Defaults to
1024,2048,3072,4096.
SealCertificate Settings
Under section SealCertificate:
Used for agreement and dossier signature for pre approved orders.
- Certificate: Certificate base 64. Defaults to
null. - ProtectedKey: Protected key base 64. Defaults to
null.
Jitsi Settings
Under section Jitsi:
- Domain: domain. Defaults to
8x8.vc. - Issuer: issuer used on JWT
issfield. Defaults tochat. - AppId: application id. Defaults to
null. - ApiKey: API key. Defaults to
null. - PrivateKeyPath: private key path. Defaults to
null. - PrivateKeyContent: private key content. Defaults to
null. - PrivateKeyType: private key type. Defaults to
PKCS1. - IsSharedService: by default the application throws an exception if it receives any payload and it cannot find a related order. If same configured Jitsi is used by other applications and can send webhooks for outside application purposes set to
true. Defaults tofalse.
Serpro Settings
Under section Serpro:
- DatavalidMinSimilarity: min similarity to accept face validation. Defaults to
0.93. - DatavalidMinConfirmationSimilarity: min similarity to accept face validation with confirmation warning. Defaults to
null.
RfbQuery Settings
Under section RfbQuery:
- Enabled: enabled. Defaults to
null. - Endpoint: endpoint. Defaults to
https://www6.receita.fazenda.gov.br/. - ServerCertificateThumbprint: accept response from pinned server certificate. Defaults to
null. - DangerousAcceptAnyServerCertificate: ignore server certificate validation. Defaults to
false. - PfxContent: certificate content. Defaults to
null. - PfxPath: certificate path. Defaults to
null. - PfxPassword: certificate password. Defaults to
null.
HolderFileTypes Settings
Under section HolderFileTypes:
Key value will be used to save the value in the database and must have a maximum length of 15 characters.
Key: displayed name.
BryPSBio Settings
Under section BryPSBio:
- Endpoint: endpoint. Defaults to
null. - Username: username. Defaults to
null. - Password: password. Defaults to
null. - TokenRenewAdvanceSeconds: token renew advance seconds. Defaults to
300(5 minutes). - TokenExpirationSeconds: token expiration seconds. Defaults to
900(15 minutes). - TcnExpirationDays: days without completion after which a PSBio transaction is expired by the
ExpireStalledBryPSBioTcnjob. Defaults to30. - ServerCertificateThumbprint: accept response from pinned server certificate. Defaults to
null. - DangerousAcceptAnyServerCertificate: ignore server certificate validation. Defaults to
false. - FingerMinQualityScore: fingerprint minimum quality score. Defaults to
25. - HealthCheckEnabled: health check enabled. Defaults to
true. - HealthCheckPath: health check path. Defaults to
api/profile-info.
AscertiaAdss Settings
Under section AscertiaAdss:
- Endpoint: endpoint. Defaults to
null. - ClientId: client id. Defaults to
null. - ClientSecret: client secret. Defaults to
null. - ServerCertificateThumbprint: accept response from pinned server certificate. Defaults to
null. - DangerousAcceptAnyServerCertificate: ignore server certificate validation. Defaults to
false.
Sms Settings
Under section Sms:
See Configure SMS sending for more details.
Saf Settings
Under section Saf:
- Enabled: enabled. Defaults to
false. - Endpoint: endpoint. Defaults to
null. - PfxContent: certificate content. Defaults to
null. - PfxPath: certificate path. Defaults to
null. - PfxPassword: certificate password. Defaults to
null. - BatchSyncSize: batch sync size. Defaults to
100. - CacheTimeoutMinutes: cache timeout in minutes. Defaults to
1. - ServerCertificateThumbprint: accept response from pinned server certificate. Defaults to
null. - DangerousAcceptAnyServerCertificate: ignore server certificate validation. Defaults to
false. - SendTimeoutMinutes: send timeout in minutes. Defaults to
1.
PkiBrazilDailyReport Settings
Under section PkiBrazilDailyReport:
- AutoGenerationCertificationAuthorityId: Certification authority id to auto generate daily report. Defaults to
null. - BatchSize: batch size. Defaults to
50.
GoogleMaps Settings
Under section GoogleMaps:
Used to retrieve the validation IBGE code when
EnableValidationReverseGeolocationis enabled.
- ApiKey: API key. Defaults to
null.
Amplia Settings
Under section Amplia:
- Disabled: disabled. Defaults to
null. - Endpoint: endpoint. Defaults to
null. - ApiKey: API key. Defaults to
null. - Timeout: timeout. Defaults to
null. - Culture: culture. Defaults to
null. - DefaultSubscriptionId: default subscription id. Defaults to
null. - IdnKeyId: id of the Amplia key used to obtain the holder's IDN. Defaults to
null. - IdnApiKey: API key used to obtain the holder's IDN. Required when
IdnKeyIdis set. Defaults tonull.
Audit Settings
Under section Audit:
- Endpoint: endpoint. Defaults to
null. - ApiKey: API key. Defaults to
null. - TimeoutSeconds: timeout in seconds. Defaults to
null. - CultureName: culture name. Defaults to
null. - DangerousAcceptAnyServerCertificate: ignore server certificate validation. Defaults to
false. - ServerCertificateThumbprint: accept response from pinned server certificate. Defaults to
null. - AuditWarningAdvanceDays: how many days in advance a device audit due date starts being flagged. Defaults to
7. - ScanAppUrl: URL of the scanning instructions shown on the device audit. Defaults to
null.
Acertpix Settings
Under section Acertpix:
- Endpoint: endpoint. Defaults to
https://api.plataformaacertpix.com.br/. - DocumentoscopiaPro: Under section DocumentoscopiaPro:
- ClientId: client id. Defaults to
null. - ClientSecret: client secret. Defaults to
null.
- ClientId: client id. Defaults to
- DocumentoscopiaScore: Under section DocumentoscopiaScore:
- ClientId: client id. Defaults to
null. - ClientSecret: client secret. Defaults to
null.
- ClientId: client id. Defaults to
- Facematch: Under section Facematch:
- ClientId: client id. Defaults to
null. - ClientSecret: client secret. Defaults to
null. - MinSimilarityThreshold: minimum similarity threshold. Defaults to
95
- ClientId: client id. Defaults to
- DocumentoscopiaLite: Under section DocumentoscopiaLite:
- ClientId: client id. Defaults to
null. - ClientSecret: client secret. Defaults to
null.
- ClientId: client id. Defaults to
- WebhookUrl: URL to receive webhooks. Defaults to
null. - WebhookApiKey: webhook API key. Defaults to
null. - DangerousAcceptAnyServerCertificate: ignore server certificate validation. Defaults to
false. - ServerCertificateThumbprint: accept response from pinned server certificate. Defaults to
null.
VideoIdentification Settings
Under section VideoIdentification:
- Enabled: enabled. Defaults to
false. - AllowIdCaptureValidationSkips: allows skipping the document capture validations on video identification. Defaults to
false.
VideoconferenceCache Settings
Under section VideoconferenceCache:
- CacheRecordSlidingExpirationMinutes: cache record sling expiration in minutes. Defaults to
5.
BryBioService Settings
Under section BryBioService:
- AgentBiometricsEnabled: enabled registration agent biometric authentication. Defaults to
false. - AgentBiometricsEndpoint: endpoint to be used on biometric authentication. Defaults to
null.
Otp Settings
Under section Otp:
Each OTP purpose is configured in its own subsection: VideoIdentification (video identification), Videoconference (videoconference), HolderEmailValidation (holder email validation on the pre-validation) and OnlineIssuance (online issuance).
In each subsection:
- Length: OTP length. Defaults to
6. - ResendTimeoutSeconds: OTP resend timeout in seconds. Defaults to
60. - ValidityMinutes: OTP validity in minutes. Defaults to
15. - DeliveryMethods: delivery OTP methods separated by commas. Configured order will be the displayed order on OTP form. Possible values
EmailorSms. Defaults tonull.
Geolocation Settings
Under section Geolocation:
- Disabled: disables geolocation collection. Defaults to
false. - EnableLowAccuracyRetry: enable low accuray retry after failed attempt. Defaults to
true. - MaximumAgeSeconds: maximum age in seconds. Defaults to
60. - TimeoutSeconds: timeout in seconds. Defaults to
20.
PublicContact Settings
Under section PublicContact:
- Email: configures the email address that will be used on public screens and in emails sent by the system. Defaults to
null. - WhatsappPhone: configures the whatsapp phone that will be used on public screens and in emails sent by the system. Defaults to
null. - Phone: configures the phone that will be used on public screens and in emails sent by the system. Defaults to
null.
Alert Settings
Under section Alert:
- Enabled: enables flagging orders with an alert (e.g. inconsistencies in the PSBio biometric enrollment); flagged orders cannot be confirmed. Defaults to
false. - CacheTimeoutMinutes: alert cache timeout in minutes. Defaults to
1.
Localizer Settings
Under section Localizer:Sms:
Overrides the default SMS message texts. Leave blank to use the default text.
- SmsIssueKeyMessage: SMS message sending the issue key. Defaults to
null. - SmsOnlineIssuanceMessage: online issuance SMS message. Defaults to
null. - EarlyIssueKey2Message: SMS message sending issue key two in advance. Defaults to
null.