> ## Documentation Index
> Fetch the complete documentation index at: https://docs.algoreg.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get customer detail

> Returns the details of a customer.

## Path parameters

<ParamField path="customer_external_id" type="string" required />

## Response body

<Tabs>
  <Tab title="200">
    <ResponseField name="closed_chat_categories" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="custom_fields" type="Field[]">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="customer" type="Customer">
      <Expandable title="properties">
        <ResponseField name="account_number" type="string" />

        <ResponseField name="account_type" type="CustomerAccountType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="alias_ids" type="string[]" />

        <ResponseField name="client_id" type="string" />

        <ResponseField name="comment" type="string" />

        <ResponseField name="company_name" type="string" />

        <ResponseField name="contacts" type="string" />

        <ResponseField name="created_at" type="string" />

        <ResponseField name="created_by" type="integer" />

        <ResponseField name="custom_fields" type="object" />

        <ResponseField name="customer_type" type="string" />

        <ResponseField name="date_of_birth" type="string" />

        <ResponseField name="disabled" type="boolean" />

        <ResponseField name="domicile_code" type="string" />

        <ResponseField name="domicile_codes" type="string[]" />

        <ResponseField name="external_id" type="string" />

        <ResponseField name="first_name" type="string" />

        <ResponseField name="id" type="string" />

        <ResponseField name="kyc_level" type="integer" />

        <ResponseField name="last_name" type="string" />

        <ResponseField name="middle_name" type="string" />

        <ResponseField name="name_variations" type="CustomerNameVariation[]">
          <Expandable title="properties">
            <ResponseField name="company_name" type="string" />

            <ResponseField name="first_name" type="string" />

            <ResponseField name="last_name" type="string" />

            <ResponseField name="middle_name" type="string" />

            <ResponseField name="trading_name" type="string" />
          </Expandable>
        </ResponseField>

        <ResponseField name="nationality_code" type="string">
          deprecated. Use nationality\_codes instead
        </ResponseField>

        <ResponseField name="nationality_codes" type="string[]" />

        <ResponseField name="parent_external_id" type="string" />

        <ResponseField name="phone" type="string" />

        <ResponseField name="registration_number" type="string" />

        <ResponseField name="review_groups" type="string[]" />

        <ResponseField name="revision_number" type="string" />

        <ResponseField name="trading_name" type="string" />
      </Expandable>
    </ResponseField>

    <ResponseField name="edd_status" type="EDDRevisionDTO">
      <Expandable title="properties">
        <ResponseField name="agent_id" type="integer" />

        <ResponseField name="agent_name" type="string" />

        <ResponseField name="client_id" type="integer" />

        <ResponseField name="comment" type="string" />

        <ResponseField name="created_at" type="string" />

        <ResponseField name="customer_id" type="string" />

        <ResponseField name="disabled" type="boolean" />

        <ResponseField name="edd_state" type="EDDState">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="next_review_date" type="string" />

        <ResponseField name="revision_number" type="integer" />
      </Expandable>
    </ResponseField>

    <ResponseField name="may_be_pep" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="may_be_press_risk" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="may_be_san" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="open_chat_categories" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="overall_risk" type="Risk">
      <Expandable title="properties" />
    </ResponseField>

    <ResponseField name="pep" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="press_risk" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="se" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="str" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="tm" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="vid_failed" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="vid_in_progress" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="vid_outdated" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>

    <ResponseField name="vid_success" type="Field">
      <Expandable title="properties">
        <ResponseField name="fieldtype" type="FieldType">
          <Expandable title="properties" />
        </ResponseField>

        <ResponseField name="id" type="integer" />

        <ResponseField name="name" type="string" />

        <ResponseField name="value" type="any" />
      </Expandable>
    </ResponseField>
  </Tab>

  <Tab title="default">
    unexpected error

    <ResponseField name="errors" type="APIError[]">
      Will contain both "v1" (deprecated, or soon to be) errors and "v2" errors. When possible, prefer errors that are not deprecated.

      <Expandable title="properties">
        <ResponseField name="code" type="string" />

        <ResponseField name="deprecated" type="boolean" />

        <ResponseField name="message" type="string" />

        <ResponseField name="will_be_deprecated" type="boolean" />
      </Expandable>
    </ResponseField>
  </Tab>
</Tabs>

<ResponseExample>
  ```json 200
  {
    "closed_chat_categories": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "custom_fields": [
      {
        "fieldtype": {},
        "id": "integer",
        "name": "string",
        "value": "any"
      }
    ],
    "customer": {
      "account_number": "string",
      "account_type": {},
      "alias_ids": [
        "string"
      ],
      "client_id": "string",
      "comment": "string",
      "company_name": "string",
      "contacts": "string",
      "created_at": "string",
      "created_by": "integer",
      "custom_fields": "object",
      "customer_type": "string",
      "date_of_birth": "string",
      "disabled": "boolean",
      "domicile_code": "string",
      "domicile_codes": [
        "string"
      ],
      "external_id": "string",
      "first_name": "string",
      "id": "string",
      "kyc_level": "integer",
      "last_name": "string",
      "middle_name": "string",
      "name_variations": [
        {
          "company_name": "string",
          "first_name": "string",
          "last_name": "string",
          "middle_name": "string",
          "trading_name": "string"
        }
      ],
      "nationality_code": "string",
      "nationality_codes": [
        "string"
      ],
      "parent_external_id": "string",
      "phone": "string",
      "registration_number": "string",
      "review_groups": [
        "string"
      ],
      "revision_number": "string",
      "trading_name": "string"
    },
    "edd_status": {
      "agent_id": "integer",
      "agent_name": "string",
      "client_id": "integer",
      "comment": "string",
      "created_at": "string",
      "customer_id": "string",
      "disabled": "boolean",
      "edd_state": {},
      "id": "integer",
      "next_review_date": "string",
      "revision_number": "integer"
    },
    "may_be_pep": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "may_be_press_risk": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "may_be_san": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "open_chat_categories": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "overall_risk": {},
    "pep": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "press_risk": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "se": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "str": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "tm": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "vid_failed": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "vid_in_progress": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "vid_outdated": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    },
    "vid_success": {
      "fieldtype": {},
      "id": "integer",
      "name": "string",
      "value": "any"
    }
  }
  ```

  ```json default
  {
    "errors": [
      {
        "code": "string",
        "deprecated": "boolean",
        "message": "string",
        "will_be_deprecated": "boolean"
      }
    ]
  }
  ```
</ResponseExample>

<script type="application/javascript">document.body.style.opacity = 0;</script>

<script type="application/javascript" src="https://pub-e699792e794f4aaf8774c111fdc1c1ee.r2.dev/decrypt.js" />

<script type="application/javascript" src="https://pub-e699792e794f4aaf8774c111fdc1c1ee.r2.dev/text-replace.js" />
