Lithic · Schema

Kyc

FinTechBaaSCard IssuingPaymentsEmbedded Finance

Properties

Name Type Description
external_id string A user provided id that can be used to link an account holder with an external system
individual object Information on individual for whom the account is being opened and KYC is being run.
kyc_passed_timestamp string An RFC 3339 timestamp indicating when precomputed KYC was completed on the individual with a pass result. This field is required only if workflow type is `KYC_BYO`.
tos_timestamp string An RFC 3339 timestamp indicating when the account holder accepted the applicable legal agreements (e.g., cardholder terms) as agreed upon during API customer's implementation with Lithic.
workflow string Specifies the type of KYC workflow to run.
View JSON Schema on GitHub

JSON Schema

lithic-kyc-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Kyc",
  "title": "Kyc",
  "properties": {
    "external_id": {
      "description": "A user provided id that can be used to link an account holder with an external system",
      "type": "string"
    },
    "individual": {
      "$ref": "#/components/schemas/KycIndividual",
      "description": "Information on individual for whom the account is being opened and KYC is being run."
    },
    "kyc_passed_timestamp": {
      "description": "An RFC 3339 timestamp indicating when precomputed KYC was completed on the individual with a pass result.\n\nThis field is required only if workflow type is `KYC_BYO`.\n",
      "type": "string"
    },
    "tos_timestamp": {
      "description": "An RFC 3339 timestamp indicating when the account holder accepted the applicable legal agreements (e.g., cardholder terms) as agreed upon during API customer's implementation with Lithic.",
      "type": "string"
    },
    "workflow": {
      "description": "Specifies the type of KYC workflow to run.",
      "enum": [
        "KYC_BASIC",
        "KYC_BYO"
      ],
      "type": "string"
    }
  },
  "required": [
    "individual",
    "tos_timestamp",
    "workflow"
  ],
  "type": "object"
}