LElead
Entity

Create an entity

Changed on

Create an individual, business, or sole_prop Entity. lead and partner Entities are provisioned by Lead and cannot be created, so a POST with either type returns 422 parameters_invalid.

Each entry in identification_documents and additional_documents takes a file_id from POST /v2/files or a declared type, not both.

post/v2/entities

Request

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

Headers

Idempotency-Keystring required

A unique key for this request, up to 255 characters. Retrying with the same key and body returns the original response without creating a second entity. See Idempotency.

Request body

OR
OR

Example request

{
  "intended_eligibility": [
    "account_holder"
  ],
  "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"
        }
      ]
    },
    "additional_documents": [
      {
        "file_id": "file_X5jD8hN2sQ6yFb1Gt9Ka"
      },
      {
        "type": "financial_statement"
      }
    ]
  },
  "rfi_details": {
    "result": "completed"
  },
  "ofac_details": {
    "result": "passed"
  },
  "kyc_details": {
    "result": "passed"
  },
  "credit_details": [
    {
      "credit_report_non_score_value": "unestablished",
      "credit_report_source": "equifax"
    }
  ]
}

Response

Entity object created.

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