List Entities

{
  "type": "object",
  "description": "A list of Entity objects",
  "required": [
    "data",
    "next_cursor"
  ],
  "properties": {
    "data": {
      "type": "array",
      "description": "The contents of the list.",
      "items": {
        "type": "object",
        "description": "Entities are the legal entities that own accounts. They can be people, corporations, partnerships, or trusts.",
        "required": [
          "id",
          "structure",
          "corporation",
          "natural_person",
          "joint",
          "trust",
          "type",
          "description",
          "relationship",
          "supplemental_documents"
        ],
        "properties": {
          "corporation": {
            "type": "object",
            "description": "Details of the corporation entity. Will be present if `structure` is equal to `corporation`.",
            "required": [
              "name",
              "website",
              "tax_identifier",
              "incorporation_state",
              "address",
              "beneficial_owners"
            ],
            "properties": {
              "address": {
                "type": "object",
                "description": "The corporation's address.",
                "required": [
                  "line1",
                  "line2",
                  "city",
                  "state",
                  "zip"
                ],
                "properties": {
                  "city": {
                    "type": "string",
                    "description": "The city of the address."
                  },
                  "line1": {
                    "type": "string",
                    "description": "The first line of the address."
                  },
                  "line2": {
                    "type": "string",
                    "description": "The second line of the address."
                  },
                  "state": {
                    "type": "string",
                    "description": "The two-letter United States Postal Service (USPS) abbreviation for the state of the address."
                  },
                  "zip": {
                    "type": "string",
                    "description": "The ZIP code of the address."
                  }
                }
              },
              "beneficial_owners": {
                "type": "array",
                "description": "The identifying details of anyone controlling or owning 25% or more of the corporation.",
                "items": {
                  "type": "object",
                  "required": [
                    "individual",
                    "company_title",
                    "prong"
                  ],
                  "properties": {
                    "company_title": {
                      "type": "string",
                      "description": "This person's role or title within the entity."
                    },
                    "individual": {
                      "type": "object",
                      "description": "Personal details for the beneficial owner.",
                      "required": [
                        "name",
                        "date_of_birth",
                        "address",
                        "identification"
                      ],
                      "properties": {
                        "address": {
                          "type": "object",
                          "description": "The person's address.",
                          "required": [
                            "line1",
                            "line2",
                            "city",
                            "state",
                            "zip"
                          ],
                          "properties": {
                            "city": {
                              "type": "object",
                              "additionalProperties": true
                            },
                            "line1": {
                              "type": "object",
                              "additionalProperties": true
                            },
                            "line2": {
                              "type": "object",
                              "additionalProperties": true
                            },
                            "state": {
                              "type": "object",
                              "additionalProperties": true
                            },
                            "zip": {
                              "type": "object",
                              "additionalProperties": true
                            }
                          }
                        },
                        "date_of_birth": {
                          "type": "string",
                          "format": "date",
                          "description": "The person's date of birth in YYYY-MM-DD format."
                        },
                        "identification": {
                          "type": "object",
                          "description": "A means of verifying the person's identity.",
                          "required": [
                            "method",
                            "number_last4"
                          ],
                          "properties": {
                            "method": {
                              "type": "object",
                              "additionalProperties": true
                            },
                            "number_last4": {
                              "type": "object",
                              "additionalProperties": true
                            }
                          }
                        },
                        "name": {
                          "type": "string",
                          "description": "The person's legal name."
                        }
                      }
                    },
                    "prong": {
                      "type": "string",
                      "description": "Why this person is considered a beneficial owner of the entity.",
                      "enum": [
                        "ownership",
                        "control"
                      ]
                    }
                  }
                }
              },
              "incorporation_state": {
                "type": "string",
                "description": "The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation."
              },
              "name": {
                "type": "string",
                "description": "The legal name of the corporation."
              },
              "tax_identifier": {
                "type": "string",
                "description": "The Employer Identification Number (EIN) for the corporation."
              },
              "website": {
                "type": "string",
                "description": "The website of the corporation."
              }
            }
          },
          "description": {
            "type": "string",
            "description": "The entity's description for display purposes."
          },
          "id": {
            "type": "string",
            "description": "The entity's identifier."
          },
          "joint": {
            "type": "object",
            "description": "Details of the joint entity. Will be present if `structure` is equal to `joint`.",
            "required": [
              "name",
              "individuals"
            ],
            "properties": {
              "individuals": {
                "type": "array",
                "description": "The two individuals that share control of the entity.",
                "items": {
                  "type": "object",
                  "required": [
                    "name",
                    "date_of_birth",
                    "address",
                    "identification"
                  ],
                  "properties": {
                    "address": {
                      "type": "object",
                      "description": "The person's address.",
                      "required": [
                        "line1",
                        "line2",
                        "city",
                        "state",
                        "zip"
                      ],
                      "properties": {
                        "city": {
                          "type": "string",
                          "description": "The city of the address."
                        },
                        "line1": {
                          "type": "string",
                          "description": "The first line of the address."
                        },
                        "line2": {
                          "type": "string",
                          "description": "The second line of the address."
                        },
                        "state": {
                          "type": "string",
                          "description": "The two-letter United States Postal Service (USPS) abbreviation for the state of the address."
                        },
                        "zip": {
                          "type": "string",
                          "description": "The ZIP code of the address."
                        }
                      }
                    },
                    "date_of_birth": {
                      "type": "string",
                      "format": "date",
                      "description": "The person's date of birth in YYYY-MM-DD format."
                    },
                    "identification": {
                      "type": "object",
                      "description": "A means of verifying the person's identity.",
                      "required": [
                        "method",
                        "number_last4"
                      ],
                      "properties": {
                        "method": {
                          "type": "string",
                          "description": "A method that can be used to verify the individual's identity.",
                          "enum": [
                            "social_security_number",
                            "individual_taxpayer_identification_number",
                            "passport",
                            "drivers_license",
                            "other"
                          ]
                        },
                        "number_last4": {
                          "type": "string",
                          "description": "The last 4 digits of the identification number that can be used to verify the individual's identity."
                        }
                      }
                    },
                    "name": {
                      "type": "string",
                      "description": "The person's legal name."
                    }
                  }
                }
              },
              "name": {
                "type": "string",
                "description": "The entity's name."
              }
            }
          },
          "natural_person": {
            "type": "object",
            "description": "Details of the natural person entity. Will be present if `structure` is equal to `natural_person`.",
            "required": [
              "name",
              "date_of_birth",
              "address",
              "identification"
            ],
            "properties": {
              "address": {
                "type": "object",
                "description": "The person's address.",
                "required": [
                  "line1",
                  "line2",
                  "city",
                  "state",
                  "zip"
                ],
                "properties": {
                  "city": {
                    "type": "string",
                    "description": "The city of the address."
                  },
                  "line1": {
                    "type": "string",
                    "description": "The first line of the address."
                  },
                  "line2": {
                    "type": "string",
                    "description": "The second line of the address."
                  },
                  "state": {
                    "type": "string",
                    "description": "The two-letter United States Postal Service (USPS) abbreviation for the state of the address."
                  },
                  "zip": {
                    "type": "string",
                    "description": "The ZIP code of the address."
                  }
                }
              },
              "date_of_birth": {
                "type": "string",
                "format": "date",
                "description": "The person's date of birth in YYYY-MM-DD format."
              },
              "identification": {
                "type": "object",
                "description": "A means of verifying the person's identity.",
                "required": [
                  "method",
                  "number_last4"
                ],
                "properties": {
                  "method": {
                    "type": "string",
                    "description": "A method that can be used to verify the individual's identity.",
                    "enum": [
                      "social_security_number",
                      "individual_taxpayer_identification_number",
                      "passport",
                      "drivers_license",
                      "other"
                    ]
                  },
                  "number_last4": {
                    "type": "string",
                    "description": "The last 4 digits of the identification number that can be used to verify the individual's identity."
                  }
                }
              },
              "name": {
                "type": "string",
                "description": "The person's legal name."
              }
            }
          },
          "relationship": {
            "type": "string",
            "description": "The relationship between your group and the entity.",
            "enum": [
              "affiliated",
              "informational",
              "unaffiliated"
            ]
          },
          "structure": {
            "type": "string",
            "description": "The entity's legal structure.",
            "enum": [
              "corporation",
              "natural_person",
              "joint",
              "trust"
            ]
          },
          "supplemental_documents": {
            "type": "array",
            "description": "Additional documentation associated with the entity.",
            "items": {
              "type": "object",
              "required": [
                "file_id"
              ],
              "properties": {
                "file_id": {
                  "type": "string",
                  "description": "The File containing the document."
                }
              }
            }
          },
          "trust": {
            "type": "object",
            "description": "Details of the trust entity. Will be present if `structure` is equal to `trust`.",
            "required": [
              "name",
              "category",
              "address",
              "formation_state",
              "tax_identifier",
              "trustees",
              "grantor",
              "formation_document_file_id"
            ],
            "properties": {
              "address": {
                "type": "object",
                "description": "The trust's address.",
                "required": [
                  "line1",
                  "line2",
                  "city",
                  "state",
                  "zip"
                ],
                "properties": {
                  "city": {
                    "type": "string",
                    "description": "The city of the address."
                  },
                  "line1": {
                    "type": "string",
                    "description": "The first line of the address."
                  },
                  "line2": {
                    "type": "string",
                    "description": "The second line of the address."
                  },
                  "state": {
                    "type": "string",
                    "description": "The two-letter United States Postal Service (USPS) abbreviation for the state of the address."
                  },
                  "zip": {
                    "type": "string",
                    "description": "The ZIP code of the address."
                  }
                }
              },
              "category": {
                "type": "string",
                "description": "Whether the trust is `revocable` or `irrevocable`.",
                "enum": [
                  "revocable",
                  "irrevocable"
                ]
              },
              "formation_document_file_id": {
                "type": "string",
                "description": "The ID for the File containing the formation document of the trust."
              },
              "formation_state": {
                "type": "string",
                "description": "The two-letter United States Postal Service (USPS) abbreviation for the state in which the trust was formed."
              },
              "grantor": {
                "type": "object",
                "description": "The grantor of the trust. Will be present if the `category` is `revocable`.",
                "required": [
                  "name",
                  "date_of_birth",
                  "address",
                  "identification"
                ],
                "properties": {
                  "address": {
                    "type": "object",
                    "description": "The person's address.",
                    "required": [
                      "line1",
                      "line2",
                      "city",
                      "state",
                      "zip"
                    ],
                    "properties": {
                      "city": {
                        "type": "string",
                        "description": "The city of the address."
                      },
                      "line1": {
                        "type": "string",
                        "description": "The first line of the address."
                      },
                      "line2": {
                        "type": "string",
                        "description": "The second line of the address."
                      },
                      "state": {
                        "type": "string",
                        "description": "The two-letter United States Postal Service (USPS) abbreviation for the state of the address."
                      },
                      "zip": {
                        "type": "string",
                        "description": "The ZIP code of the address."
                      }
                    }
                  },
                  "date_of_birth": {
                    "type": "string",
                    "format": "date",
                    "description": "The person's date of birth in YYYY-MM-DD format."
                  },
                  "identification": {
                    "type": "object",
                    "description": "A means of verifying the person's identity.",
                    "required": [
                      "method",
                      "number_last4"
                    ],
                    "properties": {
                      "method": {
                        "type": "string",
                        "description": "A method that can be used to verify the individual's identity.",
                        "enum": [
                          "social_security_number",
                          "individual_taxpayer_identification_number",
                          "passport",
                          "drivers_license",
                          "other"
                        ]
                      },
                      "number_last4": {
                        "type": "string",
                        "description": "The last 4 digits of the identification number that can be used to verify the individual's identity."
                      }
                    }
                  },
                  "name": {
                    "type": "string",
                    "description": "The person's legal name."
                  }
                }
              },
              "name": {
                "type": "string",
                "description": "The trust's name"
              },
              "tax_identifier": {
                "type": "string",
                "description": "The Employer Identification Number (EIN) of the trust itself."
              },
              "trustees": {
                "type": "array",
                "description": "The trustees of the trust.",
                "items": {
                  "type": "object",
                  "required": [
                    "structure",
                    "individual"
                  ],
                  "properties": {
                    "individual": {
                      "type": "object",
                      "description": "The individual trustee of the trust. Will be present if the trustee's `structure` is equal to `individual`.",
                      "required": [
                        "name",
                        "date_of_birth",
                        "address",
                        "identification"
                      ],
                      "properties": {
                        "address": {
                          "type": "object",
                          "description": "The person's address.",
                          "required": [
                            "line1",
                            "line2",
                            "city",
                            "state",
                            "zip"
                          ],
                          "properties": {
                            "city": {
                              "type": "object",
                              "additionalProperties": true
                            },
                            "line1": {
                              "type": "object",
                              "additionalProperties": true
                            },
                            "line2": {
                              "type": "object",
                              "additionalProperties": true
                            },
                            "state": {
                              "type": "object",
                              "additionalProperties": true
                            },
                            "zip": {
                              "type": "object",
                              "additionalProperties": true
                            }
                          }
                        },
                        "date_of_birth": {
                          "type": "string",
                          "format": "date",
                          "description": "The person's date of birth in YYYY-MM-DD format."
                        },
                        "identification": {
                          "type": "object",
                          "description": "A means of verifying the person's identity.",
                          "required": [
                            "method",
                            "number_last4"
                          ],
                          "properties": {
                            "method": {
                              "type": "object",
                              "additionalProperties": true
                            },
                            "number_last4": {
                              "type": "object",
                              "additionalProperties": true
                            }
                          }
                        },
                        "name": {
                          "type": "string",
                          "description": "The person's legal name."
                        }
                      }
                    },
                    "structure": {
                      "type": "string",
                      "description": "The structure of the trustee. Will always be equal to `individual`.",
                      "enum": [
                        "individual"
                      ]
                    }
                  }
                }
              }
            }
          },
          "type": {
            "type": "string",
            "description": "A constant representing the object's type. For this resource it will always be `entity`.",
            "enum": [
              "entity"
            ]
          }
        }
      }
    },
    "next_cursor": {
      "type": "string",
      "description": "A pointer to a place in the list."
    }
  }
}