LElead
Entity

Retrieve an entity by client customer ID

Changed on

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.

get/v2/entities

Request

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

Query parameters

client_customer_idstring required

The client_customer_id of the entity to retrieve.

Response

A list with the matching entity in objects. objects is empty if no entity matches.

has_moreboolean required

Whether more results are available after this page.

Example response

{
  "objects": [
    {
      "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