Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Disclosures

List disclosures

Retrieves paginated list of disclosures associated with the authorized requester.

get/disclosures

Query parameters

business_idstring[]

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

page_tokenstring

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

Example:a8937a0d
document_idstring[]

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

idstring[]

Unique resource identifier

[
  "7d943c51-e4ff-4e57-9558-08cab6b963c7"
]
person_idstring[]

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

acknowledging_person_idstring[]

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

limitinteger

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

Example:100

Response

List of disclosures.

next_page_tokenstring

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

Example response

{
  "disclosures": [
    {
      "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",
      "document_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "event_type": "ACKNOWLEDGED",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "person_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "tenant": "abcdef_ghijkl",
      "version": "1.0"
    }
  ],
  "next_page_token": "a8937a0d"
}