<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Lacuna.RestPkiCore.Api</name>
    </assembly>
    <members>
        <member name="P:Lacuna.RestPki.Api.Authentication.PrepareAuthenticationRequest.SecurityContextId">
            <summary>
            The ID of a security context to be used to validate the user's certificate. If omitted, the default security context configured on the subscription will be assumed.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Authentication.PrepareAuthenticationRequest.IgnoreRevocationStatusUnknown">
            <summary>
            Whether a certificate whose revocation status cannot be assertained should still be considered valid. If omitted, the default configuration for the
            subscription will be used.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Bio.Sessions.IdentificationDocumentCaptureSessionInfo.AcceptedWithWaivedCriteria">
            <summary>
            Whether the captured document was accepted with one or more acceptance criteria waived - a criterion
            that would normally have to pass was not enforced. The session's result report details them.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Bio.Sessions.StartBioSessionRequest.TrustedOrigin">
             <summary>
             **Required when using the Widget (iFrame) mode.**
            
             Defines the base URL of the frontend application where the biometric widget will be rendered.  
             This value is used as a **security trusted origin** to prevent session hijacking.
            
             ---
            
             **Flow when using TrustedOrigin:**
            
             - The client embeds the widget using `lacuna-restpki-widget` (NPM) or pure JS via CDN.
             - The result is returned directly to the caller JavaScript method using:
            
             ```js
             let widget = new RestPkiWidget();
             let result = await widget.performBioSession(sessionUrl);
             // use result.completeTicket
             ```
            
             ---
            
             **Mutual exclusivity rule:**
            
             You must provide **either** `TrustedOrigin` **or** `ReturnUrl`.  
             They **cannot** be used together.
            
             ---
            
             **Documentation:**  
             [Integration Guide](https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/integration/get-started.html)
             </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Bio.Sessions.StartBioSessionRequest.ReturnUrl">
             <summary>
             **Required when using Redirect mode (no widget / no iFrame).**
            
             Defines the absolute URL to which the user will be redirected after the biometric process is completed.
            
             ---
            
             **Flow when using ReturnUrl:**
            
             - The client must redirect the user directly to `sessionUrl`.
             - The biometric process runs in a standalone page.
             - After completion, the user is automatically redirected back to `ReturnUrl`.
            
             ---
            
             **Mutual exclusivity rule:**
            
             You must provide **either** `ReturnUrl` **or** `TrustedOrigin`.  
             They **cannot** be used together.
            
             ---
            
             **Documentation:**  
             [Integration Guide](https://docs.lacunasoftware.com/en-us/articles/rest-pki/core/integration/get-started.html)
             </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Bio.Sessions.StartVideoIdentificationSessionRequest.AllowIdCaptureValidationSkips">
            <summary>
            Whether the identification document capture may accept a document without confirming every check,
            when doing so avoids forcing the user into a dead-end retry. Disabled (<c>false</c> or unset) by
            default. The effective value is fixed for the session at creation time and does not change
            afterwards.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.DocumentKeys.AllocateDocumentKeyBatchRequest.Count">
            <summary>
            Amount of document keys that should be allocated.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.DocumentKeys.DocumentKeySummary.Key">
            <summary>
            The key used to lookup the document on the validation page, unformatted (digits and letters only)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.DocumentKeys.DocumentKeySummary.FormattedKey">
            <summary>
            The key used to lookup the document on the validation page, in formatted form
            </summary>
        </member>
        <member name="T:Lacuna.RestPki.Api.Documents.DocumentFileModel">
            <summary>
            Represents a document's file, either its original file or the signed file
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Documents.DocumentSummary.Id">
            <summary>
            The ID of the document
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Documents.DocumentSummary.Key">
            <summary>
            The key used to lookup this document on the validation page, unformatted (digits and letters only)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Documents.DocumentSummary.DateCreated">
            <summary>
            Date and time the document was created
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Documents.DocumentSummary.SubscriptionId">
            <summary>
            Subscription of the document
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Documents.DocumentSummary.FormattedKey">
            <summary>
            The key used to lookup this document on the validation page, in formatted form
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Documents.DocumentSummary.OriginalFile">
            <summary>
            The original file before being signed
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Documents.DocumentSummary.MarkedFile">
            <summary>
            If the original file is a PDF, the `MarkedFile` contains the PDF with the validation marks that are added before the first signature. Otherwise,
            this property is null.
            </summary>
            <remarks>
            Some applications that perform CMS signatures of PDFs may find useful to provide this file instead of the `SignedFile` to users as the
            "signed file", that is, a file that can be understood by dummy users as being signed and that can be easily opened (as opposed to the
            `SignedFile` which is a p7s file). In this case, such applications will typically have another name for the `SignedFile`, such as
            "signature package", "raw signature file", "P7S file", "PKCS#7 file" etc.
            
            On the special case of detached CMS signatures of PDFs, this is the p7s file's counterpart, that is, the "data file" that
            corresponds to the p7s signature.
            </remarks>
        </member>
        <member name="P:Lacuna.RestPki.Api.Documents.DocumentSummary.SignedFile">
            <summary>
            The signed file, which may be the original file with the signature added (PAdES and XmlDSig signature) or a new file (CAdES signature)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Documents.DocumentSummary.SignatureType">
            <summary>
            The type of signature performed on the document (PAdES, CAdES or XmlDSig)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Documents.DocumentSummary.AvailableUntil">
            <summary>
            Date and time until which the document will be available for download
            </summary>
        </member>
        <member name="T:Lacuna.RestPki.Api.SignatureSessionStatus">
            <summary>
            Status of the signature session:
            `Pending` (session was created but not yet completed nor expired nor cancelled),
            `Processing` (session has been completed and is undergoing background processing),
            `Completed` (session is complete and all documents are ready for download),
            `UserCancelled` (the user cancelled the session),
            `Expired` (the session has expired -- expiration occurrs normally after 4 hours) or
            `ProcessingError` (a rare condition occurred during the background processing of one or more documents)
            </summary>
        </member>
        <member name="T:Lacuna.RestPki.Api.DocumentStatus">
            <summary>
            Status of the document:
            `PendingSignature` (document was given by the app but not yet signed),
            `Processing` (document is being processed),
            `Completed` (document has been signed and is ready for download) or
            `ProcessingError` (a rare condition occurred during the background processing of the document)
            </summary>
        </member>
        <member name="T:Lacuna.RestPki.Api.FileReferenceModel">
            <summary>
            Represents a file, either submitted to the API or returned by it.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.FileReferenceModel.MimeType">
            <summary>
            MIME type of the file
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.FileReferenceModel.Content">
            <summary>
            File's content (encoded as Base64 if using the REST API directly)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.FileReferenceModel.BlobToken">
            <summary>
            Token granting access to reference a file stored on the server side
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.FileReferenceModel.Url">
            <summary>
            When submitting a file to the API, this can be used as a way to reference the file. The URL must support the GET method and it should have
            all the necessary parameters to grant access without any additional headers. When the API is returning a file, this field holds a temporary
            absolute URL for downloading the file, expiring after a short period of time (normally 1 hour), so DO NOT STORE IT.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.FileReferenceModel.Name">
            <summary>
            Original file name or suggested file name for the signed file (depending on the case)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.FileReferenceModel.Length">
            <summary>
            Length in bytes of the file
            </summary>
        </member>
        <member name="T:Lacuna.RestPki.Api.FortFaceServerEnumAttribute">
            <summary>
            Reserved for internal use by the Rest PKI Core implementation.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.StampPdfRequest.TimestampTier">
            <summary>
            The ID or name of a timestamp tier to be used to timestamp the document. If omitted, the default tier will be assumed.
            </summary>
        </member>
        <member name="T:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureRequest">
            <summary>
            Request for extending an archive timestamp (AD-RA signature)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureRequest.File">
            <summary>
            Reference to the signed file to extend (PAdES, CAdES or XAdES)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureRequest.SecurityContextId">
            <summary>
            Security context id for timestamp generation. If not specified, uses the subscription's default security context
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureRequest.ReturnTimestampModels">
            <summary>
            Whether to return detailed timestamp information in the response. Default is false
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureRequest.MinActiveTimestampValidityDays">
            <summary>
            Minimum number of days before timestamp expiration to trigger extension. 
            If the current timestamp is valid for more than this value, no extension is performed.
            If not specified, uses the subscription's default value
            </summary>
        </member>
        <member name="T:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureResponse">
            <summary>
            Response for archive timestamp extension operation
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureResponse.Extended">
            <summary>
            Indicates whether a new archive timestamp was added.
            False if the current timestamp is still valid for more than MinDaysToExtend days
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureResponse.File">
            <summary>
            Reference to the file with extended signature. Null if Extended is false
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureResponse.ActiveTimestampBefore">
            <summary>
            Information about the most recent archive timestamp before extension
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureResponse.ActiveTimestampAfter">
            <summary>
            Information about the newly added archive timestamp. Null if Extended is false
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureResponse.DaysUntilExpiration">
            <summary>
            Number of days until the current timestamp (or new timestamp if extended) expires
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ExtendArchivalSignatureResponse.RecommendedExtensionDate">
            <summary>
            Recommended date for the next extension operation, calculated as (ValidUntil - MinDaysToExtend).
            Extension should be performed before this date to maintain uninterrupted validity
            </summary>
        </member>
        <member name="T:Lacuna.RestPki.Api.Signature.ArchiveTimestampInfo">
            <summary>
            Information about an archive timestamp
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ArchiveTimestampInfo.TimestampModel">
            <summary>
            Detailed timestamp information. Null if ReturnTimestamps is false in the request
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ArchiveTimestampInfo.DateIssued">
            <summary>
            Date and time when the timestamp was issued by the TSA (Time Stamping Authority)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.ArchiveTimestampInfo.DateExpires">
            <summary>
            Date and time when the timestamp expires (based on TSA certificate validity)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.PrepareSignatureRequest.SecurityContextId">
            <summary>
            The ID of a security context to be used to validate the user's choice of certificate. If omitted, the default security context configured on the subscription will be assumed.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.Signature.PdfSignatureOptions.ConvertToPdfA">
            <summary>
            Indicates whether the document should be converted to PDF/A during processing.
            
            Note: This conversion feature must be enabled and properly configured in the system.
            If the conversion to PDF/A is not enabled in the current server, an ApiException
            will be thrown when attempting to perform the conversion.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureInspection.InspectSignatureRequest.File">
            <summary>
            The signed file to be inspected.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureInspection.InspectSignatureRequest.Validate">
            <summary>
            Whether the signatures should be validated.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureInspection.InspectSignatureRequest.SecurityContextId">
            <summary>
            If validating signatures, optionally specify the ID of the security context to be used to validate signer certificates. If omitted, the
            caller's default security is used.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureInspection.InspectSignatureRequest.DataFile">
            <summary>
            If validating detached CMS/CAdES signatures, the detached data file must either be passed here or its digest(s) must be passed on `dataHashes`.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureInspection.InspectSignatureRequest.DataHashes">
            <summary>
            If validating detached CMS/CAdES signatures, the detached data file must either be passed on `dataFile` or its digest(s) must be passed here. Pass
            at least the SHA-256 digest of the file (other digests may be necessary depending on the signature algorithm used by the signers).
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureInspection.InspectSignatureRequest.ExtractEncapsulatedContent">
            <summary>
            When `True`, if applicable, that is, if the signature file being opened is a CMS signature, the encapsulated content is returned
            on the response. If not applicable, that is, if the signature file is not a CMS signature, this property is ignored.
            </summary>
        </member>
        <member name="F:Lacuna.RestPki.Api.SignatureInspection.InspectSignatureFailures.DataFileRequired">
            <summary>
            A CMS/CAdES signature was given and validation was requested but the signature is detached, therefore the detached data file must be given.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureInspection.InspectSignatureResponse.Success">
            <summary>
            Wether the signature inspection operation was successful. If not, check `failure` for the reason.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureInspection.InspectSignatureResponse.Failure">
            <summary>
            Reason for the operation to have failed.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureInspection.InspectSignatureResponse.Signers">
            <summary>
            Information about each signer found on the signed file. If the file is not signed, this will be empty.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureInspection.InspectSignatureResponse.Document">
            <summary>
            If the file was signed on this instance, contains information about the document
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionRequest.ReturnUrl">
            <summary>
            The absolute URL to which the user will be redirected upon completion of the process. Omit if the signature page will be openened on a new tab.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionRequest.SecurityContextId">
            <summary>
            The ID of a security context to be used to validate the user's choice of certificate. If omitted, the default security context configured on the subscription will be assumed.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionRequest.CallbackArgument">
            <summary>
            A callback argument that can be used to store any app-specific state. This parameter can be retrieved later when fetching the session's results, and is stored in encrypted form at all times.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionRequest.EnableBackgroundProcessing">
            <summary>
            By default, users are kept waiting while documents are processed before being redirected back to your application. Specify `true` to redirect users without waiting
            (your application must then be ready to handle the case of a signature session whose documents are not readily available for download!).
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionRequest.DisableDownloads">
            <summary>
            By default, users can download the files after signing, before returning to your app. If you feel like this feature is hindering the process in any way, pass `true`
            to disable downloading of signed files. Users will only be able to download signed files back on your app.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionRequest.DocumentMetadata">
            <summary>
            Metadata to be added to each document that the user uploads on the session (if uploading is allowed on the session)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionRequest.Documents">
            <summary>
            Documents to be signed during the session. If omitted, the user will be able to upload his own documents to the session.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionRequest.CertificateRequirements">
            <summary>
            A list of requirements that the certificate must meet in order to be used for signature of the documents on this session
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionRequest.PdfSignatureOptions">
            <summary>
            PDF signature options to be applied to documents uploaded by user and to predefined documents not having PdfSignatureOptions specified
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionRequest.CmsSignatureOptions">
            <summary>
            CMS signature options to be applied to documents uploaded by user and to predefined documents not having CmsSignatureOptions specified
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionDocumentData.Id">
            <summary>
            ID of an existing document to be signed by another user. Specify either this property or `File`, but not both.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionDocumentData.File">
            <summary>
            New file to be signed. Specify either this property or `Id`, but not both.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionDocumentData.Metadata">
            <summary>
            Metadata to be added to the document
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionDocumentData.DocumentKey">
            <summary>
            Document key previously allocated. If omitted, a new document key will be generated.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionDocumentData.SignatureType">
            <summary>
            The signature type to be performed on the file. Ignored if signing an existing document. If omitted, the signature type
            will be inferred from the file type (PAdES for PDFs, XAdES for XMLs, CAdES for everything else).
            </summary>
        </member>
        <member name="F:Lacuna.RestPki.Api.SignatureSessions.CertificateRequirementTypes.CryptoDevice">
            <summary>
            Accept only certificates having a private key protected by a cryptographic device (for ICP-Brasil, this means A3/A4 certificates only). This requirement does not accept an argument.
            </summary>
        </member>
        <member name="F:Lacuna.RestPki.Api.SignatureSessions.CertificateRequirementTypes.Cpf">
            <summary>
            Accept only certificate with a given subject CPF (the CPF must be specified on the requirement argument)
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CertificateRequirement.Type">
            <summary>
            Type of the requirement. Depending on the type, an `Argument` must also be given.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CertificateRequirement.Argument">
            <summary>
            The argument for the requirement. Please refer to the `CertificateRequirementTypes` enum for the argument syntax for each requirement type.
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionResponse.SessionId">
            <summary>
            ID of the signature session created
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.CreateSignatureSessionResponse.RedirectUrl">
            <summary>
            URL to which the user must be redirected
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SessionCompletionStatus.Completed">
            <summary>
            Whether the background processing of the signature session has completed
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SessionCompletionStatus.Progress">
            <summary>
            Progress of the background processing, ranging from 0 to 100
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionDocumentSummary.Status">
            <summary>
            The status of the document on the specific signature session that was fetched
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionDocumentSummary.DateSigned">
            <summary>
            Date on which this document was signed on the specific signature session that was fetched
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionModel.ProcessingErrorCode">
            <summary>
            If `Status` is `ProcessingError`, this contains a 6-character code suitable for logging that can be useful to correlate the issue when
            asking for tech support
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionModel.CallbackArgument">
            <summary>
            The callback argument initially passed during creation of the session, containing any app-specific state of your choosing
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionModel.SignerCertificate">
            <summary>
            Information about the certificate used to sign the documents
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionModel.Documents">
            <summary>
            List of documents
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionSummary.Id">
            <summary>
            ID of the signature session
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionSummary.Status">
            <summary>
            Status of the signature session
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionSummary.SubscriptionId">
            <summary>
            Subscription used to create the signature session
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionSummary.DateCreated">
            <summary>
            Date and time when the signature session was created
            </summary>
        </member>
        <member name="P:Lacuna.RestPki.Api.SignatureSessions.SignatureSessionSummary.Duration">
            <summary>
            Time in milliseconds that the session took from the moment of creation until completion. If the session is still in progress, this
            property is null
            </summary>
        </member>
    </members>
</doc>
