Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Disclosures (deprecated)

Create a Disclosure

Disclosures to be made to customers

post/customers/{customer_id}/disclosures

Path parameters

customer_idstring uuid required
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

The customer's unique identifier

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Request body

creation_timestring date-time
event_type'ACKNOWLEDGED' | 'DISPLAYED' | 'VIEWED' required
idstring uuid

Disclosure ID

last_updated_timestring date-time
timestampstring date-time required

Date of disclosure

type'ACH_AUTHORIZATION' | 'CARDHOLDER_AGREEMENT' | 'E_SIGN' | 'FCRA' | 'KYC_DATA_COLLECTION' | 'MLA' | 'OWNER_CERTIFICATION' | 'PRIVACY_NOTICE' | 'REG_CC' | 'REG_DD' | 'REG_E' | 'SC_ACCOUNT_AGREEMENT' | 'SC_AUTO_PAYMENT' | 'SC_SECURITY_AGREEMENT' | 'TERMS_AND_CONDITIONS' | 'TILA' required

Disclosure Type

versionstring required

Disclosure Version

Example request

{
  "creation_time": "2010-05-06T12:23:34.321Z",
  "event_type": "VIEWED",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "timestamp": "2010-05-06T12:23:34.321Z",
  "type": "REG_DD",
  "version": "v1.1"
}

Response

Created disclosure

creation_timestring date-time
event_type'ACKNOWLEDGED' | 'DISPLAYED' | 'VIEWED' required
idstring uuid

Disclosure ID

last_updated_timestring date-time
timestampstring date-time required

Date of disclosure

type'ACH_AUTHORIZATION' | 'CARDHOLDER_AGREEMENT' | 'E_SIGN' | 'FCRA' | 'KYC_DATA_COLLECTION' | 'MLA' | 'OWNER_CERTIFICATION' | 'PRIVACY_NOTICE' | 'REG_CC' | 'REG_DD' | 'REG_E' | 'SC_ACCOUNT_AGREEMENT' | 'SC_AUTO_PAYMENT' | 'SC_SECURITY_AGREEMENT' | 'TERMS_AND_CONDITIONS' | 'TILA' required

Disclosure Type

versionstring required

Disclosure Version

Example response

{
  "creation_time": "2010-05-06T12:23:34.321Z",
  "event_type": "VIEWED",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "timestamp": "2010-05-06T12:23:34.321Z",
  "type": "REG_DD",
  "version": "v1.1"
}