Skip to main content
Eligibility is Lead’s answer to one question: which relationships can this entity hold right now? Lead computes it from the entity’s current data every time you read the entity. Lead never stores it, so fixing the data changes the answer on the next read. There is no separate request to re-run it. Eligibility appears in two places on the entity object:
  • intended_eligibility is optional on POST and PATCH. It’s how you tell Lead which relationship types you intend this entity to hold. When you send it, Lead checks in real time that the entity has the data each listed type needs, and rejects the request with 422 parameters_invalid if it does not.
  • eligibility is on every response. For each of the four relationship types, it shows whether the entity’s current data qualifies it, and which checks fail on which entity.

The four relationship types

business, sole_prop, lead, and partner entities are always ineligible for minor_account_holder, authorized_signer, and authorized_user, because only individuals can hold those relationships.
minor_account_holder is available only to programs approved for minor account holder support. Lead reviews the program’s intended audience, monitoring, and product controls for minors first. Contact your Technical Account Manager to request it.

Data requirements

An entity is eligible for a relationship type when it has every field listed for that type and each one passes its check. Fields not listed are optional for that type.
  • account_holder, individual
    • individual_details.first_name, last_name
    • individual_details.contact_methods with an email or phone_number in the first entry
    • individual_details.date_of_birth, age 18 or older
    • individual_details.address_details.physical_address
    • individual_details.identification_details with tax_identification (us_entity) or at least one identification_documents[] entry (non_us_entity)
    • kyc_details with result passed and a screened_at
    • ofac_details with result passed and a screened_at
    • risk_score
  • account_holder, business
    • business_details.name, type, industry
    • business_details.contact_methods with an email or phone_number in the first entry
    • business_details.address_details.physical_address
    • business_details.identification_details with tax_identification (us_entity) or at least one identification_documents[] entry (non_us_entity)
    • kyc_details with result passed and a screened_at
    • ofac_details with result passed and a screened_at
    • risk_score
    • control_persons[] with at least one entry, each with a title
    • beneficial_owners[] listing every applicable owner. An empty array is valid when the business has no qualifying owners.
    • Every linked control person and beneficial owner eligible for authorized_signer
  • account_holder, sole_prop
    • business_details.name, type, industry
    • business_details.contact_methods with an email or phone_number in the first entry
    • business_details.address_details.physical_address
    • business_details.identification_details with tax_identification (us_entity) or at least one identification_documents[] entry (non_us_entity)
    • kyc_details with result passed and a screened_at
    • ofac_details with result passed and a screened_at
    • risk_score
    • sole_proprietor, eligible for authorized_signer
  • minor_account_holder, individuals only
    • individual_details.first_name, last_name
    • individual_details.contact_methods with an email or phone_number in the first entry
    • individual_details.date_of_birth, age 16 or 17
    • individual_details.address_details.physical_address
    • individual_details.identification_details with tax_identification (us_entity) or at least one identification_documents[] entry (non_us_entity)
    • kyc_details with result passed and a screened_at
    • ofac_details with result passed and a screened_at
    • risk_score
  • authorized_signer, individuals only
    • individual_details.first_name, last_name
    • individual_details.contact_methods with an email or phone_number in the first entry
    • individual_details.date_of_birth, age 18 or older
    • individual_details.address_details.physical_address
    • individual_details.identification_details with tax_identification (us_entity) or at least one identification_documents[] entry (non_us_entity)
    • kyc_details with result passed and a screened_at
    • ofac_details with result passed and a screened_at
  • authorized_user, individuals only
    • individual_details.first_name, last_name
    • individual_details.contact_methods with an email or phone_number in the first entry
    • individual_details.identification_details.type

Reading eligibility

Every entity response carries all four keys, whatever the entity’s type.
Each relationship type has:

Failures on a linked entity

A business or sole proprietorship can only be eligible for account_holder if every individual linked to it is eligible for authorized_signer. When a beneficial owner, control person, or sole proprietor fails a check, the parent fails too, and failed_checks[].entity_id points at the linked individual rather than at the business. For example, a business is ineligible for account_holder because its control person failed Know Your Customer (KYC). The business’s failed_checks carries the KYC check with the control person’s entity_id. Update the control person’s entity with a passed KYC attestation. The business becomes eligible on its next read without any change to the business itself.

Asserting eligibility on a request

Send intended_eligibility to tell Lead which relationship types you intend the entity to hold. Lead checks in real time that the entity has the data each listed type needs, and rejects the request if it does not.
A failed assertion returns every failing check for every listed type, so you can fix them in one pass. The 422 has one error per entity whose data failed, with that entity’s entity_id and its failing checks, named the same as eligibility.failed_checks[].check. When a business fails because a linked individual fails, that individual gets its own error. Field validation errors come back in the same response. Asserting is optional. An entity that meets a type’s requirements is eligible for it downstream, like on user accounts and account numbers, whether or not you asserted it. Fixing a linked individual’s data changes the eligibility of every business that lists them.

Checks

Each check verifies one data requirement. minor_account_holder runs the full account_holder check set, including government ID, so a minor account holder needs an SSN or ITIN. The three date-of-birth checks for minors replace the 18-or-older check. Entity Overview · The Entity Object · Beneficial Ownership Requirements · Errors