Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Entity

Update an entity

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 (for US entities), existing identification document (for non-US entities), and switching between US vs. non-US entities.

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}

Path parameters

idstring required

Entity ID

Headers

Idempotency-Keystring required

Idempotency key

Request body

OR
OR

Example request

{
  "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"
        }
      ]
    }
  }
}

Response

Entity object updated.

OR
OR

Example response

{
  "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"
        }
      ]
    }
  },
  "role_details": [
    {
      "status": "active"
    }
  ]
}