KYC (Know Your Customer) status management for embedded banking customers.

KYC states

• "Pending" — KYC not yet submitted
• "InProgress" — KYC submitted, under review
• "Approved" — customer passes KYC, can use financial products
• "Rejected" — customer fails KYC
• "RequiresAction" — additional documents or information required

Webhooks

ClearBank fires a CustomerKycStatusChanged webhook when KYC state transitions. Subscribe and handle this in ClearBank.Webhook.Handler to update your records.

Examples

{:ok, kyc} = ClearBank.EmbeddedBanking.Kyc.get_status(client, "cust-uuid")
# => %{"status" => "Approved", "updatedAt" => "2024-01-15T10:00:00Z"}

{:ok, _} = ClearBank.EmbeddedBanking.Kyc.submit(client, "cust-uuid", %{
  id_document_type: "Passport",
  id_document_number: "123456789",
  id_document_expiry: "2030-01-01",
  id_document_country: "GB"
})