# Compliance

Compliance API operations enable the creation of compliance-related domains, integration with compliance providers, management of risk score configurations, and execution of compliance analyses. They facilitate the creation of compliance policies, as well as the management of compliance users and agents to automate compliance checks effectively.

## Retrieves configuration steps and provider connection status for the give domain

 - [GET /v1/domains/{domainId}/compliance/providers](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/getallprovidersfordomain.md)

## Connects different external providers with Custody

 - [POST /v1/domains/{domainId}/compliance/providers](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/connectprovider.md)

## Retrieves screening rules for connected provider of the given domain

 - [GET /v1/domains/{domainId}/compliance/providers/{provider}/screening-rules](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/getscreeningrulesfordomainandprovider.md)

## Creates screening rules for connected provider of the given domain

 - [POST /v1/domains/{domainId}/compliance/providers/{provider}/screening-rules](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/configurescreeningrulesfordomainandprovider.md)

## Enables or disables the preview screening for an existing provider connection

 - [PUT /v1/domains/{domainId}/compliance/providers/{provider}/toggle-preview-screening](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/togglepreviewscreening.md)

## Pause/unpause an existing external provider connection

 - [PUT /v1/domains/{domainId}/compliance/providers/{provider}/pause-connection](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/pauseproviderconnection.md)

## Create Compliance Policy Payload

 - [POST /v1/domains/{domainId}/compliance/policy](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/createpolicypayload.md)

## Creates Domain payload

 - [POST /v1/domains/{domainId}/compliance/domain](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/createdomainpayload.md)

## Delete compliance domain

 - [DELETE /v1/domains/{domainId}/compliance/domain](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/deletecompliancedomain.md)

## Check if compliance domain creation/injection is allowed

 - [POST /v1/domains/{domainId}/compliance/domain/validation](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/validatecompliancedomaincreation.md)

## Retrieves compliance analysis against all established external providers.

 - [POST /v1/domains/{domainId}/compliance/analysis](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/analysis.md)

## Performs a preview analysis of the wallet

 - [POST /v1/domains/{domainId}/compliance/analysis/preview](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/previewanalysis.md)

## Gets Exception role for the domain

 - [GET /v1/domains/{domainId}/compliance/transactionType/{transactionType}/exception-role](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/getexceptionrole.md)

## Retrieves connected provider connection details for the given domain

 - [GET /v1/domains/{domainId}/compliance/provider-connection](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/getallproviderconnectionfordomain.md)

## Gets Compliance policy for the domain

 - [GET /v1/domains/{domainId}/compliance/policy/{policyType}/transaction/{transactionType}](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/getpolicy.md)

## Deletes provider connection and screening rules for the given domain & provider

 - [DELETE /v1/domains/{domainId}/compliance/providers/{provider}](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/deleteproviderconnectionandscreeningrules.md)

## Creates a TravelRule message for a transfer

 - [POST /v1/domains/{domainId}/compliance/travel-rule/providers/{provider}/messages](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/createtravelruletransfer.md)

## Get a travel rule transfer by ID

 - [GET /v1/domains/{domainId}/compliance/travel-rule/providers/{provider}/messages/{travelRuleId}](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/gettravelruletransfer.md)

## Append PII to a travel rule message

 - [POST /v1/domains/{domainId}/compliance/travel-rule/providers/{provider}/messages/{travelRuleId}/pii](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/appendpiitotransfer.md)

## Present end-to-end encrypted PII to a travel rule message without policy

 - [POST /v1/domains/{domainId}/compliance/travel-rule/providers/{provider}/messages/{travelRuleId}/encrypted-pii](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/presentencryptedpiitotransferwithoutpolicy.md)

## Append end-to-end encrypted PII to a travel rule message

 - [POST /v1/domains/{domainId}/compliance/travel-rule/providers/{provider}/messages/{travelRuleId}/policies/{travelRulePolicyId}/encrypted-pii](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/presentencryptedpiitotransfer.md)

## Get travel rule details for a batch of requests

 - [POST /v1/domains/{domainId}/compliance/travel-rule/details](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/gettravelruledetails.md): Retrieves travel rule message details for a batch of domain and ID pairs

## Create a relationship with the travel rule provider

 - [POST /v1/domains/{domainId}/compliance/travel-rule/providers/{provider}/relationships](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/createrelationship.md): Pass-through proxy API to create a relationship with the travel rule provider (e.g., Notabene)

## List all relationships registered with the travel rule provider

 - [GET /v1/domains/{domainId}/compliance/travel-rule/providers/{provider}/relationships](https://docs.ripple.com/products/custody/v1.36/reference/api/openapi/compliance/listrelationships.md): Pass-through proxy API to list all relationships from the travel rule provider (e.g., Notabene)