Index (ID Analyzer API v2 SDK 1.0.2 API)

A B C D E G I L M O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

aamvaBarcodeParsing(boolean) - Method in class com.idanalyzer.Profile: Enable or disable parsing of AAMVA barcodes (US/Canada driver licenses).
account - Variable in class com.idanalyzer.IDAnalyzerClient: Account information service.
Account - Class in com.idanalyzer: Account information (GET /myaccount).
aml - Variable in class com.idanalyzer.IDAnalyzerClient: AML / PEP / sanctions screening service.
AML - Class in com.idanalyzer: AML / PEP / sanctions screening (POST /aml, /amlv3).
ApiException - Exception in com.idanalyzer: Thrown when the ID Analyzer API returns an error, or a transport error occurs.
ApiException(String, String) - Constructor for exception com.idanalyzer.ApiException: Creates an exception with an error message and code.
ApiException(String, String, Throwable) - Constructor for exception com.idanalyzer.ApiException: Creates an exception with an error message, code and underlying cause.
autoCrop(boolean, boolean) - Method in class com.idanalyzer.Profile: Configure automatic cropping of the document from the image.

B

biometric - Variable in class com.idanalyzer.IDAnalyzerClient: Biometric face & liveness verification service.
Biometric - Class in com.idanalyzer: Biometric face & liveness verification (POST /face, /liveness).

C

canvasSize(int) - Method in class com.idanalyzer.Profile: Set the working canvas size, in pixels, used during image processing.
com.idanalyzer - package com.idanalyzer
contract - Variable in class com.idanalyzer.IDAnalyzerClient: Contract generation & template management service.
Contract - Class in com.idanalyzer: Contract generation & template management (/generate, /contract).
contractFormat - Variable in class com.idanalyzer.Docupass.CreateRequest: Output format for generated contracts; defaults to "pdf".
contractGenerate - Variable in class com.idanalyzer.Docupass.CreateRequest: Contract template id to generate, if any.
contractPrefill - Variable in class com.idanalyzer.Docupass.CreateRequest: Pre-fill data for the generated/signed contract, if any.
contractSign - Variable in class com.idanalyzer.Docupass.CreateRequest: Contract template id to have the user sign, if any.
createdAtMax - Variable in class com.idanalyzer.Transaction.ListOptions: Upper bound (inclusive) on creation time; only applied when greater than 0.
createdAtMin - Variable in class com.idanalyzer.Transaction.ListOptions: Lower bound (inclusive) on creation time; only applied when greater than 0.
createDocupass(Docupass.CreateRequest) - Method in class com.idanalyzer.Docupass: Create a Docupass link (POST /docupass).
createProfile(String, Profile) - Method in class com.idanalyzer.ProfileApi: Create a KYC profile (POST /profile).
CreateRequest() - Constructor for class com.idanalyzer.Docupass.CreateRequest: Creates an empty request whose fields are populated directly before use.
createTemplate(String, String, String, String, String) - Method in class com.idanalyzer.Contract: Create a contract template (POST /contract).
customData - Variable in class com.idanalyzer.Docupass.CreateRequest: Arbitrary string stored with the resulting transaction.
customData - Variable in class com.idanalyzer.Transaction.ListOptions: Filter by the custom data stored with the transaction; applied when non-empty.

D

decision - Variable in class com.idanalyzer.Transaction.ListOptions: Filter by decision ("accept"/"review"/"reject"); applied when non-empty.
decisionTrigger(double, double) - Method in class com.idanalyzer.Profile: Set the overall decision-trigger scores that move a transaction to review or reject.
deleteDocupass(String) - Method in class com.idanalyzer.Docupass: Delete a Docupass (DELETE /docupass/{reference}).
deleteProfile(String) - Method in class com.idanalyzer.ProfileApi: Delete a KYC profile (DELETE /profile/{id}).
deleteTemplate(String) - Method in class com.idanalyzer.Contract: Delete a contract template (DELETE /contract/{id}).
deleteTransaction(String) - Method in class com.idanalyzer.Transaction: Delete a transaction (DELETE /transaction/{id}).
deleteWebhook(String) - Method in class com.idanalyzer.Webhook: Delete a webhook delivery log (DELETE /webhook/{id}).
docupass - Variable in class com.idanalyzer.IDAnalyzerClient: DocuPass remote verification & e-signature link management service.
docupass - Variable in class com.idanalyzer.Transaction.ListOptions: Filter by associated Docupass reference; applied when non-empty.
Docupass - Class in com.idanalyzer: DocuPass remote verification & e-signature link management (/docupass).
Docupass.CreateRequest - Class in com.idanalyzer: Parameters for creating a Docupass link.

E

exportProfile(String) - Method in class com.idanalyzer.ProfileApi: Export a KYC profile (GET /export/profile/{id}).
exportTransaction(String, String, List<String>, boolean, boolean, Transaction.ListOptions) - Method in class com.idanalyzer.Transaction: Request a transaction archive and download it to dest (POST /export/transaction).

G

generate(String, String, String, Map<String, Object>) - Method in class com.idanalyzer.Contract: Generate a document from a template (POST /generate).
getAccount() - Method in class com.idanalyzer.Account: Retrieve the current account profile, quota and usage.
getCode() - Method in exception com.idanalyzer.ApiException: The API error code (or "TRANSPORT" for network/transport errors).
getDocupass(String) - Method in class com.idanalyzer.Docupass: Retrieve a single Docupass (GET /docupass/{reference}).
getOverride() - Method in class com.idanalyzer.Profile: Returns the accumulated profileOverride map of settings applied to this profile.
getProfile(String) - Method in class com.idanalyzer.ProfileApi: Retrieve a KYC profile (GET /profile/{id}).
getProfileId() - Method in class com.idanalyzer.Profile: Returns the profile id this profile was created with.
getTemplate(String) - Method in class com.idanalyzer.Contract: Get a contract template (GET /contract/{id}).
getTransaction(String) - Method in class com.idanalyzer.Transaction: Retrieve a single transaction (GET /transaction/{id}).

I

IDAnalyzerClient - Class in com.idanalyzer: Client for the ID Analyzer API v2.
IDAnalyzerClient(String) - Constructor for class com.idanalyzer.IDAnalyzerClient: Creates a client; region is read from IDANALYZER_REGION (default "us").
IDAnalyzerClient(String, String) - Constructor for class com.idanalyzer.IDAnalyzerClient: Creates a client for an explicit region.
inferFullName(boolean) - Method in class com.idanalyzer.Profile: Enable or disable inferring the full name from name components.
InvalidArgumentException - Exception in com.idanalyzer: Thrown when an invalid client-side argument is supplied to the SDK.
InvalidArgumentException(String) - Constructor for exception com.idanalyzer.InvalidArgumentException: Creates an exception describing the invalid argument.

L

language - Variable in class com.idanalyzer.Docupass.CreateRequest: UI language for the verification flow.
limit - Variable in class com.idanalyzer.Transaction.ListOptions: Maximum number of transactions to return.
listDocupass(int, int, int) - Method in class com.idanalyzer.Docupass: List Docupass records (GET /docupass).
ListOptions() - Constructor for class com.idanalyzer.Transaction.ListOptions: Creates an options object with default values that can be overridden before use.
listProfile(int, int, int) - Method in class com.idanalyzer.ProfileApi: List KYC profiles (GET /profile).
listTemplate(int, int, int, String) - Method in class com.idanalyzer.Contract: List contract templates (GET /contract).
listTransaction(Transaction.ListOptions) - Method in class com.idanalyzer.Transaction: Retrieve transaction history (GET /transaction).
listWebhook(int, int, int, String, int, String, String) - Method in class com.idanalyzer.Webhook: List webhook delivery logs (GET /webhook).
loadFromJson(Map<String, Object>) - Method in class com.idanalyzer.Profile: Bulk-load override settings from a map (e.g.

M

mode - Variable in class com.idanalyzer.Docupass.CreateRequest: Verification mode: 0=Document+Face, 1=Document, 2=Face, 3=e-Signature.

O

objectDetection(boolean) - Method in class com.idanalyzer.Profile: Enable or disable object detection on the document image.
obscure(List<String>) - Method in class com.idanalyzer.Profile: Obscure (redact) the given result field keys in the output.
offset - Variable in class com.idanalyzer.Transaction.ListOptions: Number of transactions to skip (for pagination).
order - Variable in class com.idanalyzer.Transaction.ListOptions: Sort order for the results.
orientationCorrection(boolean) - Method in class com.idanalyzer.Profile: Enable or disable automatic orientation correction of input images.
outputImage(boolean, String) - Method in class com.idanalyzer.Profile: Configure whether a processed output image is returned, and its format.
outputSize(int) - Method in class com.idanalyzer.Profile: Set the maximum output image size, in pixels.

P

parseInput(String, boolean) - Static method in class com.idanalyzer.IDAnalyzerClient: Accepts a file path, base64 string, URL, or (when allowCache) a "ref:" cache reference, and returns the value to send to the API.
profile - Variable in class com.idanalyzer.Docupass.CreateRequest: KYC profile ID (required).
profile - Variable in class com.idanalyzer.IDAnalyzerClient: Server-side KYC profile management service.
Profile - Class in com.idanalyzer: Builds a KYC profile / profileOverride object that can be attached to scan, biometric and docupass calls, or used to create/update a stored profile via ProfileApi.
Profile(String) - Constructor for class com.idanalyzer.Profile: Creates a Profile.
ProfileApi - Class in com.idanalyzer: Server-side KYC profile management (/profile, /export/profile).
profileId - Variable in class com.idanalyzer.Transaction.ListOptions: Filter by KYC profile id; applied when non-empty.

Q

quickScan(String, String, boolean) - Method in class com.idanalyzer.Scanner: Quick OCR-only scan.

R

referenceDocument - Variable in class com.idanalyzer.Docupass.CreateRequest: Reference document image to match against.
referenceDocumentBack - Variable in class com.idanalyzer.Docupass.CreateRequest: Reference document back image to match against.
referenceFace - Variable in class com.idanalyzer.Docupass.CreateRequest: Reference face image to match against.
resendWebhook(String) - Method in class com.idanalyzer.Webhook: Resend a webhook delivery (POST /webhook/{id}).
restrictCountry(String) - Method in class com.idanalyzer.Scanner: Restrict accepted documents to the given issuing country code(s).
restrictDocumentCountry(String) - Method in class com.idanalyzer.Profile: Restrict accepted documents to the given issuing country code(s).
restrictDocumentState(String) - Method in class com.idanalyzer.Profile: Restrict accepted documents to the given issuing state(s)/province(s).
restrictDocumentType(String) - Method in class com.idanalyzer.Profile: Restrict accepted documents to the given document type(s).
restrictState(String) - Method in class com.idanalyzer.Scanner: Restrict accepted documents to the given issuing state(s)/province(s).
restrictType(String) - Method in class com.idanalyzer.Scanner: Restrict accepted documents to the given document type(s).
reusable - Variable in class com.idanalyzer.Docupass.CreateRequest: Whether the link can be reused by multiple users.

S

saveFile(String, String) - Method in class com.idanalyzer.Transaction: Download a vault file to dest (GET /filevault/{name}).
saveImage(String, String) - Method in class com.idanalyzer.Transaction: Download a vault image to dest (GET /imagevault/{token}).
saveResult(boolean, boolean) - Method in class com.idanalyzer.Profile: Configure whether the transaction and its images are saved.
scan(String, String, String, String) - Method in class com.idanalyzer.Scanner: Initiate a full identity document scan & optional biometric verification.
scanner - Variable in class com.idanalyzer.IDAnalyzerClient: Document scanning & ID verification service.
Scanner - Class in com.idanalyzer: Document scanning & ID verification (POST /scan, /quickscan, /veryquickscan).
search(String, String, int, String, List<String>, String) - Method in class com.idanalyzer.AML: Screen against the AML database (v1 endpoint).
searchV3(String, String, int, int) - Method in class com.idanalyzer.AML: Screen against the AML v3 database (POST /amlv3).
SECURITY_HIGH - Static variable in class com.idanalyzer.Profile: Built-in profile preset that applies a high level of security checks.
SECURITY_LOW - Static variable in class com.idanalyzer.Profile: Built-in profile preset that applies a low level of security checks.
SECURITY_MEDIUM - Static variable in class com.idanalyzer.Profile: Built-in profile preset that applies a medium level of security checks.
SECURITY_NONE - Static variable in class com.idanalyzer.Profile: Built-in profile preset that applies no security checks.
setBaseUrl(String) - Method in class com.idanalyzer.IDAnalyzerClient: Override the API base URL entirely (e.g.
setContractOptions(String, String, Map<String, Object>) - Method in class com.idanalyzer.Scanner: Auto-generate one or more contracts from the parsed ID.
setCustomData(String) - Method in class com.idanalyzer.Biometric: Attach an arbitrary string to be stored with the transaction (e.g.
setCustomData(String) - Method in class com.idanalyzer.Scanner: Arbitrary string stored with the transaction (e.g.
setProfile(Profile) - Method in class com.idanalyzer.Biometric: Attach a KYC profile (required before Biometric.verifyFace(java.lang.String, java.lang.String, java.lang.String) / Biometric.verifyLiveness(java.lang.String, java.lang.String)).
setProfile(Profile) - Method in class com.idanalyzer.Scanner: Attach a KYC profile (required before Scanner.scan(java.lang.String, java.lang.String, java.lang.String, java.lang.String)).
setTimezone(String) - Method in class com.idanalyzer.Profile: Set the timezone used for date/time fields in the transaction.
setUserIp(String) - Method in class com.idanalyzer.Scanner: Pass a user IP for issuer-country geolocation check (use "user" for the connection IP).
setWarning(String, boolean, double, double, double) - Method in class com.idanalyzer.Profile: Configure how a specific warning code influences the decision.
splitFirstName(boolean) - Method in class com.idanalyzer.Profile: Enable or disable splitting the first name into separate name fields.

T

threshold(String, double) - Method in class com.idanalyzer.Profile: Set an individual decision threshold value.
transaction - Variable in class com.idanalyzer.IDAnalyzerClient: Transaction history, decisions, vault assets and export service.
Transaction - Class in com.idanalyzer: Transaction history, decisions, vault assets and export (/transaction, /imagevault, /filevault, /export).
Transaction.ListOptions - Class in com.idanalyzer: Filters for listing/exporting transactions.
transactionAuditReport(boolean) - Method in class com.idanalyzer.Profile: Enable or disable generation of a transaction audit report.

U

updateProfile(String, String, Profile) - Method in class com.idanalyzer.ProfileApi: Update a KYC profile (PUT /profile/{id}).
updateTemplate(String, String, String, String, String, String) - Method in class com.idanalyzer.Contract: Update a contract template (POST /contract/{id}).
updateTransaction(String, String) - Method in class com.idanalyzer.Transaction: Update a transaction decision (PATCH /transaction/{id}).
userPhone - Variable in class com.idanalyzer.Docupass.CreateRequest: User phone number for the verification flow.

V

verifyAddress - Variable in class com.idanalyzer.Docupass.CreateRequest: Expected address to verify against the document.
verifyAge - Variable in class com.idanalyzer.Docupass.CreateRequest: Expected age range to verify against the document.
verifyDOB - Variable in class com.idanalyzer.Docupass.CreateRequest: Expected date of birth to verify (docupass uses the upper-case "verifyDOB" field).
verifyDocumentNumber - Variable in class com.idanalyzer.Docupass.CreateRequest: Expected document number to verify.
verifyFace(String, String, String) - Method in class com.idanalyzer.Biometric: Perform 1:1 face verification against a reference image.
verifyLiveness(String, String) - Method in class com.idanalyzer.Biometric: Perform a standalone liveness check on a selfie photo or video.
verifyName - Variable in class com.idanalyzer.Docupass.CreateRequest: Expected name to verify against the document.
verifyPostcode - Variable in class com.idanalyzer.Docupass.CreateRequest: Expected postcode to verify against the document.
verifyUserInformation(String, String, String, String, String, String) - Method in class com.idanalyzer.Scanner: Supply expected customer information to match against the document.
veryQuickScan(String, String, boolean) - Method in class com.idanalyzer.Scanner: Very fast OCR-only scan.

W

webhook - Variable in class com.idanalyzer.IDAnalyzerClient: Webhook delivery log management service.
webhook(String) - Method in class com.idanalyzer.Profile: Set the webhook URL that result notifications are posted to.
Webhook - Class in com.idanalyzer: Webhook delivery log management (/webhook).

A B C D E G I L M O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form