Skip to main content
POST
Initiate KYC

Overview

Cardholders are created with kycStatus: WAIVED by default, allowing them to issue cards immediately. This endpoint upgrades a cardholder to full KYC verification — transitioning them to PENDING and submitting their data to the verification provider asynchronously. Use this when your compliance requirements demand verified identity before a cardholder can transact above certain limits, or when prompted by the card program’s terms.

When to Call This

  • The cardholder’s kycStatus is WAIVED or PENDING (not yet approved)
  • You want to move the cardholder toward APPROVED status for higher transaction limits

Request Body

All fields are optional. If you have already submitted kycDocument data during cardholder creation or a prior KYC attempt, you do not need to resend it. The shape of kycDocument is flexible and passed through to the verification provider. Common fields:

Example

Success Response (201)

What Happens Next

The KYC submission is processed asynchronously:
  1. The cardholder’s kycStatus is set to PENDING immediately.
  2. The submitted data is forwarded to the card provider for identity verification.
  3. Once the provider responds, a webhook is dispatched:
Cardholders with kycStatus: WAIVED can already issue cards. KYC approval is only required if your program mandates it for higher transaction limits.

Error Codes

Authorizations

Authorization
string
header
required

API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.

Path Parameters

id
string
required

Cardholder ID

Body

application/json
kycDocument
object

Structured KYC data forwarded to the verification provider. All sub-fields are optional.

Response

KYC initiated — cardholder kycStatus is now PENDING

success
boolean
Example:

true

status
integer
Example:

200

message
string
Example:

"Cardholder retrieved"

data
object
meta
object