LElead
Entity

Retrieve an entity

Changed on

Retrieve an Entity by its ID. Entities created on v0 are returned in this shape. eligibility is computed from the Entity's current data on every read. This also returns your program's lead and partner Entities, which Lead provisions and which have a reduced, read-only shape. Documents sent through v0 are returned read-only in legacy_identification_documents and legacy_additional_documents.

get/v2/entities/{id}

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v2/entities/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of your entity.

Example:entity_xyz123

Response

An entity object.

OR
OR
OR
OR

Example response

{
  "id": "entity_xyz123",
  "risk_score": "low",
  "individual_details": {
    "date_of_birth": "2002-02-15",
    "contact_methods": [
      {
        "email": "abc@gmail.com"
      }
    ],
    "address_details": {
      "physical_address": {
        "line_1": "123 Main St.",
        "line_2": "Apt 25",
        "city": "Denver",
        "state": "CO",
        "country": "US"
      },
      "mailing_address": {
        "line_1": "123 Main St.",
        "line_2": "Apt 25",
        "city": "Denver",
        "state": "CO",
        "country": "US"
      },
      "other_addresses": [
        {
          "line_1": "123 Main St.",
          "line_2": "Apt 25",
          "city": "Denver",
          "state": "CO",
          "country": "US"
        }
      ]
    },
    "identification_details": {
      "tax_identification": {
        "type": "ssn"
      },
      "identification_documents": [
        {
          "file_id": "file_7Tq4mR9vKx2LpW8nZc3B",
          "identification_number": "X1234567",
          "issuing_country": "GB",
          "expiration_date": "2030-06-01"
        },
        {
          "type": "passport",
          "identification_number": "X7654321",
          "issuing_country": "GB",
          "expiration_date": "2031-01-15"
        }
      ],
      "legacy_identification_documents": [
        {
          "client_document_id": "passport_jane_doe.pdf",
          "type": "passport",
          "identification_number": "X1234567",
          "issuing_country": "GB",
          "expiration_date": "2026-06-01"
        }
      ]
    },
    "additional_documents": [
      {
        "file_id": "file_X5jD8hN2sQ6yFb1Gt9Ka"
      },
      {
        "type": "financial_statement"
      }
    ],
    "legacy_additional_documents": [
      {
        "client_document_id": "2026_01_02_statement",
        "type": "bank_statement",
        "description": "Bank statement for January"
      }
    ]
  },
  "rfi_details": {
    "result": "completed"
  },
  "ofac_details": {
    "result": "passed"
  },
  "kyc_details": {
    "result": "passed"
  },
  "credit_details": [
    {
      "credit_report_non_score_value": "unestablished",
      "credit_report_source": "equifax"
    }
  ],
  "intended_eligibility": [
    "account_holder"
  ],
  "eligibility": {
    "account_holder": {
      "status": "eligible",
      "failed_checks": []
    },
    "minor_account_holder": {
      "status": "ineligible",
      "failed_checks": [
        {
          "check": "check_date_of_birth_above_maximum",
          "entity_id": "entity_xyz123",
          "reason": "The entity exceeds the maximum age for minor_account_holder."
        }
      ]
    },
    "authorized_signer": {
      "status": "eligible",
      "failed_checks": []
    },
    "authorized_user": {
      "status": "eligible",
      "failed_checks": []
    }
  }
}

Changes