ComingSoonResponse
serviceName of the service
statusCurrent status of the service
availableDateExpected availability date
descriptionDetailed description of what the service does
featuresKey features that will be available
contactEmailContact email for more information or early access
notifyUrlURL to sign up for launch notifications
documentationUrlLink to documentation about the upcoming service
LivenessVerificationResult
session_idUnique session identifier for this liveness verification
statusStatus of the liveness verification
confidenceConfidence score of liveness detection (0-100, where 100 is highest confidence)
is_liveBoolean indicating if the person is determined to be live (not a spoof)
reference_imageBase64-encoded reference image captured during liveness check
audit_imagesArray of base64-encoded audit images captured during the liveness check process
created_atISO-8601 timestamp when the session was created
messageHuman-readable message about the verification result
CombinedVerificationResult
Result of AWS Rekognition face liveness verification with confidence score and audit images
Result of AWS Rekognition face comparison between two images with similarity score and quality metrics
overallSuccessmessageFaceMatchResult
similaritySimilarity score between the two faces (0-100, where 100 is identical)
is_matchBoolean indicating if the faces match based on the threshold
confidenceConfidence score for the face comparison (typically same as similarity)
thresholdThreshold used to determine if faces match (default: 80.0)
Quality metrics for the source image (first image compared)
Quality metrics for the target image (second image compared)
messageHuman-readable message about the face match result
ImageQuality
brightnessBrightness level of the image (0-100)
sharpnessSharpness level of the image (0-100)
LivenessSessionRequest
client_session_idOptional client-provided session identifier for tracking
Optional settings for the liveness session
LivenessSettings
S3 output configuration for storing audit images
audit_images_limitMaximum number of audit images to capture (0-4)
LivenessSessionResponse
session_idUnique session identifier to use for liveness verification
statusCurrent status of the liveness session
created_atISO-8601 timestamp when the session was created
expires_atISO-8601 timestamp when the session will expire (typically 15 minutes after creation)
FaceComparisonRequest
sourceImagetargetImageDocumentMetadata
isMergedIndicates if this document result was created by merging multiple files (e.g., front and back of ID card)
sourceFilesList of original filenames that were merged to create this document result
mergeReasonExplanation of why files were merged (e.g., 'Front and back sides of the same identity document')
DocumentResult
fileNameOriginal filename of the uploaded document
categoryHigh-level category classification of the document
typeSpecific document type identification
confidenceAI confidence score for the classification and extraction (0.0 to 1.0, where 1.0 is highest confidence)
Extracted data fields from the document. Structure varies by document type:
Identity Documents:
- id_number, full_name, date_of_birth, gender, place_of_birth, expiry_date, nationality, etc.
Address Documents:
- account_number, full_name, address, street, city, postal_code, billing_date, provider, etc.
Income Documents:
- employee_name, employer, employee_id, gross_pay, net_pay, tax_deducted, pay_period, etc.
Entity Documents:
- company_name, registration_number, registration_date, company_type, directors, address, etc.
Compliance Documents:
- tin_number, company_name, issue_date, expiry_date, tax_status, etc.
processingTimeMsTime taken to process this specific document in milliseconds
Optional metadata about document processing, such as merge information when multiple files were combined
Processing
modeProcessing mode used: SINGLE_PASS for single files, BATCH for multiple files
providerAI provider and model used for verification
tokensUsedTotal number of AI tokens consumed (if available)
cachedTokensNumber of cached tokens used for optimization (if available)
Summary
totalDocumentsTotal number of logical documents identified (may differ from files due to merging)
totalFilesTotal number of physical files uploaded
categoriesList of unique document categories found
documentTypesList of specific document types identified
averageConfidenceAverage confidence score across all documents (0.0 to 1.0)
totalProcessingTimeMsTotal processing time for all documents in milliseconds
Breakdown of documents by category
VerificationResponse
requestIdUnique identifier for this verification request
timestampISO-8601 formatted timestamp when the verification was processed
verificationTypeThe type of verification that was performed
statusOverall status of the verification request
Array of individual document verification results
Aggregate statistics across all processed documents
Technical metadata about how the verification was processed
ErrorResponse
typeURI reference that identifies the problem type
titleShort, human-readable summary of the problem type
statusHTTP status code
detailHuman-readable explanation specific to this occurrence of the problem
instanceURI reference that identifies the specific occurrence of the problem
timestampISO-8601 timestamp when the error occurred
requestIdUnique request identifier for tracking and debugging
Array of field-level validation errors (if applicable)