FrameSDK/com.framepayments.framesdk.customeridentity/CustomerIdentity

CustomerIdentity

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.

Constructors

CustomerIdentity

constructor(id: String?, status: CustomerIdentityStatus?, created: Int?, updated: Int?, pending: Int?, verified: Int?, failed: Int?, verificationURL: String?, identityObject: String?, documents: IdentificationDocuments?, provider: String?, providerReference: String?, extractedData: IdentificationData?, verificationChecks: VerificationChecks?, customer: FrameObjects.Customer?)

Properties

val created: Int?

Unix timestamp (seconds) indicating when the record was created.

val customer: FrameObjects.Customer?

The Frame customer object associated with this identity record, if linked.

val documents: IdentificationDocuments?

The attachment status of the customer's identity document files.

@SerializedName(value = "extracted_data")

val extractedData: IdentificationData?

Personal data extracted from the customer's identity document by the provider.

val failed: Int?

Unix timestamp (seconds) indicating when the record entered the failed state, if applicable.

val id: String?

The unique identifier for this identity verification record.

@SerializedName(value = "object")

val identityObject: String?

The API object type identifier for this resource.

val pending: Int?

Unix timestamp (seconds) indicating when the record entered the pending state.

val provider: String?

The identity verification provider used to process this record.

providerReference

@SerializedName(value = "provider_reference")

val providerReference: String?

The external reference identifier assigned by the verification provider.

val status: CustomerIdentityStatus?

The current overall status of the identity verification.

val updated: Int?

Unix timestamp (seconds) indicating when the record was last updated.

verificationChecks

@SerializedName(value = "verification_checks")

val verificationChecks: VerificationChecks?

The results of automated checks performed on the identity document.

verificationURL

@SerializedName(value = "verification_url")

val verificationURL: String?

A URL the customer can visit to complete the identity verification flow.

val verified: Int?

Unix timestamp (seconds) indicating when the record was verified, if applicable.