GET
/
disclosures
/
{disclosure_id}
Get disclosure
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/disclosures/{disclosure_id} \
  --header 'Authorization: Bearer <token>'
{
  "acknowledging_person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "disclosure_date": "2010-05-06T12:23:34.321Z",
  "event_type": "ACKNOWLEDGED",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "metadata": {},
  "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "tenant": "abcdef_ghijkl",
  "type": "ACH_AUTHORIZATION",
  "version": "1.0"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
disclosure_id
string<uuid>
required

The unique identifier for the disclosure.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Response

Disclosure representation.

Represents a disclosure.

​
disclosure_date
string<date-time>
required

Date and time the disclosure was made.

Example:

"2010-05-06T12:23:34.321Z"

​
event_type
enum<string>
required

Describes how the disclosure was shown and what the user did as a result. One of the following:

  • DISPLAYED — The document was made visible to the user, but they did not interact with it.

  • VIEWED — The document was made visible to the user, and they interacted enough to see the whole document (e.g. scrolled to the bottom).

  • ACKNOWLEDGED — The document was made visible to the user, and they took positive action to confirm that they have read and accepted the document.

Available options:
ACKNOWLEDGED,
DISPLAYED,
VIEWED
Example:

"ACKNOWLEDGED"

​
type
enum<string>
required

Describes the regulatory requirement that triggered the disclosure. One of the following:

  • ACH_AUTHORIZATION – [US] The ACH Authorization & Agreement Disclosure serves as a method of disclosing and obtaining consent from a consumer to conduct ACH and pre-authorized electronic transactions to and from their account. Record of obtaining this consent should be retained, in accordance with Reg E, for no less than 2 years from the date the disclosure was made to the consumer.

  • CARDHOLDER_AGREEMENT – [US] The Cardholder Agreement is a legal document that details the terms of a card agreement between either a consumer or a business, and the financial institution that issues the card. The Agreement governs the use of the account.

    [CA] A legal document that details the terms of a customer’s use of a card and their relationship with the issuing financial institution, Synctera (if applicable), and the Distributor of the Card (the FinTech). The Agreement governs the customer’s use of the Card and the account, including their rights and obligations.

  • CARD_DISCLOSURE – [CA] Part of the Cardholder Agreement, the Disclosure highlights prescribed terms and conditions that apply to the customer's use of the Card. The Disclosure can be incorporated into the Agreement itself, but is often shown separately to ensure clear understanding of the regulated terms.

  • E_SIGN – [US] US law with rules around electronic agreements/documents/disclosures: used to obtain consent from consumers to receive electronic communications (agreements, disclosures, statements, etc) about their accounts.

    [CA] In order for you to send customers regulatory notices, disclosures, and documents electronically and to collect their consent electronically, customers need to acknowledge an Electronic Consent form. This should happen first so the disclosures that follow are acknowledged with the customer’s consent to do so electronically.

  • KYC_DATA_COLLECTION – [US] Document advising the customer that you will collect their personal information (name, date of birth, tax ID, etc.) and will be validating their information against external data/documentation.

  • PAD_AUTHORIZATION – [CA] You must record a customer's authorization prior to facilitating a pre-authorized EFT debit transaction. This form records their authorization for you to facilitate future EFTs from their account. This can be a sporadic or recurring PAD; if sporadic, you need to confirm the customer's authorization prior to each future transaction.

  • PRIVACY_NOTICE – [US] Document that tells customers what is done with their non-public information, who it is shared with, how is is secured, and how they can opt out of it being shared beyond Synctera.

    [CA] It is a requirement for you to disclose to customers how you collect, use, disclose, and store their personal information, including how information is shared with third parties like Synctera, what their rights are, and how they can withdraw their consent. You must collect explicit consent from customers to this notice.

  • OWNER_CERTIFICATION – [US] Disclosure to certify that the beneficial owners of the business have been correctly entered.

    [CA] Applicable to business customers only, this certifies that the beneficial owners of the business have been correctly entered.

  • REG_CC – [US] US regulation that implements the Expedited Funds Availability Act: describes standards for when a financial institution makes funds available in a deposit account.

  • REG_DD – [US] US regulation that implements the Truth in Savings Act, to inform customers about the terms and rules for a deposit account.

  • REG_E – [US] US regulation that implements the Electronic Funds Transfer Act: covers liability for electronic transactions, disputes for fraudulent or unrecognized electronic transactions, and consent for electronic debits from a consumer's account.

  • TERMS_AND_CONDITIONS – [US] A detailed agreement between you and the consumer for the structure, terms, fees, charges, rates of the product or service, and the rules for the relationship between you and the consumer.

  • SC_ACCOUNT_AGREEMENT – [US] A detailed agreement between you and the consumer for the structure and terms of service for smart card accounts.

  • SC_SECURITY_AGREEMENT – [US] A detailed agreement between you and the consumer for the terms of service for smart card security account.

  • SC_AUTO_PAYMENT - [US] A detailed agreement between you and the consumer for the structure and terms of service for smart card auto repayment.

Available options:
ACH_AUTHORIZATION,
CARDHOLDER_AGREEMENT,
CARD_DISCLOSURE,
E_SIGN,
KYC_DATA_COLLECTION,
OWNER_CERTIFICATION,
PAD_AUTHORIZATION,
PRIVACY_NOTICE,
REG_CC,
REG_DD,
REG_E,
SC_ACCOUNT_AGREEMENT,
SC_AUTO_PAYMENT,
SC_SECURITY_AGREEMENT,
TERMS_AND_CONDITIONS
​
version
string
required

Version of the disclosure document.

Example:

"1.0"

​
acknowledging_person_id
string<uuid>

Unique ID for the person acknowledging the disclosure. Applicable for disclosures where the person acknowledging is different from the subject of the disclosure. Required for OWNER_CERTIFICATION disclosures.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
business_id
string<uuid>

Unique ID for the business. Exactly one of business_id or person_id must be set.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
creation_time
string<date-time>

The date and time the resource was created.

Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>

The unique identifier for this resource.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
last_updated_time
string<date-time>

The date and time the resource was last updated.

Example:

"2010-05-06T12:23:34.321Z"

​
metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

​
person_id
string<uuid>

Unique ID for the person. Exactly one of person_id or business_id must be set.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"