Account Number9

ACH7

Application5

Blockchain Payment3

Compliance22

Core Account2

Core Balance2

Core Transaction2

Entity8

Events2

Files2

Funding6

Instant Payments8

Internal Transfer3

Lending3

Lending Simulation1

OAuth1

Originator7

Receivable2

Receivable Sale2

Simulation21

Subledger Balances2

User Account10

User Credit Balance7

User Credit Transaction4

Wire16

Entity

Update an entity

Changed on Nov 3, 2026

Certain updates on Entity trigger KYC re-screening, requiring an updated kyc_details.result and kyc_details.screened_at.

For individual entities, KYC re-screening is triggered by changes to: first name, last name, date of birth, tax ID value, switching between us_entity and non_us_entity when that adds or removes a tax ID, and an existing identification document (for non-US entities). The requirement applies only when kyc_details has previously been submitted for the entity, and the new kyc_details.screened_at must be later than the previous one.

For business and sole proprietorship entities, KYC re-screening is triggered by changes to: business name, business type, tax ID (US entities), and existing identification document (non-US entities).

Note: Business and sole proprietors cannot switch between US and non-US entities. A new entity must be created in such case.

patch/v0/entities/{id}

Request

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

Path parameters

idstring required

Entity ID

Headers

Idempotency-Keystring required

Idempotency key

Request body

Example request

{
  "intended_roles": [
    "account_holder"
  ],
  "risk_score": "low",
  "individual_details": {
    "first_name": "Lucy",
    "preferred_first_name": "Lu",
    "middle_name": "Reginald",
    "last_name": "Collins",
    "date_of_birth": "2002-02-15",
    "occupation": "Author",
    "contact_methods": [
      {
        "email": "abc@gmail.com"
      }
    ],
    "address_details": {
      "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 updated.

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

Nov 3, 20262c659854496e Revision 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

Operation history