FrameSDK/com.framepayments.framesdk.customeridentity/CustomerIdentityAPI

CustomerIdentityAPI

object CustomerIdentityAPI

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

Each operation is available as both a coroutine suspend function and a callback-based overload. "Customer" refers to the merchant's end user whose identity is being verified.

Functions

Link copied to clipboard
suspend fun createCustomerIdentity(request: CustomerIdentityRequests.CreateCustomerIdentityRequest): Pair<CustomerIdentity?, NetworkingError?>

Creates a new customer identity verification record with the supplied PII.

fun createCustomerIdentity(request: CustomerIdentityRequests.CreateCustomerIdentityRequest, completionHandler: (CustomerIdentity?, NetworkingError?) -> Unit)

Creates a new customer identity verification record with the supplied PII and delivers the result to the provided callback.

Link copied to clipboard
suspend fun createCustomerIdentityWith(customerId: String): Pair<CustomerIdentity?, NetworkingError?>

Creates a new identity verification record attached to an existing customer.

fun createCustomerIdentityWith(customerId: String, completionHandler: (CustomerIdentity?, NetworkingError?) -> Unit)

Creates a new identity verification record attached to an existing customer and delivers the result to the provided callback.

Link copied to clipboard
suspend fun getCustomerIdentityWith(customerIdentityId: String): Pair<CustomerIdentity?, NetworkingError?>

Retrieves an existing customer identity verification record by its identifier.

fun getCustomerIdentityWith(customerIdentityId: String, completionHandler: (CustomerIdentity?, NetworkingError?) -> Unit)

Retrieves an existing customer identity verification record by its identifier and delivers the result to the provided callback.

Link copied to clipboard
suspend fun submitForVerification(customerIdentityId: String): Pair<CustomerIdentity?, NetworkingError?>

Submits an existing customer identity record for KYC/identity verification processing.

fun submitForVerification(customerIdentityId: String, completionHandler: (CustomerIdentity?, NetworkingError?) -> Unit)

Submits an existing customer identity record for KYC/identity verification processing and delivers the result to the provided callback.

Link copied to clipboard
suspend fun uploadIdentityDocuments(customerIdentityId: String, filesToUpload: List<FileUpload>): Pair<CustomerIdentity?, NetworkingError?>

Uploads identity document files for a customer identity record via a multipart request.

fun uploadIdentityDocuments(customerIdentityId: String, filesToUpload: List<FileUpload>, completionHandler: (CustomerIdentity?, NetworkingError?) -> Unit)

Uploads identity document files for a customer identity record via a multipart request and delivers the result to the provided callback.