Skip to main content
GET
/
disclosures
List disclosures
curl --request GET \
  --url https://api.synctera.com/v2/disclosures
{
  "disclosures": [
    {
      "acknowledging_person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "business_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "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": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "tenant": "abcdef_ghijkl",
      "type": "ACH_AUTHORIZATION",
      "version": "1.0"
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
id
string<uuid>[]

Unique resource identifier

​
person_id
string<uuid>[]

Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
business_id
string<uuid>[]

Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

​
acknowledging_person_id
string<uuid>[]

Return only disclosures that have the specified acknowledging_person_id. Multiple IDs can be provided as a comma-separated list.

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6,84ef251c-ab8f-47a5-bbfd-a16648f95157"

Response

List of disclosures.

​
disclosures
object[]
required

Array of disclosures.

​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"