LIlithic-com
Account Holder

Simulate an account holder's enrollment review

Changed on

Simulates an enrollment review for an account holder. This endpoint is only applicable for workflows that may required intervention such as KYB_BASIC.

post/v1/simulate/account_holders/enrollment_review

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/simulate/account_holders/enrollment_review
  • Auth
    API key in header Authorization

Request body

account_holder_tokenstring

The account holder which to perform the simulation upon.

status'ACCEPTED' | 'REJECTED' | 'PENDING_REVIEW'

An account holder's status for use within the simulation.

status_reasonsstring[]

Status reason that will be associated with the simulated account holder status. Only required for a REJECTED status.

Response

OK

tokenstring uuid

Globally unique identifier for the account holder.

account_tokenstring uuid

Globally unique identifier for the account.

business_account_tokenstring uuid nullable

Only applicable for customers using the KYC-Exempt workflow to enroll authorized users of businesses. Pass the account_token of the enrolled business associated with the AUTHORIZED_USER in this field.

createdstring date-time

Timestamp of when the account holder was created.

exemption_type'AUTHORIZED_USER' | 'PREPAID_CARD_USER' nullable

The type of KYC exemption for a KYC-Exempt Account Holder. null if the account holder is not KYC-Exempt.

external_idstring nullable

Customer-provided token that indicates a relationship with an object outside of the Lithic ecosystem.

user_type'BUSINESS' | 'INDIVIDUAL'

The type of Account Holder. If the type is "INDIVIDUAL", the "individual" attribute will be present.

If the type is "BUSINESS" then the "business_entity", "control_person", "beneficial_owner_individuals", "naics_code", "nature_of_business", and "website_url" attributes will be present.

naics_codestring nullable

Only present when user_type == "BUSINESS". 6-digit North American Industry Classification System (NAICS) code for the business.

nature_of_businessstring

Only present when user_type == "BUSINESS". User-submitted description of the business.

website_urlstring

Only present when user_type == "BUSINESS". Business's primary website.

emailstring

(Deprecated. Use control_person.email when user_type == "BUSINESS". Use individual.phone_number when user_type == "INDIVIDUAL".) Primary email of Account Holder.

phone_numberstring

(Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use individual.phone_number when user_type == "INDIVIDUAL".) Primary phone of Account Holder, entered in E.164 format.

status'ACCEPTED' | 'PENDING_DOCUMENT' | 'PENDING_RESUBMIT' | 'REJECTED'

Enrollment status for KYC/KYB

status_reasonsStatusReasons[]

(Deprecated. Use verification_application.status_reasons) Reason for the evaluation status.

Example response

{
  "individual": {
    "address": {
      "address1": "123 Old Forest Way",
      "city": "Omaha",
      "country": "USA",
      "postal_code": "68022",
      "state": "NE"
    },
    "dob": "1991-03-08 08:00:00",
    "email": "tom@middle-earth.com",
    "first_name": "Tom",
    "last_name": "Bombadil",
    "phone_number": "+15555555555",
    "government_id": "111-23-1412"
  },
  "business_entity": {
    "address": {
      "address1": "123 Old Forest Way",
      "city": "Omaha",
      "country": "USA",
      "postal_code": "68022",
      "state": "NE"
    },
    "government_id": "114-123-1513",
    "legal_business_name": "Acme, Inc.",
    "phone_numbers": [
      "+15555555555"
    ]
  },
  "beneficial_owner_individuals": [
    {
      "address": {
        "address1": "123 Old Forest Way",
        "city": "Omaha",
        "country": "USA",
        "postal_code": "68022",
        "state": "NE"
      },
      "dob": "1991-03-08 08:00:00",
      "email": "tom@middle-earth.com",
      "first_name": "Tom",
      "last_name": "Bombadil",
      "phone_number": "+15555555555",
      "government_id": "111-23-1412"
    }
  ],
  "control_person": {
    "address": {
      "address1": "123 Old Forest Way",
      "city": "Omaha",
      "country": "USA",
      "postal_code": "68022",
      "state": "NE"
    },
    "dob": "1991-03-08 08:00:00",
    "email": "tom@middle-earth.com",
    "first_name": "Tom",
    "last_name": "Bombadil",
    "phone_number": "+15555555555",
    "government_id": "111-23-1412"
  }
}

Changes

  • 9798275dc379Revision changes
    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

  • f70ff267a5d5Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status