> For the complete documentation index, see [llms.txt](https://docs.imperialcad.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.imperialcad.app/api-and-integrations/api-integrations/civilian-endpoints/get-full-character.md).

# Get Full Character

This endpoint allows you to retrieve nearly all civilian character data from ImperialCAD.

{% hint style="warning" %}
This endpoint requires **an Advanced** ImperialCAD subscription or higher.
{% endhint %}

### GetFullCharacter

`GET` `https://imperialcad.app/api/1.1/wf/GetFullCharacter`

***

### Query Parameters

| Name     | Type   | Required | Description                                       |
| -------- | ------ | -------- | ------------------------------------------------- |
| `commId` | string | Yes      | Your ImperialCAD community ID                     |
| `charid` | string | Yes      | The character ID or SSN of the civilian character |

***

### Searching by SSN

The `charid` query parameter can accept either a valid ImperialCAD character ID or a character SSN.

Characters created through the API may have a generated character ID attached to them. If you already have that character ID, you can pass it directly through the `charid` parameter.

If you do not have the character ID, you may pass the character’s SSN instead.

When an SSN is used for the lookup, the API will include the following field at the bottom of the response:

```
{  "ssn_search?": true}
```

This indicates that the character was found using an SSN search instead of a direct character ID lookup.

***

{% tabs %}
{% tab title="Example" %}

```lua
https://imperialcad.app/api/1.1/wf/GetFullCharacter?charid=idhere&commId=idhere
```

{% endtab %}

{% tab title="Response of Example" %}

```lua
{
  "status": "success",
  "response": {
    "charid": "LVL72167",
    "first_name": "Robert",
    "last_name": "Martin",
    "dob": "7/06/73",
    "gender": "MALE",
    "race": "White",
    "hair_color": "Blue",
    "eye_color": "nil",
    "height": "6'",
    "weight": 150,
    "address": "Nowhere rd",
    "city": "nil",
    "county": "nil",
    "is_deceased": false,
    "is_missing": false,
    "has_dl": true,
    "dl_status": "ACTIVE",
    "dl_number": "D32505223",
    "has_cdl": true,
    "cdl_status": "EXPIRED",
    "cdl_number": "A34564409",
    "has_boat_license": false,
    "has_hunt_license": false,
    "has_firearms_certificate": false,
    "insurance_status": "ACTIVE",
    "insurance_policy": "NIJZPPL83V2",
    "ssn": "174388325",
    "has_fishing_license": false,
    "MetaBoolean1": false,
    "MetaBoolean2": false,
    "ssn_search?": true
  }
}
```

{% endtab %}
{% endtabs %}