# Lean Disposable Services REST API for enrolling and managing lean disposable certificates for secure digital signatures. Authenticate every request with Basic Auth credentials and a client SSL certificate (mTLS). All requests require the `Content-Type: application/json` header. For the full integration guide, see the [Lean Disposable documentation](https://docs.namirial.app/products/leandisposable/homepage). Version: 26.1.0.3 ## Servers Production environment ``` https://lean.namirialtsp.com/RAWS_DISPOSABLE ``` Development and testing environment ``` https://lean.test.namirialtsp.com/RAWS_DISPOSABLE ``` ## Security ### basicAuth HTTP Basic Authentication using account credentials. **Format**: `Authorization: Basic base64(username:password)` See [Authentication documentation](https://docs.namirial.app/products/leandisposable/enterprise-documentation/developer-documentation/authentication) for details. Type: http Scheme: basic ### sslCertificate Mutual TLS (mTLS) authentication using the client SSL certificate provided by Namirial. The certificate must be presented at the TLS handshake level. See [Authentication documentation](https://docs.namirial.app/products/leandisposable/enterprise-documentation/developer-documentation/authentication) for details. Type: mutualTLS ## Download OpenAPI description [Lean Disposable Services](https://docs.namirial.app/_bundle/products/leandisposable/openapi.yaml) ## Certificate Methods to validate holder data, enroll disposable certificates, and send OTP codes. ### Send OTP - [POST /api/certificate/sendOtp](https://docs.namirial.app/products/leandisposable/openapi/certificate/sendotp.md): Sends an OTP code to the holder via SMS or email. Use certIdOtp and deviceCode returned by enroll. See sendOtp. ### Validate certificate data - [POST /api/certificate/validate](https://docs.namirial.app/products/leandisposable/openapi/certificate/validatecertificate.md): Validates the OTP code entered by the holder. See validate. ### Check holder data - [POST /api/certificate/{lraId}/checkData](https://docs.namirial.app/products/leandisposable/openapi/certificate/checkdata.md): Validates holder data, document and certificate parameters before enrolling. Optional step — use it to detect validation errors before calling enroll. See checkData. ### Check holder data with eID assertion - [POST /api/certificate/{lraId}/checkDataWitheIDAssertion](https://docs.namirial.app/products/leandisposable/openapi/certificate/checkdatawitheidassertion.md): Validates holder data using an eID assertion before enrolling. Checks: mandatory fields, allowed values, LRA authorization for the eID type. See checkDataWitheIDAssertion and How to enroll with eID assertion. ### Enroll disposable certificate - [POST /api/certificate/{lraId}/enroll](https://docs.namirial.app/products/leandisposable/openapi/certificate/enroll.md): Enrolls a disposable certificate for the holder. Returns certIdOtp and deviceCode required by sendOtp and validate. See enroll. ### Enroll disposable certificate with eID assertion - [POST /api/certificate/{lraId}/enrollDisposableWitheIDAssertion](https://docs.namirial.app/products/leandisposable/openapi/certificate/enrolldisposablewitheidassertion.md): Enrolls a disposable certificate using an eID assertion. Returns certificate details and OTP identifier (if otpType=SMS or otpType=EMAIL). See enrollDisposableWitheIDAssertion and How to enroll with eID assertion. ## Document Methods to retrieve disposable contracts and upload documents related to the issued certificate. ### Get AWS parameters - [GET /api/document/{lraId}/getAwsParameter](https://docs.namirial.app/products/leandisposable/openapi/document/getawsparameter.md): Retrieves AWS credentials for the specified LRA and service. Used when a video identification process stores evidence on AWS. See getAwsParameter. ### Get disposable contract - [POST /api/document/{lraId}/getDisposableContract](https://docs.namirial.app/products/leandisposable/openapi/document/getdisposablecontract.md): Returns the disposable contract (Mod_NAMCA22D), the privacy document URL, and the T&C document URL for the specified LRA. The contract is pre-filled with holder data if disposableHolder, disposableContacts and disposableDoc are all provided. If omitted, the contract is returned blank. See getDisposableContract. ### Get disposable contract with eID assertion - [POST /api/document/{lraId}/getDisposableContractWitheIDAssertion](https://docs.namirial.app/products/leandisposable/openapi/document/getdisposablecontractwitheidassertion.md): Retrieves disposable contract documents (Mod_NAMCA22D) using an eID assertion. Returns contract PDF/TXT, privacy document URL (Mod_NAMGDPR03D), and T&C document URL (Mod_NAMCA01D). The contract is pre-filled if eIDAssertionHolder and contacts are provided. See getDisposableContractWitheIDAssertion and How to enroll with eID assertion. ### Upload AWS document ID - [POST /api/document/{lraId}/uploadAwsId](https://docs.namirial.app/products/leandisposable/openapi/document/uploadawsid.md): Associates an AWS identification reference to an issued disposable certificate. Used when a video identification process stores evidence on AWS. See uploadAwsId. ### Upload document - [POST /api/document/{lraId}/uploadDoc](https://docs.namirial.app/products/leandisposable/openapi/document/uploaddoc.md): Stores a document linked to an issued disposable certificate. Supported document types: identification evidence, signed contracts (e.g. CA22D), audit logs, identity assertions. Note: if the disposable was issued with enrollDisposableWitheIDAssertion, the assertion is stored automatically — do not upload it with this method. See uploadDoc. ## Utility Methods to verify service status and retrieve error information. ### Get error list - [GET /api/utility/errors](https://docs.namirial.app/products/leandisposable/openapi/utility/geterrors.md): Returns the human-readable description of an error code in the requested language. Note: requires Content-Type: application/json header. See getErrors. ### Verify Lean service status - [GET /api/utility/verifyLeanStatus](https://docs.namirial.app/products/leandisposable/openapi/utility/verifyleanstatus.md): Returns HTTP 200 if the Lean Disposable service is operational. Use this endpoint to monitor service availability. If the service is completely unavailable, this endpoint will return 503 Service Unavailable — implement appropriate error handling for this case. ### Verify web service status - [GET /api/utility/verifyStatusWs](https://docs.namirial.app/products/leandisposable/openapi/utility/verifystatusws.md): Returns HTTP 200 if the Lean Disposable web service (WS) is operational. Use this endpoint to monitor web service availability. If the service is completely unavailable, this endpoint will return 503 Service Unavailable — implement appropriate error handling for this case. ### Get LRA capabilities - [GET /api/utility/{lraId}/capabilities](https://docs.namirial.app/products/leandisposable/openapi/utility/getlracapabilities.md): Retrieves the configuration of a LRA: allowed OTP types, identification types, eID methods, certificate types, contract templates, and One Platform info. See getLraCapabilities.