Skip to main content
GET
Retrieve an entity

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The ID of your entity.

Pattern: ^entity_[^\s]{1,33}$
Example:

"entity_xyz123"

Response

An entity object.

id
string
required

Unique ID for the Entity object.

Pattern: ^entity_[^\s]{1,33}$
Example:

"entity_xyz123"

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
default:individual
required

Type of entity = individual.

Pattern: ^individual$
individual_details
object
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.

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

Example:
client_customer_id
string

Your customer ID, on entities created on v0 or through Entity files. Response only. Lead ignores it if sent, and does not return it on other entities.

risk_score
enum<string>

The entity's risk score, mapped to Lead by the client. Client should have provided risk score mapping to Lead.

Available options:
low,
medium,
high
Example:

"low"

rfi_details
object
ofac_details
object

Details on OFAC on the entity.

kyc_details
object

Details on KYC on the entity.

credit_details
object[]
intended_eligibility
enum<string>[]

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.

A relationship type an entity can hold.

  • account_holder: Full control of, and legal responsibility for, the account.
  • minor_account_holder: An individual aged 16 or 17 with account holder eligibility.
  • authorized_signer: An individual allowed to sign on behalf of the account holder, without legal responsibility.
  • authorized_user: An individual with restricted access to the account, without legal responsibility.
Available options:
account_holder,
minor_account_holder,
authorized_signer,
authorized_user
Example:
metadata
object

A set of key-value pairs that can be used to store additional information related to this object.