Request a disclosure
Select transactions directly with scope.transactionIds, or select an account and optional time range with scope.account, scope.from, and scope.to. The response returns one of these statuses: When the response is pending, store the returned Disclosure id and use the retrieve method to read the decision.

Authorizations

Authorization
string
header
required

Organization API key created through the User API.

Body

application/json
assetId
string
required
purpose
string
required

Business or compliance reason for requesting access.

Minimum string length: 1
scope
object
required

Limits the records and confidential fields included in a disclosure.

format
enum<string>
default:json
Available options:
json,
csv
externalReference
string

Optional identifier from the integrating service.

Response

Disclosure request created. Pre-authorized requests can return an available result immediately.

id
string
required
assetId
string
required
purpose
string
required
scope
object
required

Limits the records and confidential fields included in a disclosure.

format
enum<string>
required
Available options:
json,
csv
status
enum<string>
required
Available options:
pending,
available,
rejected
externalReference
string | null
required
requestedAt
string<date-time>
required
resolvedAt
string<date-time> | null
required
result
object | null
required