FrameSDK/com.framepayments.framesdk.customeridentity/CustomerIdentityEndpoints

CustomerIdentityEndpoints

sealed class CustomerIdentityEndpoints : FrameNetworkingEndpoints

Defines the API endpoints used by customer identity verification operations.

Each case maps to a specific HTTP method and URL path used by CustomerIdentityAPI.

Inheritors

CreateCustomerIdentity

GetCustomerIdentityWith

CreateCustomerIdentityWith

SubmitForVerification

UploadIdentityDocuments

Types

CreateCustomerIdentity

object CreateCustomerIdentity : CustomerIdentityEndpoints

Endpoint for creating a new customer identity verification record.

CreateCustomerIdentityWith

data class CreateCustomerIdentityWith(val customerId: String) : CustomerIdentityEndpoints

Endpoint for creating a new identity verification record attached to an existing customer.

GetCustomerIdentityWith

data class GetCustomerIdentityWith(val customerIdentityId: String) : CustomerIdentityEndpoints

Endpoint for retrieving an existing customer identity verification record.

SubmitForVerification

data class SubmitForVerification(val customerIdentityId: String) : CustomerIdentityEndpoints

Endpoint for submitting an identity verification record for KYC processing.

UploadIdentityDocuments

data class UploadIdentityDocuments(val customerIdentityId: String) : CustomerIdentityEndpoints

Endpoint for uploading identity document files to a verification record.

Properties

additionalHeaders

open val additionalHeaders: Map<String, String>

Optional extra HTTP headers to attach to the request (e.g. Accept: application/json). Defaults to empty. Applied after the standard Frame Authorization/User-Agent headers but before Content-Type (set on POST/PATCH), so an entry may override the former but not the latter. Prefer supplemental headers like Accept; don't rely on this to set auth headers.

endpointURL

open override val endpointURL: String

The fully qualified URL string for this endpoint.

httpMethod

open override val httpMethod: String

HTTP method, e.g. "GET", "POST", "DELETE".

queryItems

open override val queryItems: List<QueryItem>? = null

Optional query-string parameters appended to endpointURL.