LElead
Entity

Create an entity

Changed on

Create an Individual, Sole Prop or Business Entity.

post/v0/entities

Request

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

Headers

Idempotency-Keystring required

Idempotency key

Request body

OR
OR

Example request

{
  "intended_roles": [
    "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": [
        {
          "type": "drivers_license"
        }
      ]
    },
    "additional_documents": [
      {
        "type": "bank_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

{
  "intended_roles": [
    "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": [
        {
          "type": "drivers_license"
        }
      ]
    },
    "additional_documents": [
      {
        "type": "bank_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"
    }
  ],
  "role_details": [
    {
      "name": "account_holder",
      "status": "active"
    }
  ]
}

Changes

  • 2c659854496eRevision changes
    • warning

      added the new minor_account_holder enum value to the // response property for the response status

    • warning

      added the new minor_account_holder enum value to the /// response property for the response status

    • warning

      added the new minor_account_holder enum value to the // response property for the response status

    • warning

      added the new minor_account_holder enum value to the /// response property for the response status

    • warning

      added the new minor_account_holder enum value to the // response property for the response status

    • warning

      added the new minor_account_holder enum value to the /// response property for the response status

    • info

      added individual business sole_prop mapping keys to the request discriminator

    • info

      added email phone_number discriminator mapping keys to the /// request property

    • info

      added email phone_number discriminator mapping keys to the /// request property

    • info

      added email phone_number discriminator mapping keys to the /// request property

    • info

      added us_entity non_us_entity discriminator mapping keys to the // request property

    • info

      added us_entity non_us_entity discriminator mapping keys to the // request property

    • info

      added us_entity non_us_entity discriminator mapping keys to the // request property

    • info

      added the new minor_account_holder enum value to the request property //

    • info

      added the new minor_account_holder enum value to the request property //

    • info

      added the new minor_account_holder enum value to the request property //

    • info

      added individual business sole_prop mapping keys to the response discriminator for the response status

    • info

      added email phone_number discriminator mapping keys to the /// response property for the response status

    • info

      added email phone_number discriminator mapping keys to the /// response property for the response status

    • info

      added email phone_number discriminator mapping keys to the /// response property for the response status

    • info

      added us_entity non_us_entity discriminator mapping keys to the // response property for the response status

    • info

      added us_entity non_us_entity discriminator mapping keys to the // response property for the response status

    • info

      added us_entity non_us_entity discriminator mapping keys to the // response property for the response status