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

# Update KYC Source

> Rename a source, change its key, profile or whitelists, or pause it

Changes a KYC source. Send any combination of the fields below. A field that is not sent stays as it is, and a call that changes nothing answers with the source unchanged.

## What each change does

| Field | Effect |
| - | - |
| `name` | Renames the source. The invite the verifier holds keeps working |
| `signingKey` | Later deliveries and revocations are verified against the new key. Replace the pin in your tool as well. First run `trusset-kyc open --all`, so the records still waiting under the old key are opened while it is pinned: the tool opens a record only with the key pinned now, and holds every later record signed with a former key. Then confirm the new fingerprint with the verifier over a separate channel and run `trusset-kyc source add --id <sourceId> --name <name> --key <new key> --replace --former-key retire`. Use `--former-key revoke` instead when the old key was lost or exposed: records filed under a revoked key no longer verify. With `retire` they still do. Until the pin is replaced, `trusset-kyc open` holds records signed with the new key without opening or rejecting them |
| `profileKey` | Later deliveries must carry the new profile key. The invite names the profile key the verifier seals under, so issue a new one with [Reissue Source Invite](https://docs.trusset.org/endpoints/customers/reissue-kyc-source-invite.md) |
| `accessListIds` | Replaces the bound whitelists. Send `[]` to unbind all |
| `status` | `PAUSED` refuses deliveries with `403 SOURCE_PAUSED` until you set `ACTIVE` again. A paused source can still revoke records |

> [!WARNING]
>
> Unbinding a whitelist lifts the record requirement on it. From then on [Set Whitelist Members](https://docs.trusset.org/endpoints/lending/set-access-list-members.md) lists any wallet on that list again, unless another source of your instance is still bound to it. Wallets already listed stay listed.

A removed source cannot be changed. Add a new source instead.

## Path Parameters

**sourceId** `string` *required*

The source `id` from [List KYC Sources](https://docs.trusset.org/endpoints/customers/list-kyc-sources.md).

## Body Parameters

**name** `string`

1 to 80 characters: letters, digits, spaces and `. , & ( ) ' _ -`, starting with a letter or a digit. Unique among the sources of your instance that are not removed.

**signingKey** `string`

The verifier's Ed25519 public key as 64 hex characters, with or without a `0x` prefix.

**profileKey** `string`

The `key` of an enabled [verification profile](https://docs.trusset.org/endpoints/customers/list-verification-profiles.md).

**accessListIds** `string[]`

Up to 10 whitelist IDs. The list replaces the bound whitelists as a whole.

**status** `string`

`ACTIVE` or `PAUSED`. Use [Remove KYC Source](https://docs.trusset.org/endpoints/customers/remove-kyc-source.md) to end a source for good.

## Response Fields

**data** `object`

**source** `object`

The source after the change, as on [List KYC Sources](https://docs.trusset.org/endpoints/customers/list-kyc-sources.md).

> [!NOTE]
>
> A change is written to the customer audit log as `KYC_SOURCE_UPDATED`, naming the fields that changed. A new signing key is recorded with its fingerprint and the fingerprint of the key it replaced.

```bash cURL theme={null}
curl -X PATCH "https://api.trusset.org/customers/api/kyc-sources/cmhw2a6r10003l80c9d4h1n8v" \
  -H "X-API-Key: trusset_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "status": "PAUSED" }'
```

```typescript TypeScript theme={null}
const res = await fetch(
  `https://api.trusset.org/customers/api/kyc-sources/${sourceId}`,
  {
    method: 'PATCH',
    headers: { 'X-API-Key': 'trusset_your_key_here', 'Content-Type': 'application/json' },
    body: JSON.stringify({ status: 'PAUSED' })
  }
);
const { data } = await res.json();
```

```json Response theme={null}
{
  "success": true,
  "data": {
    "source": {
      "id": "cmhw2a6r10003l80c9d4h1n8v",
      "name": "Hanse Haftungsdach GmbH",
      "signingKey": "c201dc3ced8549ad4e07400a868d9fd043a8d316e7141989c33e8f2f5f844fd6",
      "signingKeyFingerprint": "4b37 6734 b088 268b 89d3 cf6d 1a88 0a1c",
      "profileKey": "PROFESSIONAL",
      "accessLists": [
        {
          "id": "cmv2k8q1d0004l70a3n6p2w9e",
          "name": "Depositors Q4",
          "address": "0x7d31e6b09a4c25f8e1b73d0a6c94e2f58b1a0c37"
        }
      ],
      "status": "PAUSED",
      "tokenHint": "Qml8",
      "tokenIssuedAt": "2026-11-09T08:31:02.118Z",
      "lastDeliveryAt": "2026-11-12T09:14:09.204Z",
      "createdAt": "2026-11-09T08:31:02.118Z",
      "counts": { "received": 3, "opened": 1, "approved": 12 }
    }
  },
  "error": null,
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-11-12T10:02:17.441Z"
  }
}
```

## Error Codes

| Code | HTTP | Cause |
| - | - | - |
| `VALIDATION_ERROR` | `400` | A field sent is malformed, or `status` is not `ACTIVE` or `PAUSED`. `details.field` names the field |
| `INVALID_INVESTOR_TYPE` | `400` | `profileKey` names no enabled verification profile of your instance |
| `SOURCE_NOT_FOUND` | `404` | No KYC source with this ID belongs to your instance |
| `ACCESS_LIST_NOT_FOUND` | `404` | A whitelist in `accessListIds` is not kept or managed by your instance on this network. `details.accessListIds` names them |
| `INSTANCE_NOT_FOUND` | `404` | The instance behind your key is archived or no longer exists |
| `SOURCE_REVOKED` | `409` | The source was removed and cannot be changed |
| `SOURCE_NAME_TAKEN` | `409` | Another source of your instance uses this name |
| `SOURCE_KEY_TAKEN` | `409` | Another source of your instance uses this signing key |
| `RATE_LIMIT_EXCEEDED` | `429` | Your instance went over its budget of 20 KYC source writes per minute |
| `UPDATE_KYC_SOURCE_FAILED` | `500` | The source could not be updated |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.