Skip to content

Connects different external providers with Custody

Request

Security
httpAuth
Path
domainIdstring, (uuid)required
Bodyapplication/jsonrequired
providerstringrequired
Enum:"ELLIPTIC""CHAINALYSIS"
credentialobject
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/custody/devbox/v1/domains/{domainId}/compliance/providers' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "provider": "ELLIPTIC",
    "credential": {
      "apiKey": "string",
      "apiSecret": "string"
    }
  }'

Responses

Successful response

Bodyapplication/json
connectionIdstring, (uuid)
providerstring
Enum:"ELLIPTIC""CHAINALYSIS"
statusstring
Enum:"CONNECTED""PAUSED"
readyForScreeningboolean
previewScreeningEnabledboolean
Response
{
  "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
  "provider": "ELLIPTIC",
  "status": "CONNECTED",
  "readyForScreening": true,
  "previewScreeningEnabled": true
}