# Fireblocks Developer Docs: API API Endpoints Compliance ## Compliance - [Look up legal entity by blockchain address](https://developers.fireblocks.com/api-reference/compliance/look-up-legal-entity-by-blockchain-address.md): 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. - [Create a Proof of Ownership PDF for an address](https://developers.fireblocks.com/api-reference/compliance/create-a-proof-of-ownership-pdf-for-an-address.md): 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`. - [Verify a Proof of Ownership export](https://developers.fireblocks.com/api-reference/compliance/verify-a-proof-of-ownership-export.md): 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. - [Get address registry participation status for the authenticated workspace](https://developers.fireblocks.com/api-reference/compliance/get-address-registry-participation-status-for-the-authenticated-workspace.md): Returns whether the workspace is `OPTED_IN` or `OPTED_OUT` of the address registry. - [Opt the workspace in to the address registry](https://developers.fireblocks.com/api-reference/compliance/opt-the-workspace-in-to-the-address-registry.md): Opts the workspace in. No request body. Response uses the same JSON shape as GET; status is OPTED_IN. - [Opt the workspace out of the address registry](https://developers.fireblocks.com/api-reference/compliance/opt-the-workspace-out-of-the-address-registry.md): Opts the workspace out. No request body. Response uses the same JSON shape as GET; status is OPTED_OUT. - [List vault-level address registry opt-outs (paginated)](https://developers.fireblocks.com/api-reference/compliance/list-vault-level-address-registry-opt-outs-paginated.md): 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. - [Add vault accounts to the address registry opt-out list](https://developers.fireblocks.com/api-reference/compliance/add-vault-accounts-to-the-address-registry-opt-out-list.md): Adds one or more vault account ids to the workspace opt-out list for the address registry. - [Remove all vault-level address registry opt-outs for the workspace](https://developers.fireblocks.com/api-reference/compliance/remove-all-vault-level-address-registry-opt-outs-for-the-workspace.md): Removes all vault accounts from the workspace opt-out list. - [Get whether a vault account is opted out of the address registry](https://developers.fireblocks.com/api-reference/compliance/get-whether-a-vault-account-is-opted-out-of-the-address-registry.md): 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. - [Remove a single vault account from the address registry opt-out list](https://developers.fireblocks.com/api-reference/compliance/remove-a-single-vault-account-from-the-address-registry-opt-out-list.md): 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`. - [List counterparty groups](https://developers.fireblocks.com/api-reference/compliance/list-counterparty-groups.md): Returns a paginated list of counterparty groups. - [Create a counterparty group](https://developers.fireblocks.com/api-reference/compliance/create-a-counterparty-group.md): Creates a new counterparty group. - [Get a counterparty group](https://developers.fireblocks.com/api-reference/compliance/get-a-counterparty-group.md): Returns the details of a specific counterparty group. - [Delete a counterparty group](https://developers.fireblocks.com/api-reference/compliance/delete-a-counterparty-group.md): Permanently deletes a counterparty group. - [Update a counterparty group](https://developers.fireblocks.com/api-reference/compliance/update-a-counterparty-group.md): Updates an existing counterparty group. - [List legal entities (Paginated)](https://developers.fireblocks.com/api-reference/compliance/list-legal-entities-paginated.md): 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.… - [Register a new legal entity](https://developers.fireblocks.com/api-reference/compliance/register-a-new-legal-entity.md): 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. - [Get a legal entity](https://developers.fireblocks.com/api-reference/compliance/get-a-legal-entity.md): Returns details of a specific legal entity registration, including GLEIF data when available. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer. - [Update legal entity](https://developers.fireblocks.com/api-reference/compliance/update-legal-entity.md): 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. - [Delete a legal entity](https://developers.fireblocks.com/api-reference/compliance/delete-a-legal-entity.md): Delete a legal entity will change the status of a legal entity registration to REVOKED. Endpoint Permission: Admin, Non-Signing Admin. - [List vault accounts for a legal entity (Paginated)](https://developers.fireblocks.com/api-reference/compliance/list-vault-accounts-for-a-legal-entity-paginated.md): 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. - [Assign vault accounts to a legal entity](https://developers.fireblocks.com/api-reference/compliance/assign-vault-accounts-to-a-legal-entity.md): 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. - [Update AML Configuration](https://developers.fireblocks.com/api-reference/compliance/update-aml-configuration.md): Updates bypass screening, inbound delay, or outbound delay configurations for AML. - [AML - View Post-Screening Policy](https://developers.fireblocks.com/api-reference/compliance/aml--view-post-screening-policy.md): Get the post-screening policy for AML. - [AML - View Screening Policy](https://developers.fireblocks.com/api-reference/compliance/aml--view-screening-policy.md): Get the screening policy for AML. - [Set AML Verdict (BYORK Super Light)](https://developers.fireblocks.com/api-reference/compliance/set-aml-verdict-byork-super-light.md): 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 verdic… - [Activate ARS (Address Registry Screening)](https://developers.fireblocks.com/api-reference/compliance/activate-ars-address-registry-screening.md): Activates ARS (Address Registry Screening) for the authenticated tenant (sets config.active to true). Once activated, ARS screening applies to matching transactions. - [Deactivate ARS (Address Registry Screening)](https://developers.fireblocks.com/api-reference/compliance/deactivate-ars-address-registry-screening.md): Deactivates ARS (Address Registry Screening) for the authenticated tenant (sets config.active to false). Once deactivated, ARS screening no longer applies until activated again. - [Get BYORK Light configuration](https://developers.fireblocks.com/api-reference/compliance/get-byork-light-configuration.md): 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. - [Activate BYORK Light](https://developers.fireblocks.com/api-reference/compliance/activate-byork-light.md): 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). - [Deactivate BYORK Light](https://developers.fireblocks.com/api-reference/compliance/deactivate-byork-light.md): 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). - [Set BYORK Light timeouts](https://developers.fireblocks.com/api-reference/compliance/set-byork-light-timeouts.md): 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 outgoingTime… - [Get BYORK Light verdict](https://developers.fireblocks.com/api-reference/compliance/get-byork-light-verdict.md): 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. - [Set BYORK Light verdict](https://developers.fireblocks.com/api-reference/compliance/set-byork-light-verdict.md): 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… - [Tenant - Screening Configuration](https://developers.fireblocks.com/api-reference/compliance/tenant--screening-configuration.md): Update tenant screening configuration. - [Provides all the compliance details for the given screened transaction.](https://developers.fireblocks.com/api-reference/compliance/provides-all-the-compliance-details-for-the-given-screened-transaction.md): Provides all the compliance details for the given screened transaction. - [Bypass Screening Policy](https://developers.fireblocks.com/api-reference/compliance/bypass-screening-policy.md): 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. - [Rescreen a rejected transaction](https://developers.fireblocks.com/api-reference/compliance/rescreen-a-rejected-transaction.md): 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. - [Update Travel Rule Configuration](https://developers.fireblocks.com/api-reference/compliance/update-travel-rule-configuration.md): Updates bypass screening, inbound delay, or outbound delay configurations for Travel Rule. - [Travel Rule - View Post-Screening Policy](https://developers.fireblocks.com/api-reference/compliance/travel-rule--view-post-screening-policy.md): Get the post-screening policy for Travel Rule. - [Travel Rule - View Screening Policy](https://developers.fireblocks.com/api-reference/compliance/travel-rule--view-screening-policy.md): Get the screening policy for Travel Rule. ## OpenAPI Specs - [openapi](https://swagger.fireblocks.com/openapi.yaml)