JUjustifi
Identity

Update an Identity

Update information about an Identity

patch/entities/identity/{id}

Request

Path parameters

idstring uuid required

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Request body

namestring

legal name

titlestring

job title

emailstring

email address

phonestring

phone number

dob_daystring

two-digit birth day

dob_monthstring

two-digit birth month

dob_yearstring

four-digit birth year (must be at least 18 years old)

identification_numberstring

full social security number

is_ownerboolean

if an identity owns 25% or more of the business, they are considered an owner

ownership_percentageinteger

percentage of the business owned by this identity (0–100); applies when is_owner is true

metadataobject

any useful information you'd like to store alongside this identity

Example request

{
  "name": "Person Name",
  "title": "President",
  "email": "person.name@justifi.ai",
  "phone": "6124011111",
  "dob_day": "01",
  "dob_month": "01",
  "dob_year": "1980",
  "identification_number": "123456789",
  "ownership_percentage": 25,
  "metadata": {
    "language": "english",
    "social_network": "@person"
  },
  "address": {
    "line1": "123 Example St",
    "line2": "Suite 101",
    "city": "Minneapolis",
    "state": "MN",
    "postal_code": "55555",
    "country": "USA"
  }
}

Response

Identity updated

idstring uuid

the object id, also found in the data object

typestring

the object type, or array of objects

page_infounknown

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "identity",
  "data": {
    "id": "idty_xyz",
    "platform_account_id": "acc_xyz",
    "business_id": "biz_xyz",
    "name": "Person Name",
    "title": "President",
    "email": "person.name@justifi.ai",
    "phone": "6124011111",
    "dob_day": "01",
    "dob_month": "01",
    "dob_year": "1980",
    "ssn_last4": "6789",
    "is_owner": true,
    "ownership_percentage": 25,
    "address": {
      "id": "addr_123xyz",
      "platform_account_id": "acc_123xyz",
      "line1": "123 Example St",
      "line2": "Suite 101",
      "city": "Minneapolis",
      "state": "MN",
      "postal_code": "55555",
      "country": "USA",
      "created_at": "2021-01-01T12:00:00Z",
      "updated_at": "2021-01-01T12:00:00Z"
    },
    "documents": [
      {
        "id": "doc_abc123",
        "platform_account_id": "acc_123xyz",
        "description": "My Document",
        "file_name": "my_document",
        "file_type": "pdf",
        "document_type": "balance_sheet",
        "business_id": "biz_abc123",
        "identity_id": "idty_abc123",
        "presigned_url": "https://test.test/doc_abc123/file_name.pdf",
        "metadata": {
          "language": "english",
          "social_network": "@person"
        },
        "created_at": "2021-01-01T12:00:00Z",
        "updated_at": "2021-01-01T12:00:00Z"
      }
    ],
    "created_at": "2021-01-01T12:00:00Z",
    "updated_at": "2021-01-01T12:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.