Package-level declarations

Types

Link copied to clipboard
data class CustomerIdentity(val id: String?, val status: CustomerIdentityStatus?, val created: Int?, val updated: Int?, val pending: Int?, val verified: Int?, val failed: Int?, val verificationURL: String?, val identityObject: String?, val documents: IdentificationDocuments?, val provider: String?, val providerReference: String?, val extractedData: IdentificationData?, val verificationChecks: VerificationChecks?, val customer: FrameObjects.Customer?)

Represents a customer identity verification record returned by the Frame API.

Link copied to clipboard

Provides API operations for creating, retrieving, and verifying customer identity records.

Link copied to clipboard

Defines the API endpoints used by customer identity verification operations.

Link copied to clipboard

Contains request model types used by customer identity API operations.

Link copied to clipboard

Represents the overall verification state of a customer identity record.

Link copied to clipboard
data class IdentificationData(val firstName: String?, val lastName: String?, val middleName: String?, val dateOfBirth: String?, val licenseNumber: String?, val state: String?, val expirationDate: String?, val address: String?)

Contains personal data extracted from the customer's identity document during verification.

Link copied to clipboard
data class IdentificationDocuments(val frontDocumentAttached: Boolean?, val backDocumentAttached: Boolean?, val selfieAttached: Boolean?)

Tracks which identity document files have been attached to a customer identity record.

Link copied to clipboard
data class VerificationChecks(val idPhotoFaceMatch: VerificationCheckStatus?, val idAgeOver18: VerificationCheckStatus?, val idNotExpired: VerificationCheckStatus?, val idTamperDetection: VerificationCheckStatus?)

Holds the results of individual automated checks performed on the customer's identity document.

Link copied to clipboard

Represents the outcome of an individual verification check performed on an identity document.