Skip to content

Gets Compliance policy for the domain

Request

Security
httpAuth
Path
domainIdstring, (uuid)required
policyTypestringrequired
Enum:"AUTOMATIC""EXCEPTION"
transactionTypestringrequired
Enum:"INCOMING""OUTGOING"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/v1.34/devbox/v1/domains/{domainId}/compliance/policy/{policyType}/transaction/{transactionType}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful response

Bodyapplication/json
policyNamestringrequired
policyTypestringrequired
Enum:"AUTOMATIC""EXCEPTION"
transactionTypestringrequired
Enum:"INCOMING""OUTGOING"
approvalWorkflowobject
exceptionRolestring
rankinteger, (int32)
errorstring
lockStatusstringrequired
Enum:"Locked""Unlocked""Archived"
policyIdstring, (uuid)
Response
{
  "policyName": "string",
  "policyType": "AUTOMATIC",
  "transactionType": "INCOMING",
  "approvalWorkflow": {
    "property1": {},
    "property2": {}
  },
  "exceptionRole": "string",
  "rank": 0,
  "error": "string",
  "lockStatus": "Locked",
  "policyId": "2f5573e6-5ba4-48f2-a75d-df99c936463b"
}