--- title: "Retrieve an entity by client customer ID" method: GET path: "/v2/entities" tags: ["Entity"] --- # Retrieve an entity by client customer ID `GET /v2/entities` ## Request - Base URL: `https://api.sandbox.lead.bank` - URL: `https://api.sandbox.lead.bank/v2/entities` - Auth: HTTP bearer Retrieve an Entity by the `client_customer_id` you assigned in a Customer file. The response is a list: `objects` holds the matching Entity, in the same shape as `GET /v2/entities/{id}` returns, or is empty if no Entity has that `client_customer_id`. ## Query parameters - `client_customer_id` string, required ## Response `200` A list with the matching entity in `objects`. `objects` is empty if no entity matches. - ListEntitiesSuccessResponseV2: A page of entities matching the query filters. - `has_more` boolean, required: Whether more results are available after this page. - `objects` RetrieveAnEntitySuccessResponseV2[], required - union - IndividualEntityV2 - `id` string, required: The ID of your entity. - `client_customer_id` string: Your customer ID, on entities created through Customer files. Response only. Lead ignores it if sent, and does not return it on entities created with `POST /v2/entities`. - `created_at` string, date-time, required: Timestamp at which the entity object is created. - `updated_at` string, date-time, required: Timestamp at which the entity object was last updated. - `type` string, required: Type of entity = individual. - `risk_score` 'low' | 'medium' | 'high': The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead. - `individual_details` IndividualDetailsResponseV2, required: Details for the individual entity. An `authorized_user` requires only `first_name`, `last_name`, a contact method, and `identification_details.type`. Other relationship types require more; see [Eligibility](https://docs.lead.bank/v2/products/entity/eligibility). - `first_name` string, required: Legal first name, as your customer gave it. Non-Latin characters are accepted. - `preferred_first_name` string: Preferred first name. - `middle_name` string: Middle name. - `last_name` string, required: Legal last name, as your customer gave it. Non-Latin characters are accepted. - `date_of_birth` string, date: Date of birth, in YYYY-MM-DD format. `account_holder` and `authorized_signer` require age 18 or older. `minor_account_holder` requires age 16 or 17. - `occupation` string: Occupation / job. - `contact_methods` ContactMethod[] - union - … - `address_details` AddressDetails - `physical_address` Address - … - `mailing_address` Address - … - `other_addresses` Address[]: Other addresses for the entity. - … - `identification_details` union, required: Required on every individual; only `type` is required inside it. `tax_identification` is required for a `us_entity` holding the `account_holder`, `minor_account_holder`, or `authorized_signer` relationship type, and for beneficial owners, control persons, and sole proprietors. It is not required for an `authorized_user`. A `non_us_entity` needs at least one `identification_documents` entry for the same relationship types; on an entity created on v0, `legacy_identification_documents` entries count. - object - … - object - … - `additional_documents` AdditionalDocumentV2[]: Supporting documents, one entry per document. Each entry takes `file_id` or `type`, not both. A supplied array replaces the whole array, and Lead re-checks every `file_id` in it. Changing documents does not need a new KYC attestation. - `file_id` string: A file ID from `POST /v2/files`. Send `file_id` or `type`, not both. When you send only a `file_id`, Lead determines the document type from the file. Retrieve that type with `GET /v2/files/{id}`. The file must exist, belong to your program, and have a type this entry accepts. Send each `file_id` only once per entity. You can still link several files of the same type, and link one file to other entities. - `type` 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_record' | 'adverse_media' | 'id_selfie' | 'source_of_wealth' | 'social_security_card': The supporting document type, when you do not link a file. Send `file_id` or `type`, not both. - `legacy_additional_documents` AdditionalDocument[]: Additional document entries created on v0 Entities, returned exactly as sent. Read only: ignored if included on a POST or PATCH. - `client_document_id` string: Client document ID for the additional document. - `type` 'bank_statement' | 'utility_bills' | 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_records' | 'adverse_media' | 'id_selfie' | 'other', required: Type of additional non-government documents being provided to verify entity. Possible values are `bank_statement`, `utility_bills`, `proof_of_address`, `investigation_report`, `financial_statement`, `public_records`, `adverse_media`, `id_selfie`, `other`. - `description` string: Description about the identification document. Required if additional document type is `other`. - `rfi_details` RfiDetails - `result` 'requested' | 'completed', required: Result of request for information with the end customer. Leave blank if RFI has not been sent to the customer. - `requested_at` string, date-time, required: Date time RFI is requested at. - `ofac_details` OfacDetails: Details on OFAC on the entity. - `result` 'pending' | 'passed' | 'failed', required: OFAC result. Possible values: pending | passed | failed. - `screened_at` string, date-time, required: Date time OFAC screen is screened at. - `kyc_details` KycDetails: Details on KYC on the entity. - `result` 'pending' | 'passed' | 'failed', required: KYC result. Possible values: pending | passed | failed. - `screened_at` string, date-time, required: Date time KYC screen is screened at. - `credit_details` CreditDetails[] - `credit_score` string: Credit score given by the credit bureau. Cannot be above 850. Mutually exclusive with `credit_report_non_score_value`. - `credit_report_non_score_value` 'unestablished' | 'frozen': Indicates the state of a credit file when a numeric score is not available. - `credit_report_source` 'equifax' | 'experian' | 'transunion', required: The name of the credit bureau. - `credit_pulled_at` string, date-time, required: Date time credit is pulled at. - `intended_eligibility` EligibilityRelationshipType[]: The relationship types you intend this entity to hold. When you send it, Lead checks the entity's data against every listed type and rejects the request with `422 parameters_invalid` if any fails. The check is all or nothing, and the error returns every failing check, not just the first. Listing fewer types than the entity qualifies for still succeeds, and `eligibility` shows everything it qualifies for. If the check passes, Lead saves the list and returns it on the entity. On a `PATCH`, Lead checks the entity as it would be after the update, against the list you send or, if you leave the field out, the saved list. Send an empty array to clear the saved list; no check runs. - `eligibility` EligibilityV2, required: Whether the entity's current data qualifies it for each relationship type, with the failing checks. Response only. Lead computes it from current data on every read and never stores it. All four keys are always present. On a program that does not offer minor account holders, `minor_account_holder` is `ineligible` for every entity. - `account_holder` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `minor_account_holder` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `authorized_signer` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `authorized_user` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `metadata` Metadata: A set of key-value pairs that can be used to store additional information related to this object. - BusinessEntityV2 - `id` string, required: The ID of your entity. - `client_customer_id` string: Your customer ID, on entities created through Customer files. Response only. Lead ignores it if sent, and does not return it on entities created with `POST /v2/entities`. - `created_at` string, date-time, required: Timestamp at which the entity object is created. - `updated_at` string, date-time, required: Timestamp at which the entity object was last updated. - `type` string, required: Type of entity = business. - `risk_score` 'low' | 'medium' | 'high': The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead. - `business_details` BusinessDetailsResponseV2, required: Details for the business entity. - `type` 'corporation' | 'partnership' | 'sole_prop' | 'llc' | 'trust' | 'cooperative' | 'other': Business Types. Possible business types are `corporation`, `partnership`, `sole_prop`, `llc`, `trust`, `cooperative`, `other`. - For business entity, cannot use `sole_prop` as business type. - For sole_prop entity, must use `sole_prop` as business type. - `name` string, required: Legal name of the business. Must be at least 2 characters. - `gross_annual_revenue` string: Business gross revenue for prior fiscal year. - `currency_code` string: A three-letter currency code as defined in ISO 4217. - `industry` string[]: NAICS code(s) for the applicable industries. 2-6 digits of NAICS code(s) are accepted and valid NAICS codes can be found on naics.com/search. Please refer to 2022 NAICS Reference Files. - `doing_business_as` string: Business name if the business operates under a different name. - `website` string: The website of the business. Must start with http:// or https://. - `contact_methods` ContactMethod[] - union - … - `address_details` AddressDetails, required - `physical_address` Address - … - `mailing_address` Address - … - `other_addresses` Address[]: Other addresses for the entity. - … - `identification_details` union, required - object - … - object - … - `additional_documents` AdditionalDocumentV2[]: Supporting documents, one entry per document. Each entry takes `file_id` or `type`, not both. A supplied array replaces the whole array, and Lead re-checks every `file_id` in it. Changing documents does not need a new KYC attestation. - `file_id` string: A file ID from `POST /v2/files`. Send `file_id` or `type`, not both. When you send only a `file_id`, Lead determines the document type from the file. Retrieve that type with `GET /v2/files/{id}`. The file must exist, belong to your program, and have a type this entry accepts. Send each `file_id` only once per entity. You can still link several files of the same type, and link one file to other entities. - `type` 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_record' | 'adverse_media' | 'id_selfie' | 'source_of_wealth' | 'social_security_card': The supporting document type, when you do not link a file. Send `file_id` or `type`, not both. - `legacy_additional_documents` AdditionalDocument[]: Additional document entries created on v0 Entities, returned exactly as sent. Read only: ignored if included on a POST or PATCH. - `client_document_id` string: Client document ID for the additional document. - `type` 'bank_statement' | 'utility_bills' | 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_records' | 'adverse_media' | 'id_selfie' | 'other', required: Type of additional non-government documents being provided to verify entity. Possible values are `bank_statement`, `utility_bills`, `proof_of_address`, `investigation_report`, `financial_statement`, `public_records`, `adverse_media`, `id_selfie`, `other`. - `description` string: Description about the identification document. Required if additional document type is `other`. - `beneficial_owners` BeneficialOwnersV2[] - `entity_id` string, required: The `entity_id` of the individual entity for this beneficial owner. Data requirements for beneficial owners match those of an `authorized_signer`. - `ownership_percentage` string: Percentage of the business this person owns, from 0 to 100 with up to two decimal places. For example, `25.5` means 25.5%. The percentages of all beneficial owners must add up to 100 or less. - `relationship_established_at` string, date: The date the relationship was established. - `control_persons` ControlPersons[] - `entity_id` string, required: Individual entity_id created for the control person. Data requirements for control persons match those of an `authorized_signer`. - `title` string, required: The title of this control person. - `relationship_established_at` string, date: The date the relationship was established. - `rfi_details` RfiDetails - `result` 'requested' | 'completed', required: Result of request for information with the end customer. Leave blank if RFI has not been sent to the customer. - `requested_at` string, date-time, required: Date time RFI is requested at. - `ofac_details` OfacDetails: Details on OFAC on the entity. - `result` 'pending' | 'passed' | 'failed', required: OFAC result. Possible values: pending | passed | failed. - `screened_at` string, date-time, required: Date time OFAC screen is screened at. - `kyc_details` KycDetails: Details on KYC on the entity. - `result` 'pending' | 'passed' | 'failed', required: KYC result. Possible values: pending | passed | failed. - `screened_at` string, date-time, required: Date time KYC screen is screened at. - `credit_details` CreditDetails[] - `credit_score` string: Credit score given by the credit bureau. Cannot be above 850. Mutually exclusive with `credit_report_non_score_value`. - `credit_report_non_score_value` 'unestablished' | 'frozen': Indicates the state of a credit file when a numeric score is not available. - `credit_report_source` 'equifax' | 'experian' | 'transunion', required: The name of the credit bureau. - `credit_pulled_at` string, date-time, required: Date time credit is pulled at. - `intended_eligibility` EligibilityRelationshipType[]: The relationship types you intend this entity to hold. When you send it, Lead checks the entity's data against every listed type and rejects the request with `422 parameters_invalid` if any fails. The check is all or nothing, and the error returns every failing check, not just the first. Listing fewer types than the entity qualifies for still succeeds, and `eligibility` shows everything it qualifies for. If the check passes, Lead saves the list and returns it on the entity. On a `PATCH`, Lead checks the entity as it would be after the update, against the list you send or, if you leave the field out, the saved list. Send an empty array to clear the saved list; no check runs. - `eligibility` EligibilityV2, required: Whether the entity's current data qualifies it for each relationship type, with the failing checks. Response only. Lead computes it from current data on every read and never stores it. All four keys are always present. On a program that does not offer minor account holders, `minor_account_holder` is `ineligible` for every entity. - `account_holder` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `minor_account_holder` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `authorized_signer` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `authorized_user` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `metadata` Metadata: A set of key-value pairs that can be used to store additional information related to this object. - SolePropEntityV2 - `id` string, required: The ID of your entity. - `client_customer_id` string: Your customer ID, on entities created through Customer files. Response only. Lead ignores it if sent, and does not return it on entities created with `POST /v2/entities`. - `created_at` string, date-time, required: Timestamp at which the entity object is created. - `updated_at` string, date-time, required: Timestamp at which the entity object was last updated. - `type` string, required: Type of entity = sole_prop. - `risk_score` 'low' | 'medium' | 'high': The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead. - `business_details` BusinessDetailsResponseV2, required: Details for the business entity. - `type` 'corporation' | 'partnership' | 'sole_prop' | 'llc' | 'trust' | 'cooperative' | 'other': Business Types. Possible business types are `corporation`, `partnership`, `sole_prop`, `llc`, `trust`, `cooperative`, `other`. - For business entity, cannot use `sole_prop` as business type. - For sole_prop entity, must use `sole_prop` as business type. - `name` string, required: Legal name of the business. Must be at least 2 characters. - `gross_annual_revenue` string: Business gross revenue for prior fiscal year. - `currency_code` string: A three-letter currency code as defined in ISO 4217. - `industry` string[]: NAICS code(s) for the applicable industries. 2-6 digits of NAICS code(s) are accepted and valid NAICS codes can be found on naics.com/search. Please refer to 2022 NAICS Reference Files. - `doing_business_as` string: Business name if the business operates under a different name. - `website` string: The website of the business. Must start with http:// or https://. - `contact_methods` ContactMethod[] - union - … - `address_details` AddressDetails, required - `physical_address` Address - … - `mailing_address` Address - … - `other_addresses` Address[]: Other addresses for the entity. - … - `identification_details` union, required - object - … - object - … - `additional_documents` AdditionalDocumentV2[]: Supporting documents, one entry per document. Each entry takes `file_id` or `type`, not both. A supplied array replaces the whole array, and Lead re-checks every `file_id` in it. Changing documents does not need a new KYC attestation. - `file_id` string: A file ID from `POST /v2/files`. Send `file_id` or `type`, not both. When you send only a `file_id`, Lead determines the document type from the file. Retrieve that type with `GET /v2/files/{id}`. The file must exist, belong to your program, and have a type this entry accepts. Send each `file_id` only once per entity. You can still link several files of the same type, and link one file to other entities. - `type` 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_record' | 'adverse_media' | 'id_selfie' | 'source_of_wealth' | 'social_security_card': The supporting document type, when you do not link a file. Send `file_id` or `type`, not both. - `legacy_additional_documents` AdditionalDocument[]: Additional document entries created on v0 Entities, returned exactly as sent. Read only: ignored if included on a POST or PATCH. - `client_document_id` string: Client document ID for the additional document. - `type` 'bank_statement' | 'utility_bills' | 'proof_of_address' | 'investigation_report' | 'financial_statement' | 'public_records' | 'adverse_media' | 'id_selfie' | 'other', required: Type of additional non-government documents being provided to verify entity. Possible values are `bank_statement`, `utility_bills`, `proof_of_address`, `investigation_report`, `financial_statement`, `public_records`, `adverse_media`, `id_selfie`, `other`. - `description` string: Description about the identification document. Required if additional document type is `other`. - `sole_proprietor` SoleProprietor, required - `entity_id` string, required: Individual entity_id created for the sole proprietor. Data requirements for sole proprietors match those of an `authorized_signer`. - `rfi_details` RfiDetails - `result` 'requested' | 'completed', required: Result of request for information with the end customer. Leave blank if RFI has not been sent to the customer. - `requested_at` string, date-time, required: Date time RFI is requested at. - `ofac_details` OfacDetails: Details on OFAC on the entity. - `result` 'pending' | 'passed' | 'failed', required: OFAC result. Possible values: pending | passed | failed. - `screened_at` string, date-time, required: Date time OFAC screen is screened at. - `kyc_details` KycDetails: Details on KYC on the entity. - `result` 'pending' | 'passed' | 'failed', required: KYC result. Possible values: pending | passed | failed. - `screened_at` string, date-time, required: Date time KYC screen is screened at. - `credit_details` CreditDetails[] - `credit_score` string: Credit score given by the credit bureau. Cannot be above 850. Mutually exclusive with `credit_report_non_score_value`. - `credit_report_non_score_value` 'unestablished' | 'frozen': Indicates the state of a credit file when a numeric score is not available. - `credit_report_source` 'equifax' | 'experian' | 'transunion', required: The name of the credit bureau. - `credit_pulled_at` string, date-time, required: Date time credit is pulled at. - `intended_eligibility` EligibilityRelationshipType[]: The relationship types you intend this entity to hold. When you send it, Lead checks the entity's data against every listed type and rejects the request with `422 parameters_invalid` if any fails. The check is all or nothing, and the error returns every failing check, not just the first. Listing fewer types than the entity qualifies for still succeeds, and `eligibility` shows everything it qualifies for. If the check passes, Lead saves the list and returns it on the entity. On a `PATCH`, Lead checks the entity as it would be after the update, against the list you send or, if you leave the field out, the saved list. Send an empty array to clear the saved list; no check runs. - `eligibility` EligibilityV2, required: Whether the entity's current data qualifies it for each relationship type, with the failing checks. Response only. Lead computes it from current data on every read and never stores it. All four keys are always present. On a program that does not offer minor account holders, `minor_account_holder` is `ineligible` for every entity. - `account_holder` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `minor_account_holder` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `authorized_signer` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `authorized_user` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `metadata` Metadata: A set of key-value pairs that can be used to store additional information related to this object. - LeadEntityResponse: A `lead` entity. Lead provisions it during onboarding, and it holds your program's core accounts. It is read only: a `POST` with this type returns `422 parameters_invalid`, and a `PATCH` returns `422 operation_invalid`. It carries no KYC, OFAC, risk score, identification, documents, or linked entities. `account_holder` is always `eligible`; the other three relationship types are always `ineligible`, because only individuals can hold them. - `id` string, required: The ID of your entity. - `type` string, required: Type of entity = lead. Lead provisions it; you cannot create or update it. - `business_details` LeadPartnerBusinessDetails, required: Business details for a `lead` or `partner` entity. - `name` string, required: Legal name of the business. - `doing_business_as` string, nullable: The name the business operates under. Lead requires it on new `lead` and `partner` entities, so `null` appears only on older ones. - `address_details` object, required - `physical_address` Address, required - … - `eligibility` EligibilityV2, required: Whether the entity's current data qualifies it for each relationship type, with the failing checks. Response only. Lead computes it from current data on every read and never stores it. All four keys are always present. On a program that does not offer minor account holders, `minor_account_holder` is `ineligible` for every entity. - `account_holder` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `minor_account_holder` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `authorized_signer` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `authorized_user` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `metadata` Metadata: A set of key-value pairs that can be used to store additional information related to this object. - `created_at` string, date-time, required: Timestamp at which the entity object is created. - `updated_at` string, date-time, required: Timestamp at which the entity object was last updated. - PartnerEntityResponse: A `partner` entity. Lead provisions it during onboarding, and it holds your program's core accounts. It is read only: a `POST` with this type returns `422 parameters_invalid`, and a `PATCH` returns `422 operation_invalid`. It carries no KYC, OFAC, risk score, identification, documents, or linked entities. `account_holder` is always `eligible`; the other three relationship types are always `ineligible`, because only individuals can hold them. - `id` string, required: The ID of your entity. - `type` string, required: Type of entity = partner. Lead provisions it; you cannot create or update it. - `business_details` LeadPartnerBusinessDetails, required: Business details for a `lead` or `partner` entity. - `name` string, required: Legal name of the business. - `doing_business_as` string, nullable: The name the business operates under. Lead requires it on new `lead` and `partner` entities, so `null` appears only on older ones. - `address_details` object, required - `physical_address` Address, required - … - `eligibility` EligibilityV2, required: Whether the entity's current data qualifies it for each relationship type, with the failing checks. Response only. Lead computes it from current data on every read and never stores it. All four keys are always present. On a program that does not offer minor account holders, `minor_account_holder` is `ineligible` for every entity. - `account_holder` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `minor_account_holder` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `authorized_signer` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `authorized_user` EligibilityRelationshipV2, required - `status` 'eligible' | 'ineligible', required: Whether the entity's current data qualifies it for the relationship type. - `failed_checks` EligibilityFailedCheck[], required: The checks the entity fails for this relationship type. Empty when `status` is `eligible`. - … - `metadata` Metadata: A set of key-value pairs that can be used to store additional information related to this object. - `created_at` string, date-time, required: Timestamp at which the entity object is created. - `updated_at` string, date-time, required: Timestamp at which the entity object was last updated. ## Other responses - `400`: The request could not be parsed. - `403`: `code` is one of: `authentication_missing` (the request has no credentials), `token_invalid` (the bearer token is missing, expired, or invalid, or does not grant `entity/read` or `entity/read_write`), `source_ip_not_permitted` (the request came from an IP address that is not on your program's allowlist). - `422`: `code` is one of: `parameters_invalid` (`client_customer_id` is missing; `errors[].code` is `schema_violation`), `lead_control_restricted` (your program is not enabled for Entity v2; `errors[].code` is `feature_not_enabled`). - `429`: Rate limit exceeded. - `500`: Internal server error. - `503`: The service or endpoint is temporarily unavailable. Retry after a delay. - `504`: An upstream system did not respond in time. Retry with backoff. ## Changes - **2026-11-03** `2c659854496e`: 1 info - endpoint added [Operation history](https://skmtc.dev/lead/apis/lead-bank/changes/v2/entities/get.md) --- [API](https://skmtc.dev/lead/apis/lead-bank.md) - [All operations](https://skmtc.dev/lead/apis/lead-bank/llms.txt) - [OpenAPI document](https://skmtc.dev/lead/apis/lead-bank/revisions/2c659854496e?raw)