> For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/available-plugins/api-id-checker.md).

# Check API ID

{% hint style="info" %}
**This submodule has been merged into the SonoranCAD Core and no longer requires external configuration or setup**
{% endhint %}

## Usage

### Command

This submodule supplies the command `/apiid` which will print the player's primary identifier (the one they should use in Settings) to their console.

### Function

Callback output parameter: true/false if API ID exists.

```lua
cadApiIdExists("identifier_here", callback)
```

#### Example

```lua
cadApiIdExists("steam:1234567890", function(exists)
    if exists then
        print("API ID exists!")
    else
        print("API ID does not exist!")
    end
end)
```

### Event

This is a *server only* event.

**Event Name:** SonoranCAD::apicheck:CheckPlayerLinked

**Response Event:** SonoranCAD::apicheck:CheckPlayerLinkedResponse

#### Example

```lua
-- Request
TriggerEvent("SonoranCAD::apicheck:CheckPlayerLinked", source, identifier)

-- Response
AddEventHandler("SonoranCAD::apicheck:CheckPlayerLinkedResponse", function(player, identifier, exists)
    print(("Player %s has API ID? %s"):format(player, exists))
end)
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/available-plugins/api-id-checker.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.