FieldStatus

Verification status of individual KYC fields in SEP-12.

Indicates the current state of each provided field during the KYC process. Allows anchors to communicate field-level verification status and requirements.

Status meanings:

Use cases:

  • Email verification: Status is VERIFICATION_REQUIRED until code is submitted

  • Phone verification: Status is VERIFICATION_REQUIRED until SMS code is provided

  • Document review: Status is PROCESSING while being reviewed, then ACCEPTED or REJECTED

  • Field corrections: Status is REJECTED with error message indicating what's wrong

Example - Check field status:

val response = kycService.getCustomerInfo(request)

response.providedFields?.forEach { (fieldName, fieldInfo) ->
when (fieldInfo.status) {
FieldStatus.ACCEPTED -> {
println("$fieldName: Verified")
}
FieldStatus.PROCESSING -> {
println("$fieldName: Under review")
}
FieldStatus.REJECTED -> {
println("$fieldName: Rejected - ${fieldInfo.error}")
}
FieldStatus.VERIFICATION_REQUIRED -> {
println("$fieldName: Verification code required")
}
null -> {
println("$fieldName: Status not provided")
}
}
}

Example - Handle email verification:

val emailField = response.providedFields?.get("email_address")
if (emailField?.status == FieldStatus.VERIFICATION_REQUIRED) {
// User receives email with code
val verifyRequest = PutCustomerInfoRequest(
jwt = authToken,
verificationFields = mapOf(
"email_address_verification" to "123456"
)
)
kycService.putCustomerInfo(verifyRequest)
}

See also:

Entries

Link copied to clipboard

Field has been verified and accepted.

Link copied to clipboard

Field is being reviewed.

Link copied to clipboard

Field was rejected.

Link copied to clipboard

Field requires additional verification.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
expect val name: String
Link copied to clipboard
expect val ordinal: Int

Functions

Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.