---
name: "mongoc_client_encryption_get_key"
section: "3"
platform: "linux"
package: "libmongoc-doc"
version: "1.30.4-1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/mongoc_client_encryption_get_key"
---

# mongoc\_client\_encryption\_get\_key(3)

## SYNOPSIS

```
bool
mongoc_client_encryption_get_key (mongoc_client_encryption_t *client_encryption,
                                  const bson_value_t *keyid,
                                  bson_t *key_doc,
                                  bson_error_t *error);
```

Get a key document in the key vault collection that has the given **keyid**.

## PARAMETERS

- •

  **client\_encryption**: A *mongoc\_client\_encryption\_t*.

- •

  **keyid**: The UUID (BSON binary subtype 0x04) of the key to get.

- •

  **key\_doc**: Optional. An uninitialized *bson\_t* set to the resulting key document, or an empty document value if the key does not exist. Must be freed by *bson\_destroy()*.

- •

  **error**: Optional. *bson\_error\_t*.

## RETURNS

Returns **true** if successful. Returns **false** and sets **error** otherwise.

**SEE ALSO:**

```
mongoc_client_encryption_t
```

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.