Skip to content

Update

Update account holder information and possibly resubmit for evaluation
patch/v1/account_holders/{account_holder_token}

Update the information associated with a particular account holder (including business owners and control persons associated to a business account). If Lithic is performing KYB or KYC and additional verification is required we will run the individual's or business's updated information again and return whether the status is accepted or pending (i.e., further action required). All calls to this endpoint will return a synchronous response. The response time will depend on the workflow. In some cases, the response may indicate the workflow is under review or further action will be needed to complete the account creation process. This endpoint can only be used on existing accounts that are part of the program that the calling API key manages.

Path Parameters
account_holder_tokenstring
formatuuid
Body Parameters
bodyunion

The KYB request payload for updating a business.

One of the following 3 object variants:
Hide ParametersShow Parameters
KYBPatchRequestobject

The KYB request payload for updating a business.

Hide ParametersShow Parameters
beneficial_owner_entitiesarray of object
optional
deprecated

Deprecated.

Hide ParametersShow Parameters
entity_tokenstring

Globally unique identifier for an entity.

formatuuid
addressaddress1stringaddress2stringcitystringcountrystringpostal_codestringstatestringAddressUpdate
optional

Business''s physical address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable.

dba_business_namestring
optional

Any name that the business operates under that is not its legal business name (if applicable).

government_idstring
optional

Government-issued identification number. US Federal Employer Identification Numbers (EIN) are currently supported, entered as full nine-digits, with or without hyphens.

parent_companystring
optional

Parent company name (if applicable).

phone_numbersarray of string
optional

One or more of the business's phone number(s), entered as a list in E.164 format.

beneficial_owner_individualsarray of object
optional

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. See FinCEN requirements (Section I) for more background on individuals that should be included.

Hide ParametersShow Parameters
entity_tokenstring

Globally unique identifier for an entity.

formatuuid
addressaddress1stringaddress2stringcitystringcountrystringpostal_codestringstatestringAddressUpdate
optional

Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.

dobstring
optional

Individual's date of birth, as an RFC 3339 date.

emailstring
optional

Individual's email address. If utilizing Lithic for chargeback processing, this customer email address may be used to communicate dispute status and resolution.

first_namestring
optional

Individual's first name, as it appears on government-issued identity documents.

government_idstring
optional

Government-issued identification number (required for identity verification and compliance with banking regulations). Social Security Numbers (SSN) and Individual Taxpayer Identification Numbers (ITIN) are currently supported, entered as full nine-digits, with or without hyphens

last_namestring
optional

Individual's last name, as it appears on government-issued identity documents.

phone_numberstring
optional

Individual's phone number, entered in E.164 format.

business_entityobject
optional

Information for business for which the account is being opened and KYB is being run.

Hide ParametersShow Parameters
entity_tokenstring

Globally unique identifier for an entity.

formatuuid
addressaddress1stringaddress2stringcitystringcountrystringpostal_codestringstatestringAddressUpdate
optional

Business''s physical address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable.

dba_business_namestring
optional

Any name that the business operates under that is not its legal business name (if applicable).

government_idstring
optional

Government-issued identification number. US Federal Employer Identification Numbers (EIN) are currently supported, entered as full nine-digits, with or without hyphens.

parent_companystring
optional

Parent company name (if applicable).

phone_numbersarray of string
optional

One or more of the business's phone number(s), entered as a list in E.164 format.

control_personobject
optional

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 (Section II) for more background.

Hide ParametersShow Parameters
entity_tokenstring

Globally unique identifier for an entity.

formatuuid
addressaddress1stringaddress2stringcitystringcountrystringpostal_codestringstatestringAddressUpdate
optional

Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.

dobstring
optional

Individual's date of birth, as an RFC 3339 date.

emailstring
optional

Individual's email address. If utilizing Lithic for chargeback processing, this customer email address may be used to communicate dispute status and resolution.

first_namestring
optional

Individual's first name, as it appears on government-issued identity documents.

government_idstring
optional

Government-issued identification number (required for identity verification and compliance with banking regulations). Social Security Numbers (SSN) and Individual Taxpayer Identification Numbers (ITIN) are currently supported, entered as full nine-digits, with or without hyphens

last_namestring
optional

Individual's last name, as it appears on government-issued identity documents.

phone_numberstring
optional

Individual's phone number, entered in E.164 format.

external_idstring
optional

A user provided id that can be used to link an account holder with an external system

nature_of_businessstring
optional

Short description of the company's line of business (i.e., what does the company do?).

website_urlstring
optional

Company website URL.

KYCPatchRequestobject

The KYC request payload for updating an account holder.

Hide ParametersShow Parameters
external_idstring
optional

A user provided id that can be used to link an account holder with an external system

individualobject
optional

Information on the individual for whom the account is being opened and KYC is being run.

Hide ParametersShow Parameters
entity_tokenstring

Globally unique identifier for an entity.

formatuuid
addressaddress1stringaddress2stringcitystringcountrystringpostal_codestringstatestringAddressUpdate
optional

Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.

dobstring
optional

Individual's date of birth, as an RFC 3339 date.

emailstring
optional

Individual's email address. If utilizing Lithic for chargeback processing, this customer email address may be used to communicate dispute status and resolution.

first_namestring
optional

Individual's first name, as it appears on government-issued identity documents.

government_idstring
optional

Government-issued identification number (required for identity verification and compliance with banking regulations). Social Security Numbers (SSN) and Individual Taxpayer Identification Numbers (ITIN) are currently supported, entered as full nine-digits, with or without hyphens

last_namestring
optional

Individual's last name, as it appears on government-issued identity documents.

phone_numberstring
optional

Individual's phone number, entered in E.164 format.

PatchRequestobject

The legacy request for updating an account holder.

Hide ParametersShow Parameters
addressaddress1stringaddress2stringcitystringcountrystringpostal_codestringstatestringAddressUpdate
optional

Allowed for: KYC-Exempt, BYO-KYC, BYO-KYB.

business_account_tokenstring
optional

Allowed for: KYC-Exempt, BYO-KYC. The token of the business account to which the account holder is associated.

emailstring
optional

Allowed for all Account Holders. Account holder's email address. The primary purpose of this field is for cardholder identification and verification during the digital wallet tokenization process.

first_namestring
optional

Allowed for KYC-Exempt, BYO-KYC. Account holder's first name.

last_namestring
optional

Allowed for KYC-Exempt, BYO-KYC. Account holder's last name.

phone_numberstring
optional

Allowed for all Account Holders. Account holder's phone number, entered in E.164 format. The primary purpose of this field is for cardholder identification and verification during the digital wallet tokenization process.

Returns
KYBKYCPatchResponseobject
Hide ParametersShow Parameters
tokenstring
optional

Globally unique identifier for the account holder.

formatuuid
account_tokenstring
optional

Globally unique identifier for the account.

formatuuid
beneficial_owner_entitiesarray of addressobjectgovernment_idstringlegal_business_namestringphone_numbersarray of stringdba_business_namestringparent_companystringKYBBusinessEntity
optional

Deprecated.

beneficial_owner_individualsarray of object
optional

Only present when user_type == "BUSINESS". 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. See FinCEN requirements (Section I) for more background on individuals that should be included.

Hide ParametersShow Parameters
addressobject
optional

Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.

Hide ParametersShow Parameters
address1string

Valid deliverable address (no PO boxes).

citystring

Name of city.

countrystring

Valid country code. Only USA is currently supported, entered in uppercase ISO 3166-1 alpha-3 three-character format.

postal_codestring

Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit ZIP or nine-digit ZIP+4.

statestring

Valid state code. Only USA state codes are currently supported, entered in uppercase ISO 3166-2 two-character format.

address2string
optional

Unit or apartment number (if applicable).

dobstring
optional

Individual's date of birth, as an RFC 3339 date.

emailstring
optional

Individual's email address. If utilizing Lithic for chargeback processing, this customer email address may be used to communicate dispute status and resolution.

first_namestring
optional

Individual's first name, as it appears on government-issued identity documents.

government_idstring
optional

Government-issued identification number (required for identity verification and compliance with banking regulations). Social Security Numbers (SSN) and Individual Taxpayer Identification Numbers (ITIN) are currently supported, entered as full nine-digits, with or without hyphens

last_namestring
optional

Individual's last name, as it appears on government-issued identity documents.

phone_numberstring
optional

Individual's phone number, entered in E.164 format.

business_account_tokenstring
optional

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.

formatuuid
business_entityaddressobjectgovernment_idstringlegal_business_namestringphone_numbersarray of stringdba_business_namestringparent_companystringKYBBusinessEntity
optional

Only present when user_type == "BUSINESS". Information about the business for which the account is being opened and KYB is being run.

control_personobject
optional

Only present when user_type == "BUSINESS".

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.

Hide ParametersShow Parameters
addressobject
optional

Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.

Hide ParametersShow Parameters
address1string

Valid deliverable address (no PO boxes).

citystring

Name of city.

countrystring

Valid country code. Only USA is currently supported, entered in uppercase ISO 3166-1 alpha-3 three-character format.

postal_codestring

Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit ZIP or nine-digit ZIP+4.

statestring

Valid state code. Only USA state codes are currently supported, entered in uppercase ISO 3166-2 two-character format.

address2string
optional

Unit or apartment number (if applicable).

dobstring
optional

Individual's date of birth, as an RFC 3339 date.

emailstring
optional

Individual's email address. If utilizing Lithic for chargeback processing, this customer email address may be used to communicate dispute status and resolution.

first_namestring
optional

Individual's first name, as it appears on government-issued identity documents.

government_idstring
optional

Government-issued identification number (required for identity verification and compliance with banking regulations). Social Security Numbers (SSN) and Individual Taxpayer Identification Numbers (ITIN) are currently supported, entered as full nine-digits, with or without hyphens

last_namestring
optional

Individual's last name, as it appears on government-issued identity documents.

phone_numberstring
optional

Individual's phone number, entered in E.164 format.

createdstring
optional

Timestamp of when the account holder was created.

formatdate-time
emailstring
optional

< Deprecated. Use control_person.email when user_type == "BUSINESS". Use individual.phone_number when user_type == "INDIVIDUAL".

Primary email of Account Holder.

exemption_typeenum
optional
Accepts one of the following: "AUTHORIZED_USER", "PREPAID_CARD_USER"

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

Hide ParametersShow Parameters
"AUTHORIZED_USER"
"PREPAID_CARD_USER"
external_idstring
optional

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

formatstring
individualobject
optional

Only present when user_type == "INDIVIDUAL". Information about the individual for which the account is being opened and KYC is being run.

Hide ParametersShow Parameters
addressobject
optional

Individual's current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.

Hide ParametersShow Parameters
address1string

Valid deliverable address (no PO boxes).

citystring

Name of city.

countrystring

Valid country code. Only USA is currently supported, entered in uppercase ISO 3166-1 alpha-3 three-character format.

postal_codestring

Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit ZIP or nine-digit ZIP+4.

statestring

Valid state code. Only USA state codes are currently supported, entered in uppercase ISO 3166-2 two-character format.

address2string
optional

Unit or apartment number (if applicable).

dobstring
optional

Individual's date of birth, as an RFC 3339 date.

emailstring
optional

Individual's email address. If utilizing Lithic for chargeback processing, this customer email address may be used to communicate dispute status and resolution.

first_namestring
optional

Individual's first name, as it appears on government-issued identity documents.

government_idstring
optional

Government-issued identification number (required for identity verification and compliance with banking regulations). Social Security Numbers (SSN) and Individual Taxpayer Identification Numbers (ITIN) are currently supported, entered as full nine-digits, with or without hyphens

last_namestring
optional

Individual's last name, as it appears on government-issued identity documents.

phone_numberstring
optional

Individual's phone number, entered in E.164 format.

nature_of_businessstring
optional

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

formatstring
phone_numberstring
optional

< 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.

required_documentsarray of entity_tokenstringstatus_reasonsarray of stringvalid_documentsarray of stringRequiredDocument
optional

Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents required for the account holder to be approved.

statusenum
optional
Accepts one of the following: "ACCEPTED", "PENDING_DOCUMENT", "PENDING_RESUBMIT", "REJECTED"

<Deprecated. Use verification_application.status instead>

KYC and KYB evaluation states.

Note: PENDING_RESUBMIT and PENDING_DOCUMENT are only applicable for the ADVANCED workflow.

Hide ParametersShow Parameters
"ACCEPTED"
"PENDING_DOCUMENT"
"PENDING_RESUBMIT"
"REJECTED"
status_reasonsarray of enum
optional

<Deprecated. Use verification_application.status_reasons> Reason for the evaluation status.

Hide ParametersShow Parameters
"ADDRESS_VERIFICATION_FAILURE"
"AGE_THRESHOLD_FAILURE"
"COMPLETE_VERIFICATION_FAILURE"
"DOB_VERIFICATION_FAILURE"
"ID_VERIFICATION_FAILURE"
"MAX_DOCUMENT_ATTEMPTS"
"MAX_RESUBMISSION_ATTEMPTS"
"NAME_VERIFICATION_FAILURE"
"OTHER_VERIFICATION_FAILURE"
"RISK_THRESHOLD_FAILURE"
"WATCHLIST_ALERT_FAILURE"
"PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE"
"PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE"
"PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE"
"PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED"
"PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE"
"PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED"
"PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE"
"PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE"
"PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE"
"CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE"
"CONTROL_PERSON_ID_VERIFICATION_FAILURE"
"CONTROL_PERSON_DOB_VERIFICATION_FAILURE"
"CONTROL_PERSON_NAME_VERIFICATION_FAILURE"
user_typeenum
optional
Accepts one of the following: "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", "nature_of_business", and "website_url" attributes will be present.

Hide ParametersShow Parameters
"BUSINESS"
"INDIVIDUAL"
verification_applicationobject
optional

Information about the most recent identity verification attempt

Hide ParametersShow Parameters
createdstring

Timestamp of when the application was created.

formatdate-time
statusenum
Accepts one of the following: "ACCEPTED", "PENDING_DOCUMENT", "PENDING_RESUBMIT", "REJECTED"

KYC and KYB evaluation states.

Note: PENDING_RESUBMIT and PENDING_DOCUMENT are only applicable for the ADVANCED workflow.

Hide ParametersShow Parameters
"ACCEPTED"
"PENDING_DOCUMENT"
"PENDING_RESUBMIT"
"REJECTED"
status_reasonsarray of enum

Reason for the evaluation status.

Hide ParametersShow Parameters
"ADDRESS_VERIFICATION_FAILURE"
"AGE_THRESHOLD_FAILURE"
"COMPLETE_VERIFICATION_FAILURE"
"DOB_VERIFICATION_FAILURE"
"ID_VERIFICATION_FAILURE"
"MAX_DOCUMENT_ATTEMPTS"
"MAX_RESUBMISSION_ATTEMPTS"
"NAME_VERIFICATION_FAILURE"
"OTHER_VERIFICATION_FAILURE"
"RISK_THRESHOLD_FAILURE"
"WATCHLIST_ALERT_FAILURE"
"PRIMARY_BUSINESS_ENTITY_ID_VERIFICATION_FAILURE"
"PRIMARY_BUSINESS_ENTITY_ADDRESS_VERIFICATION_FAILURE"
"PRIMARY_BUSINESS_ENTITY_NAME_VERIFICATION_FAILURE"
"PRIMARY_BUSINESS_ENTITY_BUSINESS_OFFICERS_NOT_MATCHED"
"PRIMARY_BUSINESS_ENTITY_SOS_FILING_INACTIVE"
"PRIMARY_BUSINESS_ENTITY_SOS_NOT_MATCHED"
"PRIMARY_BUSINESS_ENTITY_CMRA_FAILURE"
"PRIMARY_BUSINESS_ENTITY_WATCHLIST_FAILURE"
"PRIMARY_BUSINESS_ENTITY_REGISTERED_AGENT_FAILURE"
"CONTROL_PERSON_BLOCKLIST_ALERT_FAILURE"
"CONTROL_PERSON_ID_VERIFICATION_FAILURE"
"CONTROL_PERSON_DOB_VERIFICATION_FAILURE"
"CONTROL_PERSON_NAME_VERIFICATION_FAILURE"
updatedstring

Timestamp of when the application was last updated.

formatdate-time
website_urlstring
optional

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

formatstring
PatchResponseobject
Hide ParametersShow Parameters
tokenstring
optional

The token for the account holder that was updated

addressobject
optional

The address for the account holder

Hide ParametersShow Parameters
address1string

Valid deliverable address (no PO boxes).

citystring

Name of city.

countrystring

Valid country code. Only USA is currently supported, entered in uppercase ISO 3166-1 alpha-3 three-character format.

postal_codestring

Valid postal code. Only USA ZIP codes are currently supported, entered as a five-digit ZIP or nine-digit ZIP+4.

statestring

Valid state code. Only USA state codes are currently supported, entered in uppercase ISO 3166-2 two-character format.

address2string
optional

Unit or apartment number (if applicable).

business_account_tokenstring
optional

The token for the business account that the account holder is associated with

emailstring
optional

The email for the account holder

first_namestring
optional

The first name for the account holder

last_namestring
optional

The last name for the account holder

phone_numberstring
optional

The phone_number for the account holder

Request example Request
curl https://api.lithic.com/v1/account_holders/$ACCOUNT_HOLDER_TOKEN \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
      "nature_of_business": "Software company selling solutions to the restaurant industry",
      "website_url": "www.mybusiness.com"
    }'
200 Example
{
  "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "beneficial_owner_entities": [
    {
      "address": {
        "address1": "123 Old Forest Way",
        "city": "Omaha",
        "country": "USA",
        "postal_code": "68022",
        "state": "NE",
        "address2": "address2"
      },
      "government_id": "114-123-1513",
      "legal_business_name": "Acme, Inc.",
      "phone_numbers": [
        "+15555555555"
      ],
      "dba_business_name": "dba_business_name",
      "parent_company": "parent_company"
    }
  ],
  "beneficial_owner_individuals": [
    {
      "address": {
        "address1": "123 Old Forest Way",
        "city": "Omaha",
        "country": "USA",
        "postal_code": "68022",
        "state": "NE",
        "address2": "address2"
      },
      "dob": "1991-03-08 08:00:00",
      "email": "tom@middle-earth.com",
      "first_name": "Tom",
      "government_id": "111-23-1412",
      "last_name": "Bombadil",
      "phone_number": "+15555555555"
    }
  ],
  "business_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "business_entity": {
    "address": {
      "address1": "123 Old Forest Way",
      "city": "Omaha",
      "country": "USA",
      "postal_code": "68022",
      "state": "NE",
      "address2": "address2"
    },
    "government_id": "114-123-1513",
    "legal_business_name": "Acme, Inc.",
    "phone_numbers": [
      "+15555555555"
    ],
    "dba_business_name": "dba_business_name",
    "parent_company": "parent_company"
  },
  "control_person": {
    "address": {
      "address1": "123 Old Forest Way",
      "city": "Omaha",
      "country": "USA",
      "postal_code": "68022",
      "state": "NE",
      "address2": "address2"
    },
    "dob": "1991-03-08 08:00:00",
    "email": "tom@middle-earth.com",
    "first_name": "Tom",
    "government_id": "111-23-1412",
    "last_name": "Bombadil",
    "phone_number": "+15555555555"
  },
  "created": "2019-12-27T18:11:19.117Z",
  "email": "email",
  "exemption_type": "AUTHORIZED_USER",
  "external_id": "external_id",
  "individual": {
    "address": {
      "address1": "123 Old Forest Way",
      "city": "Omaha",
      "country": "USA",
      "postal_code": "68022",
      "state": "NE",
      "address2": "address2"
    },
    "dob": "1991-03-08 08:00:00",
    "email": "tom@middle-earth.com",
    "first_name": "Tom",
    "government_id": "111-23-1412",
    "last_name": "Bombadil",
    "phone_number": "+15555555555"
  },
  "nature_of_business": "nature_of_business",
  "phone_number": "phone_number",
  "required_documents": [
    {
      "entity_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "status_reasons": [
        "string"
      ],
      "valid_documents": [
        "string"
      ]
    }
  ],
  "status": "ACCEPTED",
  "status_reasons": [
    "ADDRESS_VERIFICATION_FAILURE"
  ],
  "user_type": "BUSINESS",
  "verification_application": {
    "created": "2019-12-27T18:11:19.117Z",
    "status": "ACCEPTED",
    "status_reasons": [
      "ADDRESS_VERIFICATION_FAILURE"
    ],
    "updated": "2019-12-27T18:11:19.117Z"
  },
  "website_url": "website_url"
}