Application
Table of Contents
Classes
- MyAccount
- Request for the My Account endpoint (`GET /myaccount`).
- AMLSearch
- Request for the AML Search endpoint (`POST /aml`).
- AMLV3Search
- Request for the AML v3 Search endpoint (`POST /amlv3`).
- FaceVerification
- Request for the Face Verification endpoint (`POST /face`).
- LivenessVerification
- Request for the Liveness Verification endpoint (`POST /liveness`).
- CreateTemplate
- Request for the Create Contract Template endpoint (`POST /contract`).
- EdTemplate
- Request for the Edit Contract Template endpoint (`POST /contract/{templateId}`).
- GenerateContract
- Request for the Generate Contract endpoint (`POST /generate`).
- LsTemplate
- Request for the List Contract Templates endpoint (`GET /contract`).
- RmTemplate
- Request for the Delete Contract Template endpoint (`DELETE /contract/{templateId}`).
- TemplateDetail
- Request for the Contract Template Detail endpoint (`GET /contract/{templateId}`).
- CreateDocupass
- Request for the Create Docupass endpoint (`POST /docupass`).
- DocupassDetail
- Request for the Docupass Detail endpoint (`GET /docupass/{reference}`).
- LsDocupass
- Request for the List Docupass endpoint (`GET /docupass`).
- RmDocupass
- Request for the Delete Docupass endpoint (`DELETE /docupass/{reference}`).
- CreateProfile
- Request for the Create KYC Profile endpoint (`POST /profile`).
- EdProfile
- Request for the Edit KYC Profile endpoint (`PUT /profile/{profileId}`).
- ExportProfile
- Request for the Export KYC Profile endpoint (`GET /export/profile/{profileId}`).
- LsProfile
- Request for the List KYC Profiles endpoint (`GET /profile`).
- ProfileDetail
- Request for the KYC Profile Detail endpoint (`GET /profile/{profileId}`).
- RmProfile
- Request for the Delete KYC Profile endpoint (`DELETE /profile/{profileId}`).
- QuickScan
- Request for the Quick Scan endpoint (`POST /quickscan`).
- StandardScan
- Request for the Standard Scan endpoint (`POST /scan`).
- VeryQuickScan
- Request for the Very Quick Scan endpoint (`POST /veryquickscan`).
- EdTransaction
- Request for the Edit Transaction endpoint (`PATCH /transaction/{transactionId}`).
- ExportTransaction
- Request for the Export Transaction endpoint (`POST /export/transaction`).
- LsTransaction
- Request for the List Transactions endpoint (`GET /transaction`).
- OutputFile
- Request for the Output File endpoint (`GET /filevault/{fileName}`).
- OutputImage
- Request for the Output Image endpoint (`GET /imagevault/{imageToken}`).
- RmTransaction
- Request for the Delete Transaction endpoint (`DELETE /transaction/{transactionId}`).
- TransactionDetail
- Request for the Transaction Detail endpoint (`GET /transaction/{transactionId}`).
- LsWebhook
- Request for the List Webhook Logs endpoint (`GET /webhook`).
- ResendWebhook
- Request for the Resend Webhook endpoint (`POST /webhook/{webhookId}`).
- RmWebhook
- Request for the Delete Webhook Log endpoint (`DELETE /webhook/{webhookId}`).
- ApiBase
- Base class for every API request object.
- ApiError
- Represents an error returned by the ID Analyzer API.
- Client
- HTTP client for the ID Analyzer v2 API.
- SDKException
- Exception thrown by the SDK for client-side and response-handling errors
(e.g. invalid configuration, missing required fields, or unparseable responses).
Traits
- RequestPayload
- Provides field registration, magic accessors, validation and serialization
for API request objects.