/** * Fireblocks API * Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain. - Visit our website for more information: [Fireblocks Website](https://fireblocks.com) - Visit our developer docs: [Fireblocks DevPortal](https://developers.fireblocks.com) * * The version of the OpenAPI document: 1.6.2 * Contact: developers@fireblocks.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { RequestArgs, BaseAPI } from '../base'; import { AddressRegistryAddVaultOptOutsRequest } from '../models'; import { AddressRegistryAddVaultOptOutsResponse } from '../models'; import { AddressRegistryCreateProofOfOwnershipRequest } from '../models'; import { AddressRegistryCreateProofOfOwnershipResponse } from '../models'; import { AddressRegistryCustomerRegistryResponse } from '../models'; import { AddressRegistryGetVaultOptOutResponse } from '../models'; import { AddressRegistryLegalEntity } from '../models'; import { AddressRegistryListVaultOptOutsResponse } from '../models'; import { AddressRegistryRemoveAllVaultOptOutsResponse } from '../models'; import { AddressRegistryRemoveVaultOptOutResponse } from '../models'; import { AddressRegistryTenantRegistryResponse } from '../models'; import { AddressRegistryVaultListOrder } from '../models'; import { AddressRegistryVerifyProofOfOwnershipRequest } from '../models'; import { AddressRegistryVerifyProofOfOwnershipResponse } from '../models'; import { AmlVerdictManualRequest } from '../models'; import { AmlVerdictManualResponse } from '../models'; import { ArsConfigResponse } from '../models'; import { AssignVaultsToLegalEntityRequest } from '../models'; import { AssignVaultsToLegalEntityResponse } from '../models'; import { ByorkConfigResponse } from '../models'; import { ByorkSetTimeoutsRequest } from '../models'; import { ByorkVerdictRequest } from '../models'; import { ByorkVerdictResponse } from '../models'; import { ComplianceResultFullPayload } from '../models'; import { CounterpartyGroup } from '../models'; import { CounterpartyGroupsPaginatedResponse } from '../models'; import { CreateCounterpartyGroupRequest } from '../models'; import { CreateTransactionResponse } from '../models'; import { GetByorkVerdictResponse } from '../models'; import { LegalEntityRegistration } from '../models'; import { ListLegalEntitiesResponse } from '../models'; import { ListVaultsForRegistrationResponse } from '../models'; import { RegisterLegalEntityRequest } from '../models'; import { RescreenTransactionRequest } from '../models'; import { RescreenTransactionResponse } from '../models'; import { ScreeningConfigurationsRequest } from '../models'; import { ScreeningPolicyResponse } from '../models'; import { ScreeningProviderRulesConfigurationResponse } from '../models'; import { ScreeningUpdateConfigurations } from '../models'; import { UpdateCounterpartyGroupRequest } from '../models'; import { UpdateLegalEntityRequest } from '../models'; /** * ComplianceApi - axios parameter creator * @export */ export declare const ComplianceApiAxiosParamCreator: (configuration?: Configuration) => { /** * Activates ARS (Address Registry Screening) for the authenticated tenant (sets config.active to true). Once activated, ARS screening applies to matching transactions. * @summary Activate ARS (Address Registry Screening) * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateArsConfig: (idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Activates BYORK Light for the authenticated tenant (sets config.active to true). Once activated, BYORK screening applies to matching transactions. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Activate BYORK Light * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateByorkConfig: (idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Adds one or more vault account ids to the workspace opt-out list for the address registry. * @summary Add vault accounts to the address registry opt-out list * @param {AddressRegistryAddVaultOptOutsRequest} addressRegistryAddVaultOptOutsRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addAddressRegistryVaultOptOuts: (addressRegistryAddVaultOptOutsRequest: AddressRegistryAddVaultOptOutsRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Assigns one or more vault accounts to a specific legal entity registration. Explicitly mapped vault accounts take precedence over the workspace default legal entity. Endpoint Permission: Admin, Non-Signing Admin. * @summary Assign vault accounts to a legal entity * @param {AssignVaultsToLegalEntityRequest} assignVaultsToLegalEntityRequest * @param {string} legalEntityId The unique ID of the legal entity registration * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ assignVaultsToLegalEntity: (assignVaultsToLegalEntityRequest: AssignVaultsToLegalEntityRequest, legalEntityId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates a Proof of Ownership PDF for a blockchain address owned by the authenticated workspace — for example, to share with a counterparty or bank as compliance evidence. Recipients can confirm it with `POST /v1/address_registry/proof_of_ownership_exports/verify`. Check `proofOfOwnershipAvailable` on `GET /v1/address_registry/legal_entities/{address}` first if you want to know whether create is likely to succeed. * @summary Create a Proof of Ownership PDF for an address * @param {AddressRegistryCreateProofOfOwnershipRequest} addressRegistryCreateProofOfOwnershipRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAddressRegistryProofOfOwnership: (addressRegistryCreateProofOfOwnershipRequest: AddressRegistryCreateProofOfOwnershipRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Creates a new counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Create a counterparty group * @param {CreateCounterpartyGroupRequest} createCounterpartyGroupRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCounterpartyGroup: (createCounterpartyGroupRequest: CreateCounterpartyGroupRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Deactivates ARS (Address Registry Screening) for the authenticated tenant (sets config.active to false). Once deactivated, ARS screening no longer applies until activated again. * @summary Deactivate ARS (Address Registry Screening) * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateArsConfig: (idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Deactivates BYORK Light for the authenticated tenant (sets config.active to false). Once deactivated, BYORK screening no longer applies until activated again. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Deactivate BYORK Light * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateByorkConfig: (idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Permanently deletes a counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Delete a counterparty group * @param {string} groupId The unique identifier of the counterparty group * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCounterpartyGroup: (groupId: string, options?: RawAxiosRequestConfig) => Promise; /** * Delete a legal entity will change the status of a legal entity registration to REVOKED. Endpoint Permission: Admin, Non-Signing Admin. * @summary Delete a legal entity * @param {string} legalEntityId The unique ID of the legal entity registration to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteLegalEntity: (legalEntityId: string, options?: RawAxiosRequestConfig) => Promise; /** * Read your customer\'s organization-wide address registry setting. Workspaces without their own choice use this as the default. Returns `NOT_SET` when no choice has been made yet, or `OPTED_IN` / `OPTED_OUT` when one has. * @summary Get your customer\'s address registry default * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAddressRegistryCustomerParticipationStatus: (options?: RawAxiosRequestConfig) => Promise; /** * Check whether this workspace uses the address registry. The response is `OPTED_IN` or `OPTED_OUT`. If this workspace has not been configured yet, it follows your customer\'s default (see `GET /v1/address_registry/customer`) when that default is `OPTED_IN` or `OPTED_OUT`; otherwise the workspace is opted in by default. * @summary Get address registry status for this workspace * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAddressRegistryTenantParticipationStatus: (options?: RawAxiosRequestConfig) => Promise; /** * Returns whether this vault account is on the workspace opt-out list (`optedOut` true or false). List, add, and clear-all are available on `/v1/address_registry/vaults`; this path reads or removes one vault. * @summary Get whether a vault account is opted out of the address registry * @param {number} vaultAccountId Vault account id (non-negative integer). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAddressRegistryVaultOptOut: (vaultAccountId: number, options?: RawAxiosRequestConfig) => Promise; /** * Get the post-screening policy for AML. * @summary AML - View Post-Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAmlPostScreeningPolicy: (options?: RawAxiosRequestConfig) => Promise; /** * Get the screening policy for AML. * @summary AML - View Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAmlScreeningPolicy: (options?: RawAxiosRequestConfig) => Promise; /** * Retrieves BYORK Light configuration for the authenticated tenant (timeouts, active flag, allowed timeout ranges). Returns default config when none exists. Requires BYORK Light to be enabled for the tenant. * @summary Get BYORK Light configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getByorkConfig: (options?: RawAxiosRequestConfig) => Promise; /** * Returns the current BYORK verdict and status for a transaction. Status can be PRE_ACCEPTED, PENDING, RECEIVED (verdict is final but processing not yet complete), or COMPLETED. Requires BYORK Light to be enabled for the tenant. Returns 404 if no BYORK verdict is found for the transaction. * @summary Get BYORK Light verdict * @param {string} txId Transaction ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getByorkVerdict: (txId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns the details of a specific counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. * @summary Get a counterparty group * @param {string} groupId The unique identifier of the counterparty group * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCounterpartyGroup: (groupId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns details of a specific legal entity registration, including GLEIF data when available. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get a legal entity * @param {string} legalEntityId The unique ID of the legal entity registration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLegalEntity: (legalEntityId: string, options?: RawAxiosRequestConfig) => Promise; /** * Returns legal entity information for the given blockchain address (LEI data availability, LEI identifier, Travel Rule providers, contact email, and related fields — see response schema). URL-encode `{address}` when required. * @summary Look up legal entity by blockchain address * @param {string} address Blockchain address to look up * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLegalEntityForAddress: (address: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the post-screening policy for Travel Rule. * @summary Travel Rule - View Post-Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPostScreeningPolicy: (options?: RawAxiosRequestConfig) => Promise; /** * Provides all the compliance details for the given screened transaction. * @summary Provides all the compliance details for the given screened transaction. * @param {string} txId Fireblocks transaction ID of the screened transaction * @param {*} [options] Override http request option. * @throws {RequiredError} */ getScreeningFullDetails: (txId: string, options?: RawAxiosRequestConfig) => Promise; /** * Get the screening policy for Travel Rule. * @summary Travel Rule - View Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getScreeningPolicy: (options?: RawAxiosRequestConfig) => Promise; /** * Lists vault accounts that are opted out of the address registry for this workspace. Pagination uses `next` and `prev` cursors from the response. If `pageSize` is omitted, **50** items are returned per page; allowed range is **1–100** per request. * @summary List vault-level address registry opt-outs (paginated) * @param {string} [pageCursor] Opaque cursor from a previous response (`next` or `prev`). Omit for the first page. * @param {number} [pageSize] Page size. Default **50** if omitted; must be between **1** and **100**. * @param {AddressRegistryVaultListOrder} [order] Sort direction by vault account id. Omit for ascending; use the enum value for descending. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAddressRegistryVaultOptOuts: (pageCursor?: string, pageSize?: number, order?: AddressRegistryVaultListOrder, options?: RawAxiosRequestConfig) => Promise; /** * Returns a paginated list of counterparty groups. **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. * @summary List counterparty groups * @param {string} [pageCursor] Cursor of the required page * @param {number} [pageSize] Maximum number of items in the page * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCounterpartyGroups: (pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns legal entity registrations for the workspace with cursor-based pagination. If query parameter vaultAccountId is used it returns the legal entity registration associated with a specific vault account. If no explicit mapping exists for the vault, the workspace default legal entity is returned. Returns an empty response if neither a vault mapping nor a default legal entity is configured. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary List legal entities (Paginated) * @param {string} [vaultAccountId] The ID of the vault account. When provided, returns the legal entity associated with that vault account and pagination parameters are ignored. * @param {string} [pageCursor] Cursor string returned in `next` or `prev` of a previous response. Ignored when `vaultAccountId` is provided. * @param {number} [pageSize] Maximum number of registrations to return. Ignored when `vaultAccountId` is provided. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLegalEntities: (vaultAccountId?: string, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig) => Promise; /** * Returns vault account IDs explicitly assigned to a specific legal entity registration, with cursor-based pagination. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary List vault accounts for a legal entity (Paginated) * @param {string} legalEntityId The unique ID of the legal entity registration * @param {string} [pageCursor] Cursor string returned in `next` or `prev` of a previous response * @param {number} [pageSize] Maximum number of registrations to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVaultsForLegalEntity: (legalEntityId: string, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig) => Promise; /** * Set your customer\'s default to opted in. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_IN`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. * @summary Opt your customer in to the address registry * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ optInAddressRegistryCustomer: (idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Turn on the address registry for this workspace. No request body. Returns `OPTED_IN`. * @summary Opt this workspace in to the address registry * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ optInAddressRegistryTenant: (idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Set your customer\'s default to opted out. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_OUT`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. * @summary Opt your customer out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} */ optOutAddressRegistryCustomer: (options?: RawAxiosRequestConfig) => Promise; /** * Turn off the address registry for this workspace. No request body. Returns `OPTED_OUT`. * @summary Opt this workspace out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} */ optOutAddressRegistryTenant: (options?: RawAxiosRequestConfig) => Promise; /** * Registers a new legal entity for the workspace using its LEI (Legal Entity Identifier) code. The LEI is validated against the GLEIF registry. Each workspace can register multiple legal entities. Endpoint Permission: Admin, Non-Signing Admin. * @summary Register a new legal entity * @param {RegisterLegalEntityRequest} registerLegalEntityRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerLegalEntity: (registerLegalEntityRequest: RegisterLegalEntityRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Removes this vault account id from the workspace opt-out list if it is present; otherwise the call still succeeds. Response body matches GET (`optedOut` is `false` after success). To clear the whole list, use `DELETE /v1/address_registry/vaults`. * @summary Remove a single vault account from the address registry opt-out list * @param {number} vaultAccountId Vault account id (non-negative integer). * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeAddressRegistryVaultOptOut: (vaultAccountId: number, options?: RawAxiosRequestConfig) => Promise; /** * Removes all vault accounts from the workspace opt-out list. * @summary Remove all vault-level address registry opt-outs for the workspace * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeAllAddressRegistryVaultOptOuts: (options?: RawAxiosRequestConfig) => Promise; /** * Re-runs compliance screening on an incoming transaction that was rejected or failed by screening checks, moving it back to pending screening. This endpoint is only applicable to incoming transactions with a rejected/failed AML screening status. * @summary Rescreen a rejected transaction * @param {string} txId The transaction id that was rejected by screening checks * @param {RescreenTransactionRequest} [rescreenTransactionRequest] * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ rescreenRejectedTransaction: (txId: string, rescreenTransactionRequest?: RescreenTransactionRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Triggers a new transaction, with the API user as the initiator, bypassing the screening policy checks. This endpoint is restricted to Admin API users and is only applicable to outgoing transactions. * @summary Bypass Screening Policy * @param {string} txId The transaction id that was rejected by screening checks * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ retryRejectedTransactionBypassScreeningChecks: (txId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Set AML verdict for incoming transactions when **BYORK Super Light** (Manual Screening Verdict) is enabled. This endpoint is for Super Light only. For **BYORK Light**, use POST /screening/byork/verdict instead. When Super Light is retired, this endpoint will be deprecated; use the BYORK Light verdict API for new integrations. * @summary Set AML Verdict (BYORK Super Light) * @param {AmlVerdictManualRequest} amlVerdictManualRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setAmlVerdict: (amlVerdictManualRequest: AmlVerdictManualRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates timeout values for BYORK wait-for-response (incoming and/or outgoing). At least one of incomingTimeoutSeconds or outgoingTimeoutSeconds is required. Values must be within the ranges returned in GET config (timeoutRangeIncoming for incomingTimeoutSeconds, timeoutRangeOutgoing for outgoingTimeoutSeconds). Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Set BYORK Light timeouts * @param {ByorkSetTimeoutsRequest} byorkSetTimeoutsRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setByorkTimeouts: (byorkSetTimeoutsRequest: ByorkSetTimeoutsRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Submit verdict (ACCEPT or REJECT) for a transaction in the BYORK Light flow. If the transaction is awaiting your decision, the verdict is applied immediately (response status COMPLETED). If processing has not yet reached that point, the verdict is stored and applied when it does (response status PRE_ACCEPTED). Requires BYORK Light to be enabled for the tenant. * @summary Set BYORK Light verdict * @param {ByorkVerdictRequest} byorkVerdictRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setByorkVerdict: (byorkVerdictRequest: ByorkVerdictRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates bypass screening, inbound delay, or outbound delay configurations for AML. * @summary Update AML Configuration * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAmlScreeningConfiguration: (idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates an existing counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Update a counterparty group * @param {UpdateCounterpartyGroupRequest} updateCounterpartyGroupRequest * @param {string} groupId The unique identifier of the counterparty group * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCounterpartyGroup: (updateCounterpartyGroupRequest: UpdateCounterpartyGroupRequest, groupId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates the status of a legal entity registration. Setting isDefault to true marks the registration as the workspace default, which is applied to vault accounts that have no explicit legal entity mapping. Endpoint Permission: Admin, Non-Signing Admin. * @summary Update legal entity * @param {UpdateLegalEntityRequest} updateLegalEntityRequest * @param {string} legalEntityId The unique ID of the legal entity registration * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLegalEntity: (updateLegalEntityRequest: UpdateLegalEntityRequest, legalEntityId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Update tenant screening configuration. * @summary Tenant - Screening Configuration * @param {ScreeningUpdateConfigurations} screeningUpdateConfigurations * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateScreeningConfiguration: (screeningUpdateConfigurations: ScreeningUpdateConfigurations, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Updates bypass screening, inbound delay, or outbound delay configurations for Travel Rule. * @summary Update Travel Rule Configuration * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTravelRuleConfig: (idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; /** * Verifies a Proof of Ownership export against the record Fireblocks stored at creation. Returns `valid: false` (not 404) for an unknown, expired, or mismatched export. Available to any authenticated Fireblocks workspace, not just the export\'s original owner. * @summary Verify a Proof of Ownership export * @param {AddressRegistryVerifyProofOfOwnershipRequest} addressRegistryVerifyProofOfOwnershipRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyAddressRegistryProofOfOwnership: (addressRegistryVerifyProofOfOwnershipRequest: AddressRegistryVerifyProofOfOwnershipRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * ComplianceApi - functional programming interface * @export */ export declare const ComplianceApiFp: (configuration?: Configuration) => { /** * Activates ARS (Address Registry Screening) for the authenticated tenant (sets config.active to true). Once activated, ARS screening applies to matching transactions. * @summary Activate ARS (Address Registry Screening) * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateArsConfig(idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Activates BYORK Light for the authenticated tenant (sets config.active to true). Once activated, BYORK screening applies to matching transactions. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Activate BYORK Light * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateByorkConfig(idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Adds one or more vault account ids to the workspace opt-out list for the address registry. * @summary Add vault accounts to the address registry opt-out list * @param {AddressRegistryAddVaultOptOutsRequest} addressRegistryAddVaultOptOutsRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addAddressRegistryVaultOptOuts(addressRegistryAddVaultOptOutsRequest: AddressRegistryAddVaultOptOutsRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Assigns one or more vault accounts to a specific legal entity registration. Explicitly mapped vault accounts take precedence over the workspace default legal entity. Endpoint Permission: Admin, Non-Signing Admin. * @summary Assign vault accounts to a legal entity * @param {AssignVaultsToLegalEntityRequest} assignVaultsToLegalEntityRequest * @param {string} legalEntityId The unique ID of the legal entity registration * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ assignVaultsToLegalEntity(assignVaultsToLegalEntityRequest: AssignVaultsToLegalEntityRequest, legalEntityId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a Proof of Ownership PDF for a blockchain address owned by the authenticated workspace — for example, to share with a counterparty or bank as compliance evidence. Recipients can confirm it with `POST /v1/address_registry/proof_of_ownership_exports/verify`. Check `proofOfOwnershipAvailable` on `GET /v1/address_registry/legal_entities/{address}` first if you want to know whether create is likely to succeed. * @summary Create a Proof of Ownership PDF for an address * @param {AddressRegistryCreateProofOfOwnershipRequest} addressRegistryCreateProofOfOwnershipRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAddressRegistryProofOfOwnership(addressRegistryCreateProofOfOwnershipRequest: AddressRegistryCreateProofOfOwnershipRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates a new counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Create a counterparty group * @param {CreateCounterpartyGroupRequest} createCounterpartyGroupRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCounterpartyGroup(createCounterpartyGroupRequest: CreateCounterpartyGroupRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deactivates ARS (Address Registry Screening) for the authenticated tenant (sets config.active to false). Once deactivated, ARS screening no longer applies until activated again. * @summary Deactivate ARS (Address Registry Screening) * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateArsConfig(idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deactivates BYORK Light for the authenticated tenant (sets config.active to false). Once deactivated, BYORK screening no longer applies until activated again. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Deactivate BYORK Light * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateByorkConfig(idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Permanently deletes a counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Delete a counterparty group * @param {string} groupId The unique identifier of the counterparty group * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCounterpartyGroup(groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a legal entity will change the status of a legal entity registration to REVOKED. Endpoint Permission: Admin, Non-Signing Admin. * @summary Delete a legal entity * @param {string} legalEntityId The unique ID of the legal entity registration to delete * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteLegalEntity(legalEntityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Read your customer\'s organization-wide address registry setting. Workspaces without their own choice use this as the default. Returns `NOT_SET` when no choice has been made yet, or `OPTED_IN` / `OPTED_OUT` when one has. * @summary Get your customer\'s address registry default * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAddressRegistryCustomerParticipationStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Check whether this workspace uses the address registry. The response is `OPTED_IN` or `OPTED_OUT`. If this workspace has not been configured yet, it follows your customer\'s default (see `GET /v1/address_registry/customer`) when that default is `OPTED_IN` or `OPTED_OUT`; otherwise the workspace is opted in by default. * @summary Get address registry status for this workspace * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAddressRegistryTenantParticipationStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns whether this vault account is on the workspace opt-out list (`optedOut` true or false). List, add, and clear-all are available on `/v1/address_registry/vaults`; this path reads or removes one vault. * @summary Get whether a vault account is opted out of the address registry * @param {number} vaultAccountId Vault account id (non-negative integer). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAddressRegistryVaultOptOut(vaultAccountId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the post-screening policy for AML. * @summary AML - View Post-Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAmlPostScreeningPolicy(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the screening policy for AML. * @summary AML - View Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAmlScreeningPolicy(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves BYORK Light configuration for the authenticated tenant (timeouts, active flag, allowed timeout ranges). Returns default config when none exists. Requires BYORK Light to be enabled for the tenant. * @summary Get BYORK Light configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getByorkConfig(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the current BYORK verdict and status for a transaction. Status can be PRE_ACCEPTED, PENDING, RECEIVED (verdict is final but processing not yet complete), or COMPLETED. Requires BYORK Light to be enabled for the tenant. Returns 404 if no BYORK verdict is found for the transaction. * @summary Get BYORK Light verdict * @param {string} txId Transaction ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ getByorkVerdict(txId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the details of a specific counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. * @summary Get a counterparty group * @param {string} groupId The unique identifier of the counterparty group * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCounterpartyGroup(groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns details of a specific legal entity registration, including GLEIF data when available. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get a legal entity * @param {string} legalEntityId The unique ID of the legal entity registration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLegalEntity(legalEntityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns legal entity information for the given blockchain address (LEI data availability, LEI identifier, Travel Rule providers, contact email, and related fields — see response schema). URL-encode `{address}` when required. * @summary Look up legal entity by blockchain address * @param {string} address Blockchain address to look up * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLegalEntityForAddress(address: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the post-screening policy for Travel Rule. * @summary Travel Rule - View Post-Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPostScreeningPolicy(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provides all the compliance details for the given screened transaction. * @summary Provides all the compliance details for the given screened transaction. * @param {string} txId Fireblocks transaction ID of the screened transaction * @param {*} [options] Override http request option. * @throws {RequiredError} */ getScreeningFullDetails(txId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the screening policy for Travel Rule. * @summary Travel Rule - View Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getScreeningPolicy(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists vault accounts that are opted out of the address registry for this workspace. Pagination uses `next` and `prev` cursors from the response. If `pageSize` is omitted, **50** items are returned per page; allowed range is **1–100** per request. * @summary List vault-level address registry opt-outs (paginated) * @param {string} [pageCursor] Opaque cursor from a previous response (`next` or `prev`). Omit for the first page. * @param {number} [pageSize] Page size. Default **50** if omitted; must be between **1** and **100**. * @param {AddressRegistryVaultListOrder} [order] Sort direction by vault account id. Omit for ascending; use the enum value for descending. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAddressRegistryVaultOptOuts(pageCursor?: string, pageSize?: number, order?: AddressRegistryVaultListOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns a paginated list of counterparty groups. **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. * @summary List counterparty groups * @param {string} [pageCursor] Cursor of the required page * @param {number} [pageSize] Maximum number of items in the page * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCounterpartyGroups(pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns legal entity registrations for the workspace with cursor-based pagination. If query parameter vaultAccountId is used it returns the legal entity registration associated with a specific vault account. If no explicit mapping exists for the vault, the workspace default legal entity is returned. Returns an empty response if neither a vault mapping nor a default legal entity is configured. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary List legal entities (Paginated) * @param {string} [vaultAccountId] The ID of the vault account. When provided, returns the legal entity associated with that vault account and pagination parameters are ignored. * @param {string} [pageCursor] Cursor string returned in `next` or `prev` of a previous response. Ignored when `vaultAccountId` is provided. * @param {number} [pageSize] Maximum number of registrations to return. Ignored when `vaultAccountId` is provided. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLegalEntities(vaultAccountId?: string, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns vault account IDs explicitly assigned to a specific legal entity registration, with cursor-based pagination. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary List vault accounts for a legal entity (Paginated) * @param {string} legalEntityId The unique ID of the legal entity registration * @param {string} [pageCursor] Cursor string returned in `next` or `prev` of a previous response * @param {number} [pageSize] Maximum number of registrations to return * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVaultsForLegalEntity(legalEntityId: string, pageCursor?: string, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Set your customer\'s default to opted in. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_IN`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. * @summary Opt your customer in to the address registry * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ optInAddressRegistryCustomer(idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Turn on the address registry for this workspace. No request body. Returns `OPTED_IN`. * @summary Opt this workspace in to the address registry * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ optInAddressRegistryTenant(idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Set your customer\'s default to opted out. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_OUT`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. * @summary Opt your customer out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} */ optOutAddressRegistryCustomer(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Turn off the address registry for this workspace. No request body. Returns `OPTED_OUT`. * @summary Opt this workspace out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} */ optOutAddressRegistryTenant(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Registers a new legal entity for the workspace using its LEI (Legal Entity Identifier) code. The LEI is validated against the GLEIF registry. Each workspace can register multiple legal entities. Endpoint Permission: Admin, Non-Signing Admin. * @summary Register a new legal entity * @param {RegisterLegalEntityRequest} registerLegalEntityRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerLegalEntity(registerLegalEntityRequest: RegisterLegalEntityRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Removes this vault account id from the workspace opt-out list if it is present; otherwise the call still succeeds. Response body matches GET (`optedOut` is `false` after success). To clear the whole list, use `DELETE /v1/address_registry/vaults`. * @summary Remove a single vault account from the address registry opt-out list * @param {number} vaultAccountId Vault account id (non-negative integer). * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeAddressRegistryVaultOptOut(vaultAccountId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Removes all vault accounts from the workspace opt-out list. * @summary Remove all vault-level address registry opt-outs for the workspace * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeAllAddressRegistryVaultOptOuts(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Re-runs compliance screening on an incoming transaction that was rejected or failed by screening checks, moving it back to pending screening. This endpoint is only applicable to incoming transactions with a rejected/failed AML screening status. * @summary Rescreen a rejected transaction * @param {string} txId The transaction id that was rejected by screening checks * @param {RescreenTransactionRequest} [rescreenTransactionRequest] * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ rescreenRejectedTransaction(txId: string, rescreenTransactionRequest?: RescreenTransactionRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Triggers a new transaction, with the API user as the initiator, bypassing the screening policy checks. This endpoint is restricted to Admin API users and is only applicable to outgoing transactions. * @summary Bypass Screening Policy * @param {string} txId The transaction id that was rejected by screening checks * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ retryRejectedTransactionBypassScreeningChecks(txId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Set AML verdict for incoming transactions when **BYORK Super Light** (Manual Screening Verdict) is enabled. This endpoint is for Super Light only. For **BYORK Light**, use POST /screening/byork/verdict instead. When Super Light is retired, this endpoint will be deprecated; use the BYORK Light verdict API for new integrations. * @summary Set AML Verdict (BYORK Super Light) * @param {AmlVerdictManualRequest} amlVerdictManualRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setAmlVerdict(amlVerdictManualRequest: AmlVerdictManualRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates timeout values for BYORK wait-for-response (incoming and/or outgoing). At least one of incomingTimeoutSeconds or outgoingTimeoutSeconds is required. Values must be within the ranges returned in GET config (timeoutRangeIncoming for incomingTimeoutSeconds, timeoutRangeOutgoing for outgoingTimeoutSeconds). Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Set BYORK Light timeouts * @param {ByorkSetTimeoutsRequest} byorkSetTimeoutsRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setByorkTimeouts(byorkSetTimeoutsRequest: ByorkSetTimeoutsRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Submit verdict (ACCEPT or REJECT) for a transaction in the BYORK Light flow. If the transaction is awaiting your decision, the verdict is applied immediately (response status COMPLETED). If processing has not yet reached that point, the verdict is stored and applied when it does (response status PRE_ACCEPTED). Requires BYORK Light to be enabled for the tenant. * @summary Set BYORK Light verdict * @param {ByorkVerdictRequest} byorkVerdictRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setByorkVerdict(byorkVerdictRequest: ByorkVerdictRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates bypass screening, inbound delay, or outbound delay configurations for AML. * @summary Update AML Configuration * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAmlScreeningConfiguration(idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates an existing counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Update a counterparty group * @param {UpdateCounterpartyGroupRequest} updateCounterpartyGroupRequest * @param {string} groupId The unique identifier of the counterparty group * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCounterpartyGroup(updateCounterpartyGroupRequest: UpdateCounterpartyGroupRequest, groupId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates the status of a legal entity registration. Setting isDefault to true marks the registration as the workspace default, which is applied to vault accounts that have no explicit legal entity mapping. Endpoint Permission: Admin, Non-Signing Admin. * @summary Update legal entity * @param {UpdateLegalEntityRequest} updateLegalEntityRequest * @param {string} legalEntityId The unique ID of the legal entity registration * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLegalEntity(updateLegalEntityRequest: UpdateLegalEntityRequest, legalEntityId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update tenant screening configuration. * @summary Tenant - Screening Configuration * @param {ScreeningUpdateConfigurations} screeningUpdateConfigurations * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateScreeningConfiguration(screeningUpdateConfigurations: ScreeningUpdateConfigurations, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates bypass screening, inbound delay, or outbound delay configurations for Travel Rule. * @summary Update Travel Rule Configuration * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTravelRuleConfig(idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Verifies a Proof of Ownership export against the record Fireblocks stored at creation. Returns `valid: false` (not 404) for an unknown, expired, or mismatched export. Available to any authenticated Fireblocks workspace, not just the export\'s original owner. * @summary Verify a Proof of Ownership export * @param {AddressRegistryVerifyProofOfOwnershipRequest} addressRegistryVerifyProofOfOwnershipRequest * @param {string} [idempotencyKey] A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyAddressRegistryProofOfOwnership(addressRegistryVerifyProofOfOwnershipRequest: AddressRegistryVerifyProofOfOwnershipRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ComplianceApi - factory interface * @export */ export declare const ComplianceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Activates ARS (Address Registry Screening) for the authenticated tenant (sets config.active to true). Once activated, ARS screening applies to matching transactions. * @summary Activate ARS (Address Registry Screening) * @param {ComplianceApiActivateArsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateArsConfig(requestParameters?: ComplianceApiActivateArsConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Activates BYORK Light for the authenticated tenant (sets config.active to true). Once activated, BYORK screening applies to matching transactions. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Activate BYORK Light * @param {ComplianceApiActivateByorkConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateByorkConfig(requestParameters?: ComplianceApiActivateByorkConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Adds one or more vault account ids to the workspace opt-out list for the address registry. * @summary Add vault accounts to the address registry opt-out list * @param {ComplianceApiAddAddressRegistryVaultOptOutsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ addAddressRegistryVaultOptOuts(requestParameters: ComplianceApiAddAddressRegistryVaultOptOutsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Assigns one or more vault accounts to a specific legal entity registration. Explicitly mapped vault accounts take precedence over the workspace default legal entity. Endpoint Permission: Admin, Non-Signing Admin. * @summary Assign vault accounts to a legal entity * @param {ComplianceApiAssignVaultsToLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ assignVaultsToLegalEntity(requestParameters: ComplianceApiAssignVaultsToLegalEntityRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a Proof of Ownership PDF for a blockchain address owned by the authenticated workspace — for example, to share with a counterparty or bank as compliance evidence. Recipients can confirm it with `POST /v1/address_registry/proof_of_ownership_exports/verify`. Check `proofOfOwnershipAvailable` on `GET /v1/address_registry/legal_entities/{address}` first if you want to know whether create is likely to succeed. * @summary Create a Proof of Ownership PDF for an address * @param {ComplianceApiCreateAddressRegistryProofOfOwnershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAddressRegistryProofOfOwnership(requestParameters: ComplianceApiCreateAddressRegistryProofOfOwnershipRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates a new counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Create a counterparty group * @param {ComplianceApiCreateCounterpartyGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCounterpartyGroup(requestParameters: ComplianceApiCreateCounterpartyGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deactivates ARS (Address Registry Screening) for the authenticated tenant (sets config.active to false). Once deactivated, ARS screening no longer applies until activated again. * @summary Deactivate ARS (Address Registry Screening) * @param {ComplianceApiDeactivateArsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateArsConfig(requestParameters?: ComplianceApiDeactivateArsConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deactivates BYORK Light for the authenticated tenant (sets config.active to false). Once deactivated, BYORK screening no longer applies until activated again. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Deactivate BYORK Light * @param {ComplianceApiDeactivateByorkConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateByorkConfig(requestParameters?: ComplianceApiDeactivateByorkConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Permanently deletes a counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Delete a counterparty group * @param {ComplianceApiDeleteCounterpartyGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCounterpartyGroup(requestParameters: ComplianceApiDeleteCounterpartyGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a legal entity will change the status of a legal entity registration to REVOKED. Endpoint Permission: Admin, Non-Signing Admin. * @summary Delete a legal entity * @param {ComplianceApiDeleteLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteLegalEntity(requestParameters: ComplianceApiDeleteLegalEntityRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Read your customer\'s organization-wide address registry setting. Workspaces without their own choice use this as the default. Returns `NOT_SET` when no choice has been made yet, or `OPTED_IN` / `OPTED_OUT` when one has. * @summary Get your customer\'s address registry default * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAddressRegistryCustomerParticipationStatus(options?: RawAxiosRequestConfig): AxiosPromise; /** * Check whether this workspace uses the address registry. The response is `OPTED_IN` or `OPTED_OUT`. If this workspace has not been configured yet, it follows your customer\'s default (see `GET /v1/address_registry/customer`) when that default is `OPTED_IN` or `OPTED_OUT`; otherwise the workspace is opted in by default. * @summary Get address registry status for this workspace * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAddressRegistryTenantParticipationStatus(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns whether this vault account is on the workspace opt-out list (`optedOut` true or false). List, add, and clear-all are available on `/v1/address_registry/vaults`; this path reads or removes one vault. * @summary Get whether a vault account is opted out of the address registry * @param {ComplianceApiGetAddressRegistryVaultOptOutRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAddressRegistryVaultOptOut(requestParameters: ComplianceApiGetAddressRegistryVaultOptOutRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get the post-screening policy for AML. * @summary AML - View Post-Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAmlPostScreeningPolicy(options?: RawAxiosRequestConfig): AxiosPromise; /** * Get the screening policy for AML. * @summary AML - View Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAmlScreeningPolicy(options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves BYORK Light configuration for the authenticated tenant (timeouts, active flag, allowed timeout ranges). Returns default config when none exists. Requires BYORK Light to be enabled for the tenant. * @summary Get BYORK Light configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ getByorkConfig(options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the current BYORK verdict and status for a transaction. Status can be PRE_ACCEPTED, PENDING, RECEIVED (verdict is final but processing not yet complete), or COMPLETED. Requires BYORK Light to be enabled for the tenant. Returns 404 if no BYORK verdict is found for the transaction. * @summary Get BYORK Light verdict * @param {ComplianceApiGetByorkVerdictRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getByorkVerdict(requestParameters: ComplianceApiGetByorkVerdictRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns the details of a specific counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. * @summary Get a counterparty group * @param {ComplianceApiGetCounterpartyGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCounterpartyGroup(requestParameters: ComplianceApiGetCounterpartyGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns details of a specific legal entity registration, including GLEIF data when available. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get a legal entity * @param {ComplianceApiGetLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLegalEntity(requestParameters: ComplianceApiGetLegalEntityRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns legal entity information for the given blockchain address (LEI data availability, LEI identifier, Travel Rule providers, contact email, and related fields — see response schema). URL-encode `{address}` when required. * @summary Look up legal entity by blockchain address * @param {ComplianceApiGetLegalEntityForAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLegalEntityForAddress(requestParameters: ComplianceApiGetLegalEntityForAddressRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get the post-screening policy for Travel Rule. * @summary Travel Rule - View Post-Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPostScreeningPolicy(options?: RawAxiosRequestConfig): AxiosPromise; /** * Provides all the compliance details for the given screened transaction. * @summary Provides all the compliance details for the given screened transaction. * @param {ComplianceApiGetScreeningFullDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getScreeningFullDetails(requestParameters: ComplianceApiGetScreeningFullDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Get the screening policy for Travel Rule. * @summary Travel Rule - View Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} */ getScreeningPolicy(options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists vault accounts that are opted out of the address registry for this workspace. Pagination uses `next` and `prev` cursors from the response. If `pageSize` is omitted, **50** items are returned per page; allowed range is **1–100** per request. * @summary List vault-level address registry opt-outs (paginated) * @param {ComplianceApiListAddressRegistryVaultOptOutsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listAddressRegistryVaultOptOuts(requestParameters?: ComplianceApiListAddressRegistryVaultOptOutsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns a paginated list of counterparty groups. **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. * @summary List counterparty groups * @param {ComplianceApiListCounterpartyGroupsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCounterpartyGroups(requestParameters?: ComplianceApiListCounterpartyGroupsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns legal entity registrations for the workspace with cursor-based pagination. If query parameter vaultAccountId is used it returns the legal entity registration associated with a specific vault account. If no explicit mapping exists for the vault, the workspace default legal entity is returned. Returns an empty response if neither a vault mapping nor a default legal entity is configured. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary List legal entities (Paginated) * @param {ComplianceApiListLegalEntitiesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listLegalEntities(requestParameters?: ComplianceApiListLegalEntitiesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Returns vault account IDs explicitly assigned to a specific legal entity registration, with cursor-based pagination. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary List vault accounts for a legal entity (Paginated) * @param {ComplianceApiListVaultsForLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listVaultsForLegalEntity(requestParameters: ComplianceApiListVaultsForLegalEntityRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Set your customer\'s default to opted in. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_IN`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. * @summary Opt your customer in to the address registry * @param {ComplianceApiOptInAddressRegistryCustomerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ optInAddressRegistryCustomer(requestParameters?: ComplianceApiOptInAddressRegistryCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Turn on the address registry for this workspace. No request body. Returns `OPTED_IN`. * @summary Opt this workspace in to the address registry * @param {ComplianceApiOptInAddressRegistryTenantRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ optInAddressRegistryTenant(requestParameters?: ComplianceApiOptInAddressRegistryTenantRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Set your customer\'s default to opted out. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_OUT`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. * @summary Opt your customer out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} */ optOutAddressRegistryCustomer(options?: RawAxiosRequestConfig): AxiosPromise; /** * Turn off the address registry for this workspace. No request body. Returns `OPTED_OUT`. * @summary Opt this workspace out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} */ optOutAddressRegistryTenant(options?: RawAxiosRequestConfig): AxiosPromise; /** * Registers a new legal entity for the workspace using its LEI (Legal Entity Identifier) code. The LEI is validated against the GLEIF registry. Each workspace can register multiple legal entities. Endpoint Permission: Admin, Non-Signing Admin. * @summary Register a new legal entity * @param {ComplianceApiRegisterLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerLegalEntity(requestParameters: ComplianceApiRegisterLegalEntityRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Removes this vault account id from the workspace opt-out list if it is present; otherwise the call still succeeds. Response body matches GET (`optedOut` is `false` after success). To clear the whole list, use `DELETE /v1/address_registry/vaults`. * @summary Remove a single vault account from the address registry opt-out list * @param {ComplianceApiRemoveAddressRegistryVaultOptOutRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeAddressRegistryVaultOptOut(requestParameters: ComplianceApiRemoveAddressRegistryVaultOptOutRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Removes all vault accounts from the workspace opt-out list. * @summary Remove all vault-level address registry opt-outs for the workspace * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeAllAddressRegistryVaultOptOuts(options?: RawAxiosRequestConfig): AxiosPromise; /** * Re-runs compliance screening on an incoming transaction that was rejected or failed by screening checks, moving it back to pending screening. This endpoint is only applicable to incoming transactions with a rejected/failed AML screening status. * @summary Rescreen a rejected transaction * @param {ComplianceApiRescreenRejectedTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ rescreenRejectedTransaction(requestParameters: ComplianceApiRescreenRejectedTransactionRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Triggers a new transaction, with the API user as the initiator, bypassing the screening policy checks. This endpoint is restricted to Admin API users and is only applicable to outgoing transactions. * @summary Bypass Screening Policy * @param {ComplianceApiRetryRejectedTransactionBypassScreeningChecksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ retryRejectedTransactionBypassScreeningChecks(requestParameters: ComplianceApiRetryRejectedTransactionBypassScreeningChecksRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Set AML verdict for incoming transactions when **BYORK Super Light** (Manual Screening Verdict) is enabled. This endpoint is for Super Light only. For **BYORK Light**, use POST /screening/byork/verdict instead. When Super Light is retired, this endpoint will be deprecated; use the BYORK Light verdict API for new integrations. * @summary Set AML Verdict (BYORK Super Light) * @param {ComplianceApiSetAmlVerdictRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setAmlVerdict(requestParameters: ComplianceApiSetAmlVerdictRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates timeout values for BYORK wait-for-response (incoming and/or outgoing). At least one of incomingTimeoutSeconds or outgoingTimeoutSeconds is required. Values must be within the ranges returned in GET config (timeoutRangeIncoming for incomingTimeoutSeconds, timeoutRangeOutgoing for outgoingTimeoutSeconds). Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Set BYORK Light timeouts * @param {ComplianceApiSetByorkTimeoutsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setByorkTimeouts(requestParameters: ComplianceApiSetByorkTimeoutsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Submit verdict (ACCEPT or REJECT) for a transaction in the BYORK Light flow. If the transaction is awaiting your decision, the verdict is applied immediately (response status COMPLETED). If processing has not yet reached that point, the verdict is stored and applied when it does (response status PRE_ACCEPTED). Requires BYORK Light to be enabled for the tenant. * @summary Set BYORK Light verdict * @param {ComplianceApiSetByorkVerdictRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setByorkVerdict(requestParameters: ComplianceApiSetByorkVerdictRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates bypass screening, inbound delay, or outbound delay configurations for AML. * @summary Update AML Configuration * @param {ComplianceApiUpdateAmlScreeningConfigurationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateAmlScreeningConfiguration(requestParameters?: ComplianceApiUpdateAmlScreeningConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates an existing counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Update a counterparty group * @param {ComplianceApiUpdateCounterpartyGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCounterpartyGroup(requestParameters: ComplianceApiUpdateCounterpartyGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates the status of a legal entity registration. Setting isDefault to true marks the registration as the workspace default, which is applied to vault accounts that have no explicit legal entity mapping. Endpoint Permission: Admin, Non-Signing Admin. * @summary Update legal entity * @param {ComplianceApiUpdateLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLegalEntity(requestParameters: ComplianceApiUpdateLegalEntityRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update tenant screening configuration. * @summary Tenant - Screening Configuration * @param {ComplianceApiUpdateScreeningConfigurationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateScreeningConfiguration(requestParameters: ComplianceApiUpdateScreeningConfigurationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates bypass screening, inbound delay, or outbound delay configurations for Travel Rule. * @summary Update Travel Rule Configuration * @param {ComplianceApiUpdateTravelRuleConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTravelRuleConfig(requestParameters?: ComplianceApiUpdateTravelRuleConfigRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Verifies a Proof of Ownership export against the record Fireblocks stored at creation. Returns `valid: false` (not 404) for an unknown, expired, or mismatched export. Available to any authenticated Fireblocks workspace, not just the export\'s original owner. * @summary Verify a Proof of Ownership export * @param {ComplianceApiVerifyAddressRegistryProofOfOwnershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyAddressRegistryProofOfOwnership(requestParameters: ComplianceApiVerifyAddressRegistryProofOfOwnershipRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for activateArsConfig operation in ComplianceApi. * @export * @interface ComplianceApiActivateArsConfigRequest */ export interface ComplianceApiActivateArsConfigRequest { /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiActivateArsConfig */ readonly idempotencyKey?: string; } /** * Request parameters for activateByorkConfig operation in ComplianceApi. * @export * @interface ComplianceApiActivateByorkConfigRequest */ export interface ComplianceApiActivateByorkConfigRequest { /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiActivateByorkConfig */ readonly idempotencyKey?: string; } /** * Request parameters for addAddressRegistryVaultOptOuts operation in ComplianceApi. * @export * @interface ComplianceApiAddAddressRegistryVaultOptOutsRequest */ export interface ComplianceApiAddAddressRegistryVaultOptOutsRequest { /** * * @type {AddressRegistryAddVaultOptOutsRequest} * @memberof ComplianceApiAddAddressRegistryVaultOptOuts */ readonly addressRegistryAddVaultOptOutsRequest: AddressRegistryAddVaultOptOutsRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiAddAddressRegistryVaultOptOuts */ readonly idempotencyKey?: string; } /** * Request parameters for assignVaultsToLegalEntity operation in ComplianceApi. * @export * @interface ComplianceApiAssignVaultsToLegalEntityRequest */ export interface ComplianceApiAssignVaultsToLegalEntityRequest { /** * * @type {AssignVaultsToLegalEntityRequest} * @memberof ComplianceApiAssignVaultsToLegalEntity */ readonly assignVaultsToLegalEntityRequest: AssignVaultsToLegalEntityRequest; /** * The unique ID of the legal entity registration * @type {string} * @memberof ComplianceApiAssignVaultsToLegalEntity */ readonly legalEntityId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiAssignVaultsToLegalEntity */ readonly idempotencyKey?: string; } /** * Request parameters for createAddressRegistryProofOfOwnership operation in ComplianceApi. * @export * @interface ComplianceApiCreateAddressRegistryProofOfOwnershipRequest */ export interface ComplianceApiCreateAddressRegistryProofOfOwnershipRequest { /** * * @type {AddressRegistryCreateProofOfOwnershipRequest} * @memberof ComplianceApiCreateAddressRegistryProofOfOwnership */ readonly addressRegistryCreateProofOfOwnershipRequest: AddressRegistryCreateProofOfOwnershipRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiCreateAddressRegistryProofOfOwnership */ readonly idempotencyKey?: string; } /** * Request parameters for createCounterpartyGroup operation in ComplianceApi. * @export * @interface ComplianceApiCreateCounterpartyGroupRequest */ export interface ComplianceApiCreateCounterpartyGroupRequest { /** * * @type {CreateCounterpartyGroupRequest} * @memberof ComplianceApiCreateCounterpartyGroup */ readonly createCounterpartyGroupRequest: CreateCounterpartyGroupRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiCreateCounterpartyGroup */ readonly idempotencyKey?: string; } /** * Request parameters for deactivateArsConfig operation in ComplianceApi. * @export * @interface ComplianceApiDeactivateArsConfigRequest */ export interface ComplianceApiDeactivateArsConfigRequest { /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiDeactivateArsConfig */ readonly idempotencyKey?: string; } /** * Request parameters for deactivateByorkConfig operation in ComplianceApi. * @export * @interface ComplianceApiDeactivateByorkConfigRequest */ export interface ComplianceApiDeactivateByorkConfigRequest { /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiDeactivateByorkConfig */ readonly idempotencyKey?: string; } /** * Request parameters for deleteCounterpartyGroup operation in ComplianceApi. * @export * @interface ComplianceApiDeleteCounterpartyGroupRequest */ export interface ComplianceApiDeleteCounterpartyGroupRequest { /** * The unique identifier of the counterparty group * @type {string} * @memberof ComplianceApiDeleteCounterpartyGroup */ readonly groupId: string; } /** * Request parameters for deleteLegalEntity operation in ComplianceApi. * @export * @interface ComplianceApiDeleteLegalEntityRequest */ export interface ComplianceApiDeleteLegalEntityRequest { /** * The unique ID of the legal entity registration to delete * @type {string} * @memberof ComplianceApiDeleteLegalEntity */ readonly legalEntityId: string; } /** * Request parameters for getAddressRegistryVaultOptOut operation in ComplianceApi. * @export * @interface ComplianceApiGetAddressRegistryVaultOptOutRequest */ export interface ComplianceApiGetAddressRegistryVaultOptOutRequest { /** * Vault account id (non-negative integer). * @type {number} * @memberof ComplianceApiGetAddressRegistryVaultOptOut */ readonly vaultAccountId: number; } /** * Request parameters for getByorkVerdict operation in ComplianceApi. * @export * @interface ComplianceApiGetByorkVerdictRequest */ export interface ComplianceApiGetByorkVerdictRequest { /** * Transaction ID * @type {string} * @memberof ComplianceApiGetByorkVerdict */ readonly txId: string; } /** * Request parameters for getCounterpartyGroup operation in ComplianceApi. * @export * @interface ComplianceApiGetCounterpartyGroupRequest */ export interface ComplianceApiGetCounterpartyGroupRequest { /** * The unique identifier of the counterparty group * @type {string} * @memberof ComplianceApiGetCounterpartyGroup */ readonly groupId: string; } /** * Request parameters for getLegalEntity operation in ComplianceApi. * @export * @interface ComplianceApiGetLegalEntityRequest */ export interface ComplianceApiGetLegalEntityRequest { /** * The unique ID of the legal entity registration * @type {string} * @memberof ComplianceApiGetLegalEntity */ readonly legalEntityId: string; } /** * Request parameters for getLegalEntityForAddress operation in ComplianceApi. * @export * @interface ComplianceApiGetLegalEntityForAddressRequest */ export interface ComplianceApiGetLegalEntityForAddressRequest { /** * Blockchain address to look up * @type {string} * @memberof ComplianceApiGetLegalEntityForAddress */ readonly address: string; } /** * Request parameters for getScreeningFullDetails operation in ComplianceApi. * @export * @interface ComplianceApiGetScreeningFullDetailsRequest */ export interface ComplianceApiGetScreeningFullDetailsRequest { /** * Fireblocks transaction ID of the screened transaction * @type {string} * @memberof ComplianceApiGetScreeningFullDetails */ readonly txId: string; } /** * Request parameters for listAddressRegistryVaultOptOuts operation in ComplianceApi. * @export * @interface ComplianceApiListAddressRegistryVaultOptOutsRequest */ export interface ComplianceApiListAddressRegistryVaultOptOutsRequest { /** * Opaque cursor from a previous response (`next` or `prev`). Omit for the first page. * @type {string} * @memberof ComplianceApiListAddressRegistryVaultOptOuts */ readonly pageCursor?: string; /** * Page size. Default **50** if omitted; must be between **1** and **100**. * @type {number} * @memberof ComplianceApiListAddressRegistryVaultOptOuts */ readonly pageSize?: number; /** * Sort direction by vault account id. Omit for ascending; use the enum value for descending. * @type {AddressRegistryVaultListOrder} * @memberof ComplianceApiListAddressRegistryVaultOptOuts */ readonly order?: AddressRegistryVaultListOrder; } /** * Request parameters for listCounterpartyGroups operation in ComplianceApi. * @export * @interface ComplianceApiListCounterpartyGroupsRequest */ export interface ComplianceApiListCounterpartyGroupsRequest { /** * Cursor of the required page * @type {string} * @memberof ComplianceApiListCounterpartyGroups */ readonly pageCursor?: string; /** * Maximum number of items in the page * @type {number} * @memberof ComplianceApiListCounterpartyGroups */ readonly pageSize?: number; } /** * Request parameters for listLegalEntities operation in ComplianceApi. * @export * @interface ComplianceApiListLegalEntitiesRequest */ export interface ComplianceApiListLegalEntitiesRequest { /** * The ID of the vault account. When provided, returns the legal entity associated with that vault account and pagination parameters are ignored. * @type {string} * @memberof ComplianceApiListLegalEntities */ readonly vaultAccountId?: string; /** * Cursor string returned in `next` or `prev` of a previous response. Ignored when `vaultAccountId` is provided. * @type {string} * @memberof ComplianceApiListLegalEntities */ readonly pageCursor?: string; /** * Maximum number of registrations to return. Ignored when `vaultAccountId` is provided. * @type {number} * @memberof ComplianceApiListLegalEntities */ readonly pageSize?: number; } /** * Request parameters for listVaultsForLegalEntity operation in ComplianceApi. * @export * @interface ComplianceApiListVaultsForLegalEntityRequest */ export interface ComplianceApiListVaultsForLegalEntityRequest { /** * The unique ID of the legal entity registration * @type {string} * @memberof ComplianceApiListVaultsForLegalEntity */ readonly legalEntityId: string; /** * Cursor string returned in `next` or `prev` of a previous response * @type {string} * @memberof ComplianceApiListVaultsForLegalEntity */ readonly pageCursor?: string; /** * Maximum number of registrations to return * @type {number} * @memberof ComplianceApiListVaultsForLegalEntity */ readonly pageSize?: number; } /** * Request parameters for optInAddressRegistryCustomer operation in ComplianceApi. * @export * @interface ComplianceApiOptInAddressRegistryCustomerRequest */ export interface ComplianceApiOptInAddressRegistryCustomerRequest { /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiOptInAddressRegistryCustomer */ readonly idempotencyKey?: string; } /** * Request parameters for optInAddressRegistryTenant operation in ComplianceApi. * @export * @interface ComplianceApiOptInAddressRegistryTenantRequest */ export interface ComplianceApiOptInAddressRegistryTenantRequest { /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiOptInAddressRegistryTenant */ readonly idempotencyKey?: string; } /** * Request parameters for registerLegalEntity operation in ComplianceApi. * @export * @interface ComplianceApiRegisterLegalEntityRequest */ export interface ComplianceApiRegisterLegalEntityRequest { /** * * @type {RegisterLegalEntityRequest} * @memberof ComplianceApiRegisterLegalEntity */ readonly registerLegalEntityRequest: RegisterLegalEntityRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiRegisterLegalEntity */ readonly idempotencyKey?: string; } /** * Request parameters for removeAddressRegistryVaultOptOut operation in ComplianceApi. * @export * @interface ComplianceApiRemoveAddressRegistryVaultOptOutRequest */ export interface ComplianceApiRemoveAddressRegistryVaultOptOutRequest { /** * Vault account id (non-negative integer). * @type {number} * @memberof ComplianceApiRemoveAddressRegistryVaultOptOut */ readonly vaultAccountId: number; } /** * Request parameters for rescreenRejectedTransaction operation in ComplianceApi. * @export * @interface ComplianceApiRescreenRejectedTransactionRequest */ export interface ComplianceApiRescreenRejectedTransactionRequest { /** * The transaction id that was rejected by screening checks * @type {string} * @memberof ComplianceApiRescreenRejectedTransaction */ readonly txId: string; /** * * @type {RescreenTransactionRequest} * @memberof ComplianceApiRescreenRejectedTransaction */ readonly rescreenTransactionRequest?: RescreenTransactionRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiRescreenRejectedTransaction */ readonly idempotencyKey?: string; } /** * Request parameters for retryRejectedTransactionBypassScreeningChecks operation in ComplianceApi. * @export * @interface ComplianceApiRetryRejectedTransactionBypassScreeningChecksRequest */ export interface ComplianceApiRetryRejectedTransactionBypassScreeningChecksRequest { /** * The transaction id that was rejected by screening checks * @type {string} * @memberof ComplianceApiRetryRejectedTransactionBypassScreeningChecks */ readonly txId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiRetryRejectedTransactionBypassScreeningChecks */ readonly idempotencyKey?: string; } /** * Request parameters for setAmlVerdict operation in ComplianceApi. * @export * @interface ComplianceApiSetAmlVerdictRequest */ export interface ComplianceApiSetAmlVerdictRequest { /** * * @type {AmlVerdictManualRequest} * @memberof ComplianceApiSetAmlVerdict */ readonly amlVerdictManualRequest: AmlVerdictManualRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiSetAmlVerdict */ readonly idempotencyKey?: string; } /** * Request parameters for setByorkTimeouts operation in ComplianceApi. * @export * @interface ComplianceApiSetByorkTimeoutsRequest */ export interface ComplianceApiSetByorkTimeoutsRequest { /** * * @type {ByorkSetTimeoutsRequest} * @memberof ComplianceApiSetByorkTimeouts */ readonly byorkSetTimeoutsRequest: ByorkSetTimeoutsRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiSetByorkTimeouts */ readonly idempotencyKey?: string; } /** * Request parameters for setByorkVerdict operation in ComplianceApi. * @export * @interface ComplianceApiSetByorkVerdictRequest */ export interface ComplianceApiSetByorkVerdictRequest { /** * * @type {ByorkVerdictRequest} * @memberof ComplianceApiSetByorkVerdict */ readonly byorkVerdictRequest: ByorkVerdictRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiSetByorkVerdict */ readonly idempotencyKey?: string; } /** * Request parameters for updateAmlScreeningConfiguration operation in ComplianceApi. * @export * @interface ComplianceApiUpdateAmlScreeningConfigurationRequest */ export interface ComplianceApiUpdateAmlScreeningConfigurationRequest { /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiUpdateAmlScreeningConfiguration */ readonly idempotencyKey?: string; } /** * Request parameters for updateCounterpartyGroup operation in ComplianceApi. * @export * @interface ComplianceApiUpdateCounterpartyGroupRequest */ export interface ComplianceApiUpdateCounterpartyGroupRequest { /** * * @type {UpdateCounterpartyGroupRequest} * @memberof ComplianceApiUpdateCounterpartyGroup */ readonly updateCounterpartyGroupRequest: UpdateCounterpartyGroupRequest; /** * The unique identifier of the counterparty group * @type {string} * @memberof ComplianceApiUpdateCounterpartyGroup */ readonly groupId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiUpdateCounterpartyGroup */ readonly idempotencyKey?: string; } /** * Request parameters for updateLegalEntity operation in ComplianceApi. * @export * @interface ComplianceApiUpdateLegalEntityRequest */ export interface ComplianceApiUpdateLegalEntityRequest { /** * * @type {UpdateLegalEntityRequest} * @memberof ComplianceApiUpdateLegalEntity */ readonly updateLegalEntityRequest: UpdateLegalEntityRequest; /** * The unique ID of the legal entity registration * @type {string} * @memberof ComplianceApiUpdateLegalEntity */ readonly legalEntityId: string; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiUpdateLegalEntity */ readonly idempotencyKey?: string; } /** * Request parameters for updateScreeningConfiguration operation in ComplianceApi. * @export * @interface ComplianceApiUpdateScreeningConfigurationRequest */ export interface ComplianceApiUpdateScreeningConfigurationRequest { /** * * @type {ScreeningUpdateConfigurations} * @memberof ComplianceApiUpdateScreeningConfiguration */ readonly screeningUpdateConfigurations: ScreeningUpdateConfigurations; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiUpdateScreeningConfiguration */ readonly idempotencyKey?: string; } /** * Request parameters for updateTravelRuleConfig operation in ComplianceApi. * @export * @interface ComplianceApiUpdateTravelRuleConfigRequest */ export interface ComplianceApiUpdateTravelRuleConfigRequest { /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiUpdateTravelRuleConfig */ readonly idempotencyKey?: string; } /** * Request parameters for verifyAddressRegistryProofOfOwnership operation in ComplianceApi. * @export * @interface ComplianceApiVerifyAddressRegistryProofOfOwnershipRequest */ export interface ComplianceApiVerifyAddressRegistryProofOfOwnershipRequest { /** * * @type {AddressRegistryVerifyProofOfOwnershipRequest} * @memberof ComplianceApiVerifyAddressRegistryProofOfOwnership */ readonly addressRegistryVerifyProofOfOwnershipRequest: AddressRegistryVerifyProofOfOwnershipRequest; /** * A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. * @type {string} * @memberof ComplianceApiVerifyAddressRegistryProofOfOwnership */ readonly idempotencyKey?: string; } /** * ComplianceApi - object-oriented interface * @export * @class ComplianceApi * @extends {BaseAPI} */ export declare class ComplianceApi extends BaseAPI { /** * Activates ARS (Address Registry Screening) for the authenticated tenant (sets config.active to true). Once activated, ARS screening applies to matching transactions. * @summary Activate ARS (Address Registry Screening) * @param {ComplianceApiActivateArsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ activateArsConfig(requestParameters?: ComplianceApiActivateArsConfigRequest): Promise>; /** * Activates BYORK Light for the authenticated tenant (sets config.active to true). Once activated, BYORK screening applies to matching transactions. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Activate BYORK Light * @param {ComplianceApiActivateByorkConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ activateByorkConfig(requestParameters?: ComplianceApiActivateByorkConfigRequest): Promise>; /** * Adds one or more vault account ids to the workspace opt-out list for the address registry. * @summary Add vault accounts to the address registry opt-out list * @param {ComplianceApiAddAddressRegistryVaultOptOutsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ addAddressRegistryVaultOptOuts(requestParameters: ComplianceApiAddAddressRegistryVaultOptOutsRequest): Promise>; /** * Assigns one or more vault accounts to a specific legal entity registration. Explicitly mapped vault accounts take precedence over the workspace default legal entity. Endpoint Permission: Admin, Non-Signing Admin. * @summary Assign vault accounts to a legal entity * @param {ComplianceApiAssignVaultsToLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ assignVaultsToLegalEntity(requestParameters: ComplianceApiAssignVaultsToLegalEntityRequest): Promise>; /** * Creates a Proof of Ownership PDF for a blockchain address owned by the authenticated workspace — for example, to share with a counterparty or bank as compliance evidence. Recipients can confirm it with `POST /v1/address_registry/proof_of_ownership_exports/verify`. Check `proofOfOwnershipAvailable` on `GET /v1/address_registry/legal_entities/{address}` first if you want to know whether create is likely to succeed. * @summary Create a Proof of Ownership PDF for an address * @param {ComplianceApiCreateAddressRegistryProofOfOwnershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ createAddressRegistryProofOfOwnership(requestParameters: ComplianceApiCreateAddressRegistryProofOfOwnershipRequest): Promise>; /** * Creates a new counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Create a counterparty group * @param {ComplianceApiCreateCounterpartyGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ createCounterpartyGroup(requestParameters: ComplianceApiCreateCounterpartyGroupRequest): Promise>; /** * Deactivates ARS (Address Registry Screening) for the authenticated tenant (sets config.active to false). Once deactivated, ARS screening no longer applies until activated again. * @summary Deactivate ARS (Address Registry Screening) * @param {ComplianceApiDeactivateArsConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ deactivateArsConfig(requestParameters?: ComplianceApiDeactivateArsConfigRequest): Promise>; /** * Deactivates BYORK Light for the authenticated tenant (sets config.active to false). Once deactivated, BYORK screening no longer applies until activated again. Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Deactivate BYORK Light * @param {ComplianceApiDeactivateByorkConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ deactivateByorkConfig(requestParameters?: ComplianceApiDeactivateByorkConfigRequest): Promise>; /** * Permanently deletes a counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Delete a counterparty group * @param {ComplianceApiDeleteCounterpartyGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ deleteCounterpartyGroup(requestParameters: ComplianceApiDeleteCounterpartyGroupRequest): Promise>; /** * Delete a legal entity will change the status of a legal entity registration to REVOKED. Endpoint Permission: Admin, Non-Signing Admin. * @summary Delete a legal entity * @param {ComplianceApiDeleteLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ deleteLegalEntity(requestParameters: ComplianceApiDeleteLegalEntityRequest): Promise>; /** * Read your customer\'s organization-wide address registry setting. Workspaces without their own choice use this as the default. Returns `NOT_SET` when no choice has been made yet, or `OPTED_IN` / `OPTED_OUT` when one has. * @summary Get your customer\'s address registry default * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getAddressRegistryCustomerParticipationStatus(): Promise>; /** * Check whether this workspace uses the address registry. The response is `OPTED_IN` or `OPTED_OUT`. If this workspace has not been configured yet, it follows your customer\'s default (see `GET /v1/address_registry/customer`) when that default is `OPTED_IN` or `OPTED_OUT`; otherwise the workspace is opted in by default. * @summary Get address registry status for this workspace * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getAddressRegistryTenantParticipationStatus(): Promise>; /** * Returns whether this vault account is on the workspace opt-out list (`optedOut` true or false). List, add, and clear-all are available on `/v1/address_registry/vaults`; this path reads or removes one vault. * @summary Get whether a vault account is opted out of the address registry * @param {ComplianceApiGetAddressRegistryVaultOptOutRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getAddressRegistryVaultOptOut(requestParameters: ComplianceApiGetAddressRegistryVaultOptOutRequest): Promise>; /** * Get the post-screening policy for AML. * @summary AML - View Post-Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getAmlPostScreeningPolicy(): Promise>; /** * Get the screening policy for AML. * @summary AML - View Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getAmlScreeningPolicy(): Promise>; /** * Retrieves BYORK Light configuration for the authenticated tenant (timeouts, active flag, allowed timeout ranges). Returns default config when none exists. Requires BYORK Light to be enabled for the tenant. * @summary Get BYORK Light configuration * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getByorkConfig(): Promise>; /** * Returns the current BYORK verdict and status for a transaction. Status can be PRE_ACCEPTED, PENDING, RECEIVED (verdict is final but processing not yet complete), or COMPLETED. Requires BYORK Light to be enabled for the tenant. Returns 404 if no BYORK verdict is found for the transaction. * @summary Get BYORK Light verdict * @param {ComplianceApiGetByorkVerdictRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getByorkVerdict(requestParameters: ComplianceApiGetByorkVerdictRequest): Promise>; /** * Returns the details of a specific counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. * @summary Get a counterparty group * @param {ComplianceApiGetCounterpartyGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getCounterpartyGroup(requestParameters: ComplianceApiGetCounterpartyGroupRequest): Promise>; /** * Returns details of a specific legal entity registration, including GLEIF data when available. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary Get a legal entity * @param {ComplianceApiGetLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getLegalEntity(requestParameters: ComplianceApiGetLegalEntityRequest): Promise>; /** * Returns legal entity information for the given blockchain address (LEI data availability, LEI identifier, Travel Rule providers, contact email, and related fields — see response schema). URL-encode `{address}` when required. * @summary Look up legal entity by blockchain address * @param {ComplianceApiGetLegalEntityForAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getLegalEntityForAddress(requestParameters: ComplianceApiGetLegalEntityForAddressRequest): Promise>; /** * Get the post-screening policy for Travel Rule. * @summary Travel Rule - View Post-Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getPostScreeningPolicy(): Promise>; /** * Provides all the compliance details for the given screened transaction. * @summary Provides all the compliance details for the given screened transaction. * @param {ComplianceApiGetScreeningFullDetailsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getScreeningFullDetails(requestParameters: ComplianceApiGetScreeningFullDetailsRequest): Promise>; /** * Get the screening policy for Travel Rule. * @summary Travel Rule - View Screening Policy * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ getScreeningPolicy(): Promise>; /** * Lists vault accounts that are opted out of the address registry for this workspace. Pagination uses `next` and `prev` cursors from the response. If `pageSize` is omitted, **50** items are returned per page; allowed range is **1–100** per request. * @summary List vault-level address registry opt-outs (paginated) * @param {ComplianceApiListAddressRegistryVaultOptOutsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ listAddressRegistryVaultOptOuts(requestParameters?: ComplianceApiListAddressRegistryVaultOptOutsRequest): Promise>; /** * Returns a paginated list of counterparty groups. **Endpoint Permissions:** Admin, Non-Signing Admin, Viewer. * @summary List counterparty groups * @param {ComplianceApiListCounterpartyGroupsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ listCounterpartyGroups(requestParameters?: ComplianceApiListCounterpartyGroupsRequest): Promise>; /** * Returns legal entity registrations for the workspace with cursor-based pagination. If query parameter vaultAccountId is used it returns the legal entity registration associated with a specific vault account. If no explicit mapping exists for the vault, the workspace default legal entity is returned. Returns an empty response if neither a vault mapping nor a default legal entity is configured. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary List legal entities (Paginated) * @param {ComplianceApiListLegalEntitiesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ listLegalEntities(requestParameters?: ComplianceApiListLegalEntitiesRequest): Promise>; /** * Returns vault account IDs explicitly assigned to a specific legal entity registration, with cursor-based pagination. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. * @summary List vault accounts for a legal entity (Paginated) * @param {ComplianceApiListVaultsForLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ listVaultsForLegalEntity(requestParameters: ComplianceApiListVaultsForLegalEntityRequest): Promise>; /** * Set your customer\'s default to opted in. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_IN`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. * @summary Opt your customer in to the address registry * @param {ComplianceApiOptInAddressRegistryCustomerRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ optInAddressRegistryCustomer(requestParameters?: ComplianceApiOptInAddressRegistryCustomerRequest): Promise>; /** * Turn on the address registry for this workspace. No request body. Returns `OPTED_IN`. * @summary Opt this workspace in to the address registry * @param {ComplianceApiOptInAddressRegistryTenantRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ optInAddressRegistryTenant(requestParameters?: ComplianceApiOptInAddressRegistryTenantRequest): Promise>; /** * Set your customer\'s default to opted out. Workspaces without their own setting will follow this default. No request body. Returns `OPTED_OUT`. If the customer for this workspace cannot be determined, returns HTTP 404 with error code **2147**. * @summary Opt your customer out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ optOutAddressRegistryCustomer(): Promise>; /** * Turn off the address registry for this workspace. No request body. Returns `OPTED_OUT`. * @summary Opt this workspace out of the address registry * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ optOutAddressRegistryTenant(): Promise>; /** * Registers a new legal entity for the workspace using its LEI (Legal Entity Identifier) code. The LEI is validated against the GLEIF registry. Each workspace can register multiple legal entities. Endpoint Permission: Admin, Non-Signing Admin. * @summary Register a new legal entity * @param {ComplianceApiRegisterLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ registerLegalEntity(requestParameters: ComplianceApiRegisterLegalEntityRequest): Promise>; /** * Removes this vault account id from the workspace opt-out list if it is present; otherwise the call still succeeds. Response body matches GET (`optedOut` is `false` after success). To clear the whole list, use `DELETE /v1/address_registry/vaults`. * @summary Remove a single vault account from the address registry opt-out list * @param {ComplianceApiRemoveAddressRegistryVaultOptOutRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ removeAddressRegistryVaultOptOut(requestParameters: ComplianceApiRemoveAddressRegistryVaultOptOutRequest): Promise>; /** * Removes all vault accounts from the workspace opt-out list. * @summary Remove all vault-level address registry opt-outs for the workspace * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ removeAllAddressRegistryVaultOptOuts(): Promise>; /** * Re-runs compliance screening on an incoming transaction that was rejected or failed by screening checks, moving it back to pending screening. This endpoint is only applicable to incoming transactions with a rejected/failed AML screening status. * @summary Rescreen a rejected transaction * @param {ComplianceApiRescreenRejectedTransactionRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ rescreenRejectedTransaction(requestParameters: ComplianceApiRescreenRejectedTransactionRequest): Promise>; /** * Triggers a new transaction, with the API user as the initiator, bypassing the screening policy checks. This endpoint is restricted to Admin API users and is only applicable to outgoing transactions. * @summary Bypass Screening Policy * @param {ComplianceApiRetryRejectedTransactionBypassScreeningChecksRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ retryRejectedTransactionBypassScreeningChecks(requestParameters: ComplianceApiRetryRejectedTransactionBypassScreeningChecksRequest): Promise>; /** * Set AML verdict for incoming transactions when **BYORK Super Light** (Manual Screening Verdict) is enabled. This endpoint is for Super Light only. For **BYORK Light**, use POST /screening/byork/verdict instead. When Super Light is retired, this endpoint will be deprecated; use the BYORK Light verdict API for new integrations. * @summary Set AML Verdict (BYORK Super Light) * @param {ComplianceApiSetAmlVerdictRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ setAmlVerdict(requestParameters: ComplianceApiSetAmlVerdictRequest): Promise>; /** * Updates timeout values for BYORK wait-for-response (incoming and/or outgoing). At least one of incomingTimeoutSeconds or outgoingTimeoutSeconds is required. Values must be within the ranges returned in GET config (timeoutRangeIncoming for incomingTimeoutSeconds, timeoutRangeOutgoing for outgoingTimeoutSeconds). Requires BYORK Light to be enabled for the tenant (contact your CSM to enable). * @summary Set BYORK Light timeouts * @param {ComplianceApiSetByorkTimeoutsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ setByorkTimeouts(requestParameters: ComplianceApiSetByorkTimeoutsRequest): Promise>; /** * Submit verdict (ACCEPT or REJECT) for a transaction in the BYORK Light flow. If the transaction is awaiting your decision, the verdict is applied immediately (response status COMPLETED). If processing has not yet reached that point, the verdict is stored and applied when it does (response status PRE_ACCEPTED). Requires BYORK Light to be enabled for the tenant. * @summary Set BYORK Light verdict * @param {ComplianceApiSetByorkVerdictRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ setByorkVerdict(requestParameters: ComplianceApiSetByorkVerdictRequest): Promise>; /** * Updates bypass screening, inbound delay, or outbound delay configurations for AML. * @summary Update AML Configuration * @param {ComplianceApiUpdateAmlScreeningConfigurationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ updateAmlScreeningConfiguration(requestParameters?: ComplianceApiUpdateAmlScreeningConfigurationRequest): Promise>; /** * Updates an existing counterparty group. **Endpoint Permissions:** Admin, Non-Signing Admin. * @summary Update a counterparty group * @param {ComplianceApiUpdateCounterpartyGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ updateCounterpartyGroup(requestParameters: ComplianceApiUpdateCounterpartyGroupRequest): Promise>; /** * Updates the status of a legal entity registration. Setting isDefault to true marks the registration as the workspace default, which is applied to vault accounts that have no explicit legal entity mapping. Endpoint Permission: Admin, Non-Signing Admin. * @summary Update legal entity * @param {ComplianceApiUpdateLegalEntityRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ updateLegalEntity(requestParameters: ComplianceApiUpdateLegalEntityRequest): Promise>; /** * Update tenant screening configuration. * @summary Tenant - Screening Configuration * @param {ComplianceApiUpdateScreeningConfigurationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ updateScreeningConfiguration(requestParameters: ComplianceApiUpdateScreeningConfigurationRequest): Promise>; /** * Updates bypass screening, inbound delay, or outbound delay configurations for Travel Rule. * @summary Update Travel Rule Configuration * @param {ComplianceApiUpdateTravelRuleConfigRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ updateTravelRuleConfig(requestParameters?: ComplianceApiUpdateTravelRuleConfigRequest): Promise>; /** * Verifies a Proof of Ownership export against the record Fireblocks stored at creation. Returns `valid: false` (not 404) for an unknown, expired, or mismatched export. Available to any authenticated Fireblocks workspace, not just the export\'s original owner. * @summary Verify a Proof of Ownership export * @param {ComplianceApiVerifyAddressRegistryProofOfOwnershipRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ComplianceApi */ verifyAddressRegistryProofOfOwnership(requestParameters: ComplianceApiVerifyAddressRegistryProofOfOwnershipRequest): Promise>; }