getList conversions

Required capabilityconversions.read

Authentication: Send Authorization: Bearer <access_token>.

Lists ledger-native conversion operation snapshots. Preview responses are informational only; operation execution may recompute fees and rate before ledger posting, so reads must not be treated as a bound preview replay.

Parameters

Name Location Type Required Description and constraints
account_ref query string No pattern: ^(master-accounts|client-accounts)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
page_size query integer No Cursor pagination page size. The canonical contract accepts integers from 1 to 500. minimum: 1; maximum: 500; default: 100
page_token query string No Opaque cursor returned by a previous page.

Request

Request URL

GET
GET /conversions

Responses

Response

application/json
{
  "items": [
    {
      "account_ref": "client-accounts/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "applied_rate": "0.00002",
      "approval_ref": null,
      "conversion_execution_id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "created_at": "2026-05-01T10:00:00Z",
      "failure_detail": null,
      "failure_reason": null,
      "family": "conversion",
      "fee_summary": {
        "components": [
          {
            "amount": {
              "currency": "USD",
              "value": "1.00"
            },
            "kind": "platform_fee"
          }
        ],
        "total": {
          "currency": "USD",
          "value": "1.00"
        }
      },
      "fee_transaction_ids": [
        "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
      ],
      "fill_rate": "0.00002",
      "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "ledger_posted_target_amount": {
        "currency": "BTC",
        "value": "0.00498000"
      },
      "leg_attempt_id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "posted_at": "2026-05-01T10:00:00Z",
      "principal_amount": {
        "currency": "USD",
        "value": "250.00"
      },
      "principal_transaction_id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "settled_at": "2026-05-01T10:00:00Z",
      "source_gross_amount": {
        "currency": "USD",
        "value": "250.00"
      },
      "source_principal_amount": {
        "currency": "USD",
        "value": "249.00"
      },
      "status": "settled",
      "subject_attribution": {
        "actor": null,
        "approved_by": null,
        "authenticated_principal": {
          "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
          "kind": "user",
          "tenant_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
        },
        "enterprise_binding": {
          "tenant_type": "enterprise",
          "topology_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
        },
        "federation": null,
        "identity_source": "platform-managed",
        "initiated_by": null,
        "subject": {
          "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
          "kind": "user",
          "tenant_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
        }
      },
      "target_amount": {
        "currency": "BTC",
        "value": "0.00498000"
      },
      "target_currency": "BTC",
      "updated_at": "2026-05-01T10:00:00Z"
    }
  ],
  "next_page_token": null
}

Operation succeeded.

Response 200 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
items object[] Yes
next_page_token string or null Yes

Additional fields are not accepted.

application/json body.items

Type: object[].

application/json body.items item
Field Type Required Description and constraints
account_ref string Yes pattern: ^(master-accounts|client-accounts)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
applied_rate string or null Yes
approval_ref object or null Yes
compliance_assessment_ref string or null No
conversion_execution_id string or null Yes
created_at string or string Yes
failure_detail object or null Yes
failure_reason string or null Yes
family "conversion" Yes
fee_summary object or null Yes
fee_transaction_ids string[] or null Yes
fill_rate string or null Yes
id string Yes format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
ledger_posted_target_amount object or null Yes
leg_attempt_id string or null Yes
posted_at string or string or null Yes
principal_amount object Yes No additional fields
principal_transaction_id string or null Yes
settled_at string or string or null Yes
source_gross_amount object or null Yes
source_principal_amount object or null Yes
status "requested" / "admissible" / "executing" / "pending_approval" / "pending_admission" / "pending_compliance" / "executed" / "settled" / "ledger_visible" / "failed" / "cancelled" / "partially_settled" Yes
subject_attribution object Yes No additional fields
target_amount object or null Yes
target_currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
updated_at string or string Yes

Additional fields are not accepted.

application/json body.items item.applied_rate

At least one alternative must match.

application/json body.items item.applied_rate: alternative 1

DecimalString

Type: string. pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

application/json body.items item.applied_rate: alternative 2

Type: null.

application/json body.items item.approval_ref

At least one alternative must match.

application/json body.items item.approval_ref: alternative 1
Field Type Required Description and constraints
approval_id string Yes format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
expires_at string or string Yes
reason_code string or null Yes

Additional fields are not accepted.

application/json body.items item.approval_ref: alternative 1.expires_at

At least one alternative must match.

application/json body.items item.approval_ref: alternative 1.expires_at: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.items item.approval_ref: alternative 1.expires_at: alternative 2

Type: string. format: date-time

application/json body.items item.approval_ref: alternative 1.reason_code

At least one alternative must match.

application/json body.items item.approval_ref: alternative 1.reason_code: alternative 1

Type: string.

application/json body.items item.approval_ref: alternative 1.reason_code: alternative 2

Type: null.

application/json body.items item.approval_ref: alternative 2

Type: null.

application/json body.items item.compliance_assessment_ref

At least one alternative must match.

application/json body.items item.compliance_assessment_ref: alternative 1

Type: string. pattern: ^(compliance-assessments)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

application/json body.items item.compliance_assessment_ref: alternative 2

Type: null.

application/json body.items item.conversion_execution_id

At least one alternative must match.

application/json body.items item.conversion_execution_id: alternative 1

Type: string. format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

application/json body.items item.conversion_execution_id: alternative 2

Type: null.

application/json body.items item.created_at

At least one alternative must match.

application/json body.items item.created_at: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.items item.created_at: alternative 2

Type: string. format: date-time

application/json body.items item.failure_detail

At least one alternative must match.

application/json body.items item.failure_detail: alternative 1
Field Type Required Description and constraints
failed_at string or string or null Yes
reason_code string Yes pattern: ^[a-z0-9_.:-]+$; minLength: 1; maxLength: 128
retryable boolean or null Yes
stage "pre_execution" / "execution" / "post_fill" / "ledger_posting" / "unknown" Yes

Additional fields are not accepted.

application/json body.items item.failure_detail: alternative 1.failed_at

At least one alternative must match.

application/json body.items item.failure_detail: alternative 1.failed_at: alternative 1

At least one alternative must match.

application/json body.items item.failure_detail: alternative 1.failed_at: alternative 1: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.items item.failure_detail: alternative 1.failed_at: alternative 1: alternative 2

Type: string. format: date-time

application/json body.items item.failure_detail: alternative 1.failed_at: alternative 2

Type: null.

application/json body.items item.failure_detail: alternative 1.retryable

At least one alternative must match.

application/json body.items item.failure_detail: alternative 1.retryable: alternative 1

Type: boolean.

application/json body.items item.failure_detail: alternative 1.retryable: alternative 2

Type: null.

application/json body.items item.failure_detail: alternative 2

Type: null.

application/json body.items item.failure_reason

At least one alternative must match.

application/json body.items item.failure_reason: alternative 1

Type: string. minLength: 1

application/json body.items item.failure_reason: alternative 2

Type: null.

application/json body.items item.fee_summary

At least one alternative must match.

application/json body.items item.fee_summary: alternative 1
Field Type Required Description and constraints
components object[] Yes
total object Yes No additional fields

Additional fields are not accepted.

application/json body.items item.fee_summary: alternative 1.components

Type: object[].

application/json body.items item.fee_summary: alternative 1.components item
Field Type Required Description and constraints
amount object Yes No additional fields
kind "platform_fee" / "enterprise_fee" / "network_fee" / "spread" Yes

Additional fields are not accepted.

application/json body.items item.fee_summary: alternative 1.components item.amount
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

application/json body.items item.fee_summary: alternative 1.total
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

application/json body.items item.fee_summary: alternative 2

Type: null.

application/json body.items item.fee_transaction_ids

At least one alternative must match.

application/json body.items item.fee_transaction_ids: alternative 1

Type: string[].

application/json body.items item.fee_transaction_ids: alternative 1 item

Type: string. format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

application/json body.items item.fee_transaction_ids: alternative 2

Type: null.

application/json body.items item.fill_rate

At least one alternative must match.

application/json body.items item.fill_rate: alternative 1

Type: string.

application/json body.items item.fill_rate: alternative 2

Type: null.

application/json body.items item.ledger_posted_target_amount

At least one alternative must match.

application/json body.items item.ledger_posted_target_amount: alternative 1
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

application/json body.items item.ledger_posted_target_amount: alternative 2

Type: null.

application/json body.items item.leg_attempt_id

At least one alternative must match.

application/json body.items item.leg_attempt_id: alternative 1

Type: string. format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

application/json body.items item.leg_attempt_id: alternative 2

Type: null.

application/json body.items item.posted_at

At least one alternative must match.

application/json body.items item.posted_at: alternative 1

At least one alternative must match.

application/json body.items item.posted_at: alternative 1: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.items item.posted_at: alternative 1: alternative 2

Type: string. format: date-time

application/json body.items item.posted_at: alternative 2

Type: null.

application/json body.items item.principal_amount
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

application/json body.items item.principal_transaction_id

At least one alternative must match.

application/json body.items item.principal_transaction_id: alternative 1

Type: string. format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

application/json body.items item.principal_transaction_id: alternative 2

Type: null.

application/json body.items item.settled_at

At least one alternative must match.

application/json body.items item.settled_at: alternative 1

At least one alternative must match.

application/json body.items item.settled_at: alternative 1: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.items item.settled_at: alternative 1: alternative 2

Type: string. format: date-time

application/json body.items item.settled_at: alternative 2

Type: null.

application/json body.items item.source_gross_amount

At least one alternative must match.

application/json body.items item.source_gross_amount: alternative 1
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

application/json body.items item.source_gross_amount: alternative 2

Type: null.

application/json body.items item.source_principal_amount

At least one alternative must match.

application/json body.items item.source_principal_amount: alternative 1
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

application/json body.items item.source_principal_amount: alternative 2

Type: null.

application/json body.items item.subject_attribution
Field Type Required Description and constraints
actor object or null Yes
approved_by object or null Yes
authenticated_principal object Yes No additional fields
enterprise_binding object Yes No additional fields
federation object or null Yes
identity_source "platform-managed" / "federated" / "system" Yes
initiated_by object or null Yes
subject object or null Yes

Additional fields are not accepted.

application/json body.items item.subject_attribution.actor

At least one alternative must match.

application/json body.items item.subject_attribution.actor: alternative 1
Field Type Required Description and constraints
id string Yes format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
kind "user" / "service" / "system" Yes
tenant_ref string or null No

Additional fields are not accepted.

application/json body.items item.subject_attribution.actor: alternative 1.tenant_ref

At least one alternative must match.

application/json body.items item.subject_attribution.actor: alternative 1.tenant_ref: alternative 1

Type: string. pattern: ^(enterprises|platform-operators|clients)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

application/json body.items item.subject_attribution.actor: alternative 1.tenant_ref: alternative 2

Type: null.

application/json body.items item.subject_attribution.actor: alternative 2

Type: null.

application/json body.items item.subject_attribution.approved_by

At least one alternative must match.

application/json body.items item.subject_attribution.approved_by: alternative 1
Field Type Required Description and constraints
id string Yes format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
kind "user" / "service" / "system" Yes
tenant_ref string or null No

Additional fields are not accepted.

application/json body.items item.subject_attribution.approved_by: alternative 1.tenant_ref

At least one alternative must match.

application/json body.items item.subject_attribution.approved_by: alternative 1.tenant_ref: alternative 1

Type: string. pattern: ^(enterprises|platform-operators|clients)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

application/json body.items item.subject_attribution.approved_by: alternative 1.tenant_ref: alternative 2

Type: null.

application/json body.items item.subject_attribution.approved_by: alternative 2

Type: null.

application/json body.items item.subject_attribution.authenticated_principal
Field Type Required Description and constraints
id string Yes format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
kind "user" / "service" / "system" Yes
tenant_ref string or null No

Additional fields are not accepted.

application/json body.items item.subject_attribution.authenticated_principal.tenant_ref

At least one alternative must match.

application/json body.items item.subject_attribution.authenticated_principal.tenant_ref: alternative 1

Type: string. pattern: ^(enterprises|platform-operators|clients)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

application/json body.items item.subject_attribution.authenticated_principal.tenant_ref: alternative 2

Type: null.

application/json body.items item.subject_attribution.enterprise_binding
Field Type Required Description and constraints
tenant_type "enterprise" / "platform_operator" Yes
topology_ref string or null Yes

Additional fields are not accepted.

application/json body.items item.subject_attribution.enterprise_binding.topology_ref

At least one alternative must match.

application/json body.items item.subject_attribution.enterprise_binding.topology_ref: alternative 1

Type: string. pattern: ^(enterprises|platform-operators|clients)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

application/json body.items item.subject_attribution.enterprise_binding.topology_ref: alternative 2

Type: null.

application/json body.items item.subject_attribution.federation

At least one alternative must match.

application/json body.items item.subject_attribution.federation: alternative 1
Field Type Required Description and constraints
external_subject string Yes minLength: 1
issuer string Yes minLength: 1

Additional fields are not accepted.

application/json body.items item.subject_attribution.federation: alternative 2

Type: null.

application/json body.items item.subject_attribution.initiated_by

At least one alternative must match.

application/json body.items item.subject_attribution.initiated_by: alternative 1
Field Type Required Description and constraints
id string Yes format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
kind "user" / "service" / "system" Yes
tenant_ref string or null No

Additional fields are not accepted.

application/json body.items item.subject_attribution.initiated_by: alternative 1.tenant_ref

At least one alternative must match.

application/json body.items item.subject_attribution.initiated_by: alternative 1.tenant_ref: alternative 1

Type: string. pattern: ^(enterprises|platform-operators|clients)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

application/json body.items item.subject_attribution.initiated_by: alternative 1.tenant_ref: alternative 2

Type: null.

application/json body.items item.subject_attribution.initiated_by: alternative 2

Type: null.

application/json body.items item.subject_attribution.subject

At least one alternative must match.

application/json body.items item.subject_attribution.subject: alternative 1
Field Type Required Description and constraints
id string Yes format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
kind "user" / "service" / "system" Yes
tenant_ref string or null No

Additional fields are not accepted.

application/json body.items item.subject_attribution.subject: alternative 1.tenant_ref

At least one alternative must match.

application/json body.items item.subject_attribution.subject: alternative 1.tenant_ref: alternative 1

Type: string. pattern: ^(enterprises|platform-operators|clients)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

application/json body.items item.subject_attribution.subject: alternative 1.tenant_ref: alternative 2

Type: null.

application/json body.items item.subject_attribution.subject: alternative 2

Type: null.

application/json body.items item.target_amount

At least one alternative must match.

application/json body.items item.target_amount: alternative 1
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

application/json body.items item.target_amount: alternative 2

Type: null.

application/json body.items item.updated_at

At least one alternative must match.

application/json body.items item.updated_at: alternative 1

Type: string. format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

application/json body.items item.updated_at: alternative 2

Type: string. format: date-time

application/json body.next_page_token

At least one alternative must match.

application/json body.next_page_token: alternative 1

Type: string.

application/json body.next_page_token: alternative 2

Type: null.

Response 400 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
code string Yes
data object No No additional fields
details object No Additional fields allowed
message string Yes

Additional fields are not accepted.

application/json body.data
Field Type Required Description and constraints
acr_values string No RFC 9470 step-up challenge (insufficient_user_authentication).
blockers object[] No For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.
code string No For legal refusals: the document code the refusal is about.
max_age string No RFC 9470 step-up challenge (insufficient_user_authentication).
max_source_amount object No For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum. No additional fields
min_source_amount object No For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included. No additional fields
published_version string No For document_version_superseded: the version currently published.
reason string No Typed refinement of code, from the failing service's contract.
resource string No Resource kind a resource_not_found refers to.
retry_after_ms integer No Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0
source string No For not_admissible: the gate that denied (verification, lifecycle, policy, compliance).

Additional fields are not accepted.

application/json body.data.blockers

For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.

Type: object[].

application/json body.data.blockers item
Field Type Required Description and constraints
description string Yes
type "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" Yes
assets object[] No minItems: 1
count integer No minimum: 0; maximum: 9007199254740991

Additional fields are not accepted.

application/json body.data.blockers item.assets

Type: object[]. minItems: 1

application/json body.data.blockers item.assets item
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
kind "balance" / "held" / "owed" / "unsettled" Yes

Additional fields are not accepted.

application/json body.data.max_source_amount

For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

application/json body.data.min_source_amount

For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

Response 401 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
code string Yes
data object No No additional fields
details object No Additional fields allowed
message string Yes

Additional fields are not accepted.

application/json body.data
Field Type Required Description and constraints
acr_values string No RFC 9470 step-up challenge (insufficient_user_authentication).
blockers object[] No For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.
code string No For legal refusals: the document code the refusal is about.
max_age string No RFC 9470 step-up challenge (insufficient_user_authentication).
max_source_amount object or null No For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum. No additional fields
min_source_amount object No For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included. No additional fields
published_version string No For document_version_superseded: the version currently published.
reason string No Typed refinement of code, from the failing service's contract.
resource string No Resource kind a resource_not_found refers to.
retry_after_ms integer or null No Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0
source string No For not_admissible: the gate that denied (verification, lifecycle, policy, compliance).

Additional fields are not accepted.

application/json body.data.blockers

For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.

Type: object[].

application/json body.data.blockers item
Field Type Required Description and constraints
description string Yes
type "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" Yes
assets object[] No minItems: 1
count integer No minimum: 0; maximum: 9007199254740991

Additional fields are not accepted.

application/json body.data.blockers item.assets

Type: object[]. minItems: 1

application/json body.data.blockers item.assets item
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
kind "balance" / "held" / "owed" / "unsettled" Yes

Additional fields are not accepted.

application/json body.data.max_source_amount

For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

application/json body.data.min_source_amount

For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

Response 403 schema

Content type: application/json.

See response 401 schema.

Response 404 schema

Content type: application/json.

See response 401 schema.

Response 500 schema

Content type: application/json.

See response 401 schema.

Response 502 schema

Content type: application/json.

See response 400 schema.

Response 503 schema

Content type: application/json.

See response 400 schema.