Skip to main content

​
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.
A disclosure record is metadata — it captures that a disclosure was made, not the document text itself. To store the text the customer agreed to, upload it to Document Storage and reference it from the disclosure with document_id. See Linking to the document text.

​
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.
  • Ongoing regulatory disclosures — record REG_E, REG_CC, and similar disclosures as your product requires them.

​
Prerequisites

This guide assumes you have: You should also be familiar with:

​
The disclosure object

A disclosure contains the following key fields:

​
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: 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.

​
Managing disclosures

1

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, passing the person_id:
On success the endpoint returns 201 Created with the new record, including its unique id:
2

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:
3

List and retrieve disclosures

Retrieve a paginated list of all disclosure records across your customer base with GET /v0/disclosures:
Filter by person_id or business_id to limit the results to a single customer:
Fetch a single record by ID with GET /v0/disclosures/{disclosure_id}:

​
Linking to the document text

Use the document_id field to reference the exact document text the customer agreed to. Upload that text to Document Storage, then set document_id to the id returned by the upload. Because the document lives in Synctera’s document storage, the disclosure record can always be traced back to the exact text the customer saw — retrieve it later with GET /v0/documents/{document_id}/contents.

​
Best practices

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.
  • Match type and version to a real document — mismatched combinations are rejected; keep your document versions in sync with Synctera’s available documents.
  • Link the document text — upload the disclosure text to Document Storage and set document_id so the record ties directly to what the customer saw.
  • 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.

Create a Personal Customer

Record disclosures as part of onboarding a person.

Create a Business Customer

Capture beneficial ownership certification and business disclosures.

KYC/KYB Verification

Verify customer identity alongside recording disclosures.

Document Storage

Upload the disclosure text and link it via document_id.

​
API reference