Skip to main content
POST
/
v1
/
settlements
/
{settlement_id}
/
compliance-decision
Submit compliance decision
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({decision: 'approve'})
};

fetch('https://api.keystoneos.xyz/v1/settlements/{settlement_id}/compliance-decision', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "idempotency_key": "<string>",
  "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_version": 123,
  "external_reference": "<string>",
  "settlement_type": "<string>",
  "parties": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "role": "<string>",
      "platform_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_reference": "<string>",
      "name": "<string>",
      "wallet_address": "<string>",
      "chain_id": 123,
      "status": "<string>",
      "confirmed_at": "2023-11-07T05:31:56Z",
      "wallet_address_hint": "<string>",
      "counterparty_reference": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "legs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "settlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "leg_type": "<string>",
      "instrument_id": "<string>",
      "chain_id": 123,
      "token_standard": "<string>",
      "quantity": "<string>",
      "direction": "<string>",
      "party_role": "<string>",
      "status": "<string>",
      "external_reference": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deposit_secret": "<string>",
      "deposit_key": "<string>"
    }
  ],
  "state": "<string>",
  "timeout_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "parent_settlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "settlement_category": "<string>",
  "maturity_at": "2023-11-07T05:31:56Z",
  "repo_metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.keystoneos.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Path Parameters

​
settlement_id
string<uuid>
required

Body

application/json
​
decision
enum<string>
required
Available options:
approve,
reject

Response

Successful Response

​
id
string<uuid>
required
​
idempotency_key
string
required
​
platform_id
string<uuid>
required
​
environment_id
string<uuid>
required
​
template_id
string<uuid>
required
​
template_version
integer
required
​
external_reference
string | null
required
​
settlement_type
string
required
​
parties
SettlementPartyRead · object[]
required
​
legs
SettlementLegRead · object[]
required
​
state
string
required
​
timeout_at
string<date-time>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
parent_settlement_id
string<uuid> | null
​
settlement_category
string | null
​
maturity_at
string<date-time> | null
​
repo_metadata
Repo Metadata · object