Simulate Enrollment Review
Simulate an account holder's enrollment review
Simulates an enrollment review for an account holder. This endpoint is only applicable for workflows that may required intervention such as KYB_BASIC.
Body Parameters
The account holder which to perform the simulation upon.
An account holder's status for use within the simulation.
Status reason that will be associated with the simulated account holder status. Only required for a REJECTED status.
Returns
Globally unique identifier for the account holder.
Globally unique identifier for the account.
Deprecated.
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.
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.
Only present when user_type == "BUSINESS". Information about the business for which the account is being opened and KYB is being run.
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.
Timestamp of when the account holder was created.
< Deprecated. Use control_person.email when user_type == "BUSINESS". Use individual.phone_number when user_type == "INDIVIDUAL".
Primary email of Account Holder.
The type of KYC exemption for a KYC-Exempt Account Holder. "None" if the account holder is not KYC-Exempt.
Customer-provided token that indicates a relationship with an object outside of the Lithic ecosystem.
Only present when user_type == "INDIVIDUAL". Information about the individual for which the account is being opened and KYC is being run.
Only present when user_type == "BUSINESS". User-submitted description of the business.
< 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.
Only present for "KYB_BASIC" and "KYC_ADVANCED" workflows. A list of documents required for the account holder to be approved.
<Deprecated. Use verification_application.status instead>
KYC and KYB evaluation states.
Note: PENDING_RESUBMIT and PENDING_DOCUMENT are only applicable for the ADVANCED workflow.
<Deprecated. Use verification_application.status_reasons> Reason for the evaluation status.
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.
Information about the most recent identity verification attempt
Only present when user_type == "BUSINESS". Business's primary website.
curl https://api.lithic.com/v1/simulate/account_holders/enrollment_review \
-H 'Content-Type: application/json' \
-H "Authorization: $LITHIC_API_KEY" \
-d '{}'{
"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"
}