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

# Record Disclosure Acceptance

> Disclosures record that you told a customer about the laws and regulations that affect them — the auditable proof that required regulatory information was disclosed.

## Overview

An important part of onboarding a customer is *disclosing* regulatory information to them, such as terms of service or privacy notices. Banks and regulators need to verify these disclosures were made, so Synctera keeps a **disclosure record** (usually just called a *disclosure*) for every disclosure you make to every customer.

**A disclosure record** captures which customer was told what, and how they interacted with it. It links a customer to a specific *disclosure document* — identified by a `type` and `version` — at a point in time.

Key characteristics:

* **Scoped** — each disclosure is tied to a customer via `person_id` or `business_id`.
* **Documented** — `type` and `version` together identify the exact disclosure document that was presented.
* **Interaction-aware** — `event_type` records the customer's level of interaction (e.g. `DISPLAYED`, `ACKNOWLEDGED`).
* **Auditable** — each record is timestamped with a `disclosure_date` and retained for compliance review.

<Info>
  Synctera does not currently store the disclosure documents themselves. A disclosure document is a record in Synctera's database that refers to a document **you** write and present to your customers. A future version of this API will support storing the documents.
</Info>

### When to use disclosures

* **During onboarding** — record that a customer acknowledged terms of service, privacy notices, or e-sign consent before they transact.
* **Beneficial ownership certification** — record an `OWNER_CERTIFICATION` when an agent certifies a business's ownership information. See [Create a Business Customer](/docs/create-a-business).
* **Ongoing regulatory disclosures** — record `REG_E`, `REG_CC`, and similar disclosures as your product requires them.

## Prerequisites

This guide assumes you have:

* Created a [personal customer](/docs/create-a-personal-customer) or [business customer](/docs/create-a-business)

You should also be familiar with:

* [Need to Know — Environments](/reference/need-to-know#environments)
* [Need to Know — Authentication](/reference/need-to-know#authentication)

## The disclosure object

A disclosure contains the following key fields:

| Field                     | Description                                                                                                     |
| ------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `id`                      | Unique identifier (read-only, assigned on creation).                                                            |
| `person_id`               | The personal customer the disclosure applies to. Provide this **or** `business_id`.                             |
| `business_id`             | The business customer the disclosure applies to. Provide this **or** `person_id`.                               |
| `acknowledging_person_id` | The person who acknowledged the disclosure (used for business disclosures, e.g. an agent certifying ownership). |
| `type`                    | **Required.** The regulatory requirement that triggered the disclosure (e.g. `REG_DD`).                         |
| `version`                 | **Required.** The revision of the disclosed document. Together with `type`, identifies the disclosure document. |
| `event_type`              | The customer's level of interaction (e.g. `DISPLAYED`, `ACKNOWLEDGED`).                                         |
| `disclosure_date`         | When the disclosure was made to the customer.                                                                   |

```json theme={"system"}
{
  "id": "08a27c6b-b55f-42c3-8805-f5ad442b0312",
  "person_id": "e72f1f20-7a95-4b19-aafc-c73f868183e7",
  "type": "REG_DD",
  "version": "1.0",
  "event_type": "ACKNOWLEDGED",
  "disclosure_date": "2022-03-17T17:04:34Z",
  "creation_time": "2022-04-05T23:29:42.436824Z",
  "last_updated_time": "2022-04-05T23:29:42.436824Z"
}
```

### Available disclosure documents

Together, `type` and `version` uniquely specify a disclosure document. If the combination does not already exist in Synctera's system, the request returns an error. You should have a default set of documents available:

| Disclosure type        | Document version |
| ---------------------- | ---------------- |
| `REG_DD`               | 1.0              |
| `KYC_DATA_COLLECTION`  | 1.0              |
| `REG_E`                | 1.0              |
| `REG_CC`               | 1.0              |
| `E_SIGN`               | 1.0              |
| `PRIVACY_NOTICE`       | 1.0              |
| `TERMS_AND_CONDITIONS` | 1.0              |

You may not need every disclosure type — Synctera's compliance team can advise. The `type` and `event_type` fields are fully described in the [API reference](/reference/createdisclosure).

## Managing disclosures

<Steps>
  <Step title="Record a disclosure for a personal customer">
    After you present a document to a customer for them to read and accept, record it with [POST /v0/disclosures](/reference/createdisclosure), passing the `person_id`:

    ```shell theme={"system"}
    curl \
      -X POST \
      -H "Authorization: Bearer $apikey" \
      -H 'Content-Type: application/json' \
      https://api.synctera.com/v0/disclosures \
      --data-binary '
      {
        "person_id": "e72f1f20-7a95-4b19-aafc-c73f868183e7",
        "type": "REG_DD",
        "version": "1.0",
        "event_type": "ACKNOWLEDGED",
        "disclosure_date": "2022-03-17T17:04:34Z"
      }'
    ```

    On success the endpoint returns `201 Created` with the new record, including its unique `id`:

    ```json theme={"system"}
    {
      "id": "08a27c6b-b55f-42c3-8805-f5ad442b0312",
      "person_id": "e72f1f20-7a95-4b19-aafc-c73f868183e7",
      "type": "REG_DD",
      "version": "1.0",
      "event_type": "ACKNOWLEDGED",
      "disclosure_date": "2022-03-17T17:04:34Z",
      "creation_time": "2022-04-05T23:29:42.436824Z",
      "last_updated_time": "2022-04-05T23:29:42.436824Z"
    }
    ```
  </Step>

  <Step title="Record a disclosure for a business customer">
    For a business, specify `business_id` instead of `person_id`. Use `acknowledging_person_id` to record which person acknowledged it on the business's behalf:

    ```shell theme={"system"}
    curl \
      -X POST \
      -H "Authorization: Bearer $apikey" \
      -H 'Content-Type: application/json' \
      https://api.synctera.com/v0/disclosures \
      --data-binary '
      {
        "business_id": "d894d64b-d513-42f2-9b3a-2cd5989b6ef8",
        "type": "REG_E",
        "version": "1.1",
        "event_type": "DISPLAYED",
        "disclosure_date": "2022-04-03T10:43:12Z"
      }'
    ```
  </Step>

  <Step title="List and retrieve disclosures">
    Retrieve a paginated list of all disclosure records across your customer base with [GET /v0/disclosures](/reference/listdisclosures):

    ```shell theme={"system"}
    curl \
      -X GET \
      -H "Authorization: Bearer $apikey" \
      https://api.synctera.com/v0/disclosures
    ```

    Filter by `person_id` or `business_id` to limit the results to a single customer:

    ```shell theme={"system"}
    curl \
      -X GET \
      -H "Authorization: Bearer $apikey" \
      "https://api.synctera.com/v0/disclosures?person_id={person_id}"
    ```

    Fetch a single record by ID with [GET /v0/disclosures/\{disclosure\_id}](/reference/getdisclosure):

    ```shell theme={"system"}
    curl \
      -X GET \
      -H "Authorization: Bearer $apikey" \
      https://api.synctera.com/v0/disclosures/{disclosure_id}
    ```
  </Step>
</Steps>

## Best practices

<Warning>
  A disclosure record is your evidence that a required disclosure was made. Create the record as soon as the customer interacts with the document, and never back-date `disclosure_date`.
</Warning>

* **Match `type` and `version` to a real document** — mismatched combinations are rejected; keep your document versions in sync with Synctera's available documents.
* **Record the right `event_type`** — distinguish `DISPLAYED` from `ACKNOWLEDGED` so your audit trail reflects what actually happened.
* **Attribute business disclosures** — set `acknowledging_person_id` so you know which agent acted on the business's behalf.
* **Confirm scope with compliance** — work with Synctera's compliance team to determine exactly which disclosures your product requires.

## Related guides

<CardGroup cols={2}>
  <Card title="Create a Personal Customer" href="/docs/create-a-personal-customer" icon="user" horizontal>
    Record disclosures as part of onboarding a person.
  </Card>

  <Card title="Create a Business Customer" href="/docs/create-a-business" icon="briefcase" horizontal>
    Capture beneficial ownership certification and business disclosures.
  </Card>

  <Card title="KYC/KYB Verification" href="/docs/kyc-kyb-verification" icon="user-shield" horizontal>
    Verify customer identity alongside recording disclosures.
  </Card>
</CardGroup>

## API reference

* [Create a disclosure](/reference/createdisclosure)
* [List disclosures](/reference/listdisclosures)
* [Get a disclosure](/reference/getdisclosure)
