Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Entity

Retrieve an entity by client customer id

Retrieve an entity by the client customer id

get/v0/entities

Query parameters

client_customer_idstring required

Client Customer ID of the entity object you want to retrieve.

Response

An entity object.

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