Lithic · Schema

Account Holder Updated

FinTechBaaSCard IssuingPaymentsEmbedded Finance
View JSON Schema on GitHub

JSON Schema

lithic-account-holder-updated-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/account-holder-updated",
  "title": "Account Holder Updated",
  "oneOf": [
    {
      "title": "KYB Payload",
      "description": "KYB payload for an updated account holder.",
      "type": "object",
      "properties": {
        "token": {
          "description": "The token of the account_holder that was created.",
          "example": "00000000-0000-0000-0000-000000000001",
          "format": "uuid",
          "type": "string"
        },
        "update_request": {
          "type": "object",
          "description": "Original request to update the account holder.",
          "properties": {
            "beneficial_owner_individuals": {
              "description": "You must submit a list of all direct and indirect individuals with 25% or more ownership in the company. A maximum of 4 beneficial owners can be submitted. If no individual owns 25% of the company you do not need to send beneficial owner information.\nSee [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf) (Section I) for more background on individuals that should be included.",
              "items": {
                "$ref": "#/components/schemas/individual"
              },
              "minItems": 0,
              "type": "array"
            },
            "business_entity": {
              "description": "Information for business for which the account is being opened and KYB is being run.",
              "$ref": "#/components/schemas/kyb-business-entity"
            },
            "control_person": {
              "description": "An individual with significant responsibility for managing the legal entity (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating Officer, Managing Member, General Partner, President, Vice President, or Treasurer). This can be an executive, or someone who will have program-wide access to the cards that Lithic will provide. In some cases, this individual could also be a beneficial owner listed above. See [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf) (Section II) for more background.",
              "$ref": "#/components/schemas/individual"
            }
          }
        },
        "external_id": {
          "description": "A user provided id that can be used to link an account holder with an external system",
          "type": "string"
        },
        "naics_code": {
          "description": "6-digit North American Industry Classification System (NAICS) code for the business. Only present if naics_code was included in the update request.",
          "example": "541512",
          "type": "string"
        },
        "nature_of_business": {
          "description": "Short description of the company's line of business (i.e., what does the company do?). Values longer than 255 characters will be truncated before KYB verification",
          "example": "Software company selling solutions to the restaurant industry",
          "type": "string"
        },
        "website_url": {
          "description": "Company website URL.",
          "example": "www.mybusiness.com",
          "type": "string"
        }
      },
      "required": [
        "token",
        "update_request"
      ],
      "additionalProperties": false
    },
    {
      "title": "KYC Payload",
      "description": "KYC payload for an updated account holder.",
      "type": "object",
      "properties": {
        "token": {
          "description": "The token of the account_holder that was created.",
          "example": "00000000-0000-0000-0000-000000000001",
          "format": "uuid",
          "type": "string"
        },
        "update_request": {
          "type": "object",
          "description": "Original request to update the account holder.",
          "properties": {
            "individual": {
              "$ref": "#/components/schemas/individual",
              "description": "Information on the individual for whom the account is being opened and KYC is being run."
            }
          }
        },
        "external_id": {
          "description": "A user provided id that can be used to link an account holder with an external system",
          "type": "string"
        }
      },
      "required": [
        "token",
        "update_request"
      ],
      "additionalProperties": false
    },
    {
      "title": "Legacy Payload",
      "description": "Legacy payload for an updated account holder.",
      "type": "object",
      "properties": {
        "business_account_token": {
          "description": "If applicable, represents the business account token associated with the account_holder.",
          "example": "00000000-0000-0000-0000-000000000001",
          "format": "uuid",
          "type": [
            "string",
            "null"
          ]
        },
        "created": {
          "description": "When the account_holder updated event was created",
          "format": "date-time",
          "type": "string"
        },
        "email": {
          "description": "If updated, the newly updated email associated with the account_holder otherwise the existing email is provided.",
          "example": "[email protected]",
          "type": "string"
        },
        "external_id": {
          "description": "If applicable, represents the external_id associated with the account_holder.",
          "example": "00000000-0000-0000-0000-000000000001",
          "type": [
            "string",
            "null"
          ]
        },
        "first_name": {
          "description": "If applicable, represents the account_holder's first name.",
          "example": "Johnny",
          "type": "string"
        },
        "last_name": {
          "description": "If applicable, represents the account_holder's last name.",
          "example": "Appleseed",
          "type": "string"
        },
        "legal_business_name": {
          "description": "If applicable, represents the account_holder's business name.",
          "example": "Lithic",
          "type": "string"
        },
        "phone_number": {
          "description": "If updated, the newly updated phone_number associated with the account_holder otherwise the existing phone_number is provided.",
          "example": "+15555555555",
          "type": "string"
        },
        "token": {
          "description": "The token of the account_holder that was created.",
          "example": "00000000-0000-0000-0000-000000000001",
          "format": "uuid",
          "type": "string"
        }
      },
      "required": [
        "token"
      ]
    }
  ]
}