### GET /api/network/v1/enterprises/{enterpriseId}/clients/connections/signing

Source: https://assets.bitgo.com/api/openapi

This API call allows clients to get the client connections payload for signing.
If your HTTP client doesn't support sending a request body on a get request, use the V1ClientConnectionsSigningPostRoute

Error scenarios:
- 400: Invalid Request Error
- Occurs when the request parameters are invalid or malformed
- Examples: Empty string provided for entepriseId, missing required fields in request body.

- 401: Authentication Error
- Occurs when the request is not authorized
- Examples: Caller is not a member of the enterprise.

- 403: Permission Denied Error
- Occurs when the authenticated client doesn't have necessary permissions.
- Examples: Enterprise does not have OES license.

- 404: Not Found Error
- Occurs when the specified resources cannot be found.
- Examples: Enterprise ID doesn't exist, specified partner ID doesn't exist.

- 500: Internal Server Error
- Occurs when there's an unexpected server error processing the request.
- Examples: Database connection issues. Transient network errors.

**Requires access token scope:** `settlement_network_read`

```markdown
### Parameters

- **enterpriseId** (string, path, required)

### Request Body

**Content-Type:** application/json

- **partnerId** (string) (required)
- **name** (string) (required)
- **connectionKey** (object) (required)
  - **schema** (string (token)) (required) ("token")
  - **connectionToken** (string) (required)
- **nonce** (string) (required)

### Responses

#### 200 - OK

**V1ClientConnectionsSigningGetPayload**
- **payload** (string) (required)

#### 400 - Bad Request


#### 401 - Unauthorized

**V1ErrorPayload**
- **error** (string) (required)

#### 403 - Forbidden

**V1ErrorPayload**
- **error** (string) (required)

#### 404 - Not Found

**V1ErrorPayload**
- **error** (string) (required)

#### 422 - Unprocessable Entity

**V1ErrorPayload**
- **error** (string) (required)

#### 500 - Internal Server Error

**V1ErrorPayload**
- **error** (string) (required)

### Example Usage

```bash
curl -X GET "//api/network/v1/enterprises/{enterpriseId}/clients/connections/signing" \
  -H "Content-Type: application/json" \
  -d '{
  "partnerId": "string",
  "name": "string",
  "connectionKey": "value",
  "nonce": "string"
}'
```

```

--------------------------------

### POST /api/address-book/v1/listing/global

Source: https://assets.bitgo.com/api/openapi

Create a listing for your enterprise in the Go network.
Once you create a listing for your enterprise, you can list your Go Account in the public directory.

**Requires access token scope:** `wallet_spend_all`

```markdown
### Parameters

- **enterprise-id** (string, header, required)
- **user-id** (string, header, required)

### Request Body

**Content-Type:** application/json

- **description** (string)

### Responses

#### 200 - OK

**V1GlobalListingResponse**
- **id** (string) (required)
- **enterpriseId** (string) (required)
- **description** (string)
- **name** (string) (required)
- **owner** (string) (required)
- **createdAt** (string (date-time)) (required)
- **updatedAt** (string (date-time)) (required)

#### 400 - Bad Request


#### 401 - Unauthorized

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

#### 403 - Forbidden

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

#### 409 - Conflict

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

#### 422 - Unprocessable Entity

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

#### 500 - Internal Server Error

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

### Example Usage

```bash
curl -X POST "//api/address-book/v1/listing/global" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string"
}'
```

```

--------------------------------

### POST /api/network/v1/enterprises/{enterpriseId}/clients/connections/signing

Source: https://assets.bitgo.com/api/openapi

This API call allows clients to get the client connections payload for signing.
This endpoint is effectively the same as the GET endpoint, but is helpful if your HTTP client doesn't support sending a request body on a get request.

Error scenarios:
- 400: Invalid Request Error
- Occurs when the request parameters are invalid or malformed
- Examples: Empty string provided for entepriseId, missing required fields in request body.

- 401: Authentication Error
- Occurs when the request is not authorized
- Examples: Caller is not a member of the enterprise.

- 403: Permission Denied Error
- Occurs when the authenticated client doesn't have necessary permissions.
- Examples: Enterprise does not have OES license.

- 404: Not Found Error
- Occurs when the specified resources cannot be found.
- Examples: Enterprise ID doesn't exist, specified partner ID doesn't exist.

- 500: Internal Server Error
- Occurs when there's an unexpected server error processing the request.
- Examples: Database connection issues. Transient network errors.

**Requires access token scopes:** `settlement_network_read`, `settlement_network_write`

```markdown
### Parameters

- **enterpriseId** (string, path, required)

### Request Body

**Content-Type:** application/json

- **partnerId** (string) (required)
- **name** (string) (required)
- **connectionKey** (object) (required)
  - **schema** (string (token)) (required) ("token")
  - **connectionToken** (string) (required)
- **nonce** (string) (required)

### Responses

#### 200 - OK

**V1ClientConnectionsSigningGetPayload**
- **payload** (string) (required)

#### 400 - Bad Request


#### 401 - Unauthorized

**V1ErrorPayload**
- **error** (string) (required)

#### 403 - Forbidden

**V1ErrorPayload**
- **error** (string) (required)

#### 404 - Not Found

**V1ErrorPayload**
- **error** (string) (required)

#### 422 - Unprocessable Entity

**V1ErrorPayload**
- **error** (string) (required)

#### 500 - Internal Server Error

**V1ErrorPayload**
- **error** (string) (required)

### Example Usage

```bash
curl -X POST "//api/network/v1/enterprises/{enterpriseId}/clients/connections/signing" \
  -H "Content-Type: application/json" \
  -d '{
  "partnerId": "string",
  "name": "string",
  "connectionKey": "value",
  "nonce": "string"
}'
```

```

--------------------------------

### POST /api/address-book/v1/listing/entry/global

Source: https://assets.bitgo.com/api/openapi

Create a listing entry for your enterprises Go Account.

**Requires access token scope:** `wallet_spend_all`

```markdown
### Parameters

- **enterprise-id** (string, header, required)
- **user-id** (string, header, required)

### Request Body

**Content-Type:** application/json

- **walletId** (string) (required)
- **description** (string)
- **public** (boolean) (required)

### Responses

#### 200 - OK

**V1ListingEntryResponse**
- **id** (string) (required)
- **walletId** (string) (required)
- **coin** (string) (required)
- **type** (string (GO_ACCOUNT)) (required): codec for entry type ("GO_ACCOUNT")
- **description** (string)
- **discoverable** (boolean) (required)
- **featured** (boolean) (required)
- **createdAt** (string (date-time)) (required)
- **updatedAt** (string (date-time)) (required)

#### 400 - Bad Request


#### 401 - Unauthorized

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

#### 409 - Conflict

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

#### 422 - Unprocessable Entity

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

#### 500 - Internal Server Error

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

### Example Usage

```bash
curl -X POST "//api/address-book/v1/listing/entry/global" \
  -H "Content-Type: application/json" \
  -d '{
  "walletId": "string",
  "description": "string",
  "public": "true"
}'
```

```

--------------------------------

### POST /api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}/deallocations/signing

Source: https://assets.bitgo.com/api/openapi

This API call allows clients to get the client deallocations payload for signing.
This endpoint is effectively the same as the GET endpoint, but is helpful if your HTTP client doesn't support sending a request body on a get request.

Error scenarios:
- 400: Invalid Request Error
- Occurs when the request parameters are invalid or malformed.
- Examples: Invalid UUID format for connectionId, malformed request body.

- 401: Authentication Error
- Occurs when the request is not authorized.
- Examples: Caller is not a member of the enterprise.

- 403: Permission Denied Error
- Occurs when the authenticated client doesn't have necessary permissions.
- Examples: Enterprise does not have OES license.

- 404: Not Found Error
- Occurs when the specified connection cannot be found.
- Examples: Connection ID doesn't exist, connection doesn't belong to this client.

- 422: Unprocessable Entity Error
- Occurs when the request is valid but cannot be processed due to business rules.
- Examples: Connection is inactive, requested currency not supported.

- 500: Internal Server Error
- Occurs when there's an unexpected server error processing the request.
- Examples: Database connection issues.

**Requires access token scopes:** `settlement_network_read`, `settlement_network_write`

```markdown
### Parameters

- **enterpriseId** (string, path, required): The enterprise identifier of the client.
This identifies the client enterprise that owns the connection.
- **connectionId** (string, path, required): The unique identifier of the connection to deallocate from.
This UUID uniquely identifies the connection between a client and a partner.

### Request Body

**Content-Type:** application/json

- **amount** (object) (required)
  - **currency** (string) (required)
  - **quantity** (string) (required)
- **clientExternalId** (string) (required): External identifier provided by the client.
Used for idempotence and correlation with client systems.
- **nonce** (string) (required): A unique nonce value used for cryptographic operations.
This provides additional security for deallocation operations.
- **notes** (string): Optional notes provided by the client when creating the deallocation.
Can contain additional context or information about the purpose of the deallocation.

### Responses

#### 200 - OK

**V1ClientDeallocationsSigningGetPayload**
- **payload** (string) (required): The payload string that should be signed.
This string should be cryptographically signed by the client and included
in the subsequent deallocation request along with the signature.

#### 400 - Bad Request


#### 401 - Unauthorized

**V1ErrorPayload**
- **error** (string) (required)

#### 403 - Forbidden

**V1ErrorPayload**
- **error** (string) (required)

#### 404 - Not Found

**V1ErrorPayload**
- **error** (string) (required)

#### 422 - Unprocessable Entity

**V1ErrorPayload**
- **error** (string) (required)

#### 500 - Internal Server Error

**V1ErrorPayload**
- **error** (string) (required)

### Example Usage

```bash
curl -X POST "//api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}/deallocations/signing" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": "value",
  "clientExternalId": "string",
  "nonce": "string",
  "notes": "string"
}'
```

```

--------------------------------

### Schema: OnboardingAgreement

Source: https://assets.bitgo.com/api/openapi

For users doing self-service onboarding, they
just need to click a checkbox to agree to the terms.
we will track who & when that happened on a feature-by-feature basis.

```markdown
## Schema: OnboardingAgreement

For users doing self-service onboarding, they
just need to click a checkbox to agree to the terms.
we will track who & when that happened on a feature-by-feature basis.

**Type:** object

- **user** (string) (required)
- **date** (string) (required)
- **ip** (string)

```

--------------------------------

### GET /api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}/deallocations/signing

Source: https://assets.bitgo.com/api/openapi

This API call allows clients to get the client deallocations payload for signing.
The returned payload should be cryptographically signed by the client and included
in the subsequent deallocation request.

If your HTTP client doesn't support sending a request body on a get request, use the V1ClientDeallocationsSigningPostRoute

Error scenarios:
- 400: Invalid Request Error
- Occurs when the request parameters are invalid or malformed.
- Examples: Invalid UUID format for connectionId, malformed request body.

- 401: Authentication Error
- Occurs when the request is not authorized.
- Examples: Caller is not a member of the enterprise.

- 403: Permission Denied Error
- Occurs when the authenticated client doesn't have necessary permissions.
- Examples: Enterprise does not have OES license.

- 404: Not Found Error
- Occurs when the specified connection cannot be found.
- Examples: Connection ID doesn't exist, connection doesn't belong to this client.

- 422: Unprocessable Entity Error
- Occurs when the request is valid but cannot be processed due to business rules.
- Examples: Connection is inactive, requested currency not supported.

- 500: Internal Server Error
- Occurs when there's an unexpected server error processing the request.
- Examples: Database connection issues.

**Requires access token scope:** `settlement_network_read`

```markdown
### Parameters

- **enterpriseId** (string, path, required): The enterprise identifier of the client.
This identifies the client enterprise that owns the connection.
- **connectionId** (string, path, required): The unique identifier of the connection to deallocate from.
This UUID uniquely identifies the connection between a client and a partner.

### Request Body

**Content-Type:** application/json

- **amount** (object) (required)
  - **currency** (string) (required)
  - **quantity** (string) (required)
- **clientExternalId** (string) (required): External identifier provided by the client.
Used for idempotence and correlation with client systems.
- **nonce** (string) (required): A unique nonce value used for cryptographic operations.
This provides additional security for deallocation operations.
- **notes** (string): Optional notes provided by the client when creating the deallocation.
Can contain additional context or information about the purpose of the deallocation.

### Responses

#### 200 - OK

**V1ClientDeallocationsSigningGetPayload**
- **payload** (string) (required): The payload string that should be signed.
This string should be cryptographically signed by the client and included
in the subsequent deallocation request along with the signature.

#### 400 - Bad Request


#### 401 - Unauthorized

**V1ErrorPayload**
- **error** (string) (required)

#### 403 - Forbidden

**V1ErrorPayload**
- **error** (string) (required)

#### 404 - Not Found

**V1ErrorPayload**
- **error** (string) (required)

#### 422 - Unprocessable Entity

**V1ErrorPayload**
- **error** (string) (required)

#### 500 - Internal Server Error

**V1ErrorPayload**
- **error** (string) (required)

### Example Usage

```bash
curl -X GET "//api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}/deallocations/signing" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": "value",
  "clientExternalId": "string",
  "nonce": "string",
  "notes": "string"
}'
```

```

--------------------------------

### Schema: Canton End Investor Onboarding Accept Intent

Source: https://assets.bitgo.com/api/openapi

Schema definition for CantonEndInvestorOnboardingAcceptIntent

```markdown
## Schema: Canton End Investor Onboarding Accept Intent

Schema definition for CantonEndInvestorOnboardingAcceptIntent

**Type:** object

- **intentType** (string (payment|transferToken|consolidate|consolidateToken|fanout|stake|unstake|delegate|undelegate|switchValidator|claim|stakeClaimRewards|pledge|voteDelegation|vote|createAccount|updateAccount|addTrustLine|removeTrustLine|signMessage|signTypedStructuredData|enableToken|authorize|acceleration|fillNonce|walletRecovery|contractCall|deactivate|customTx|closeAssociatedTokenAccount|stakeWithCallData|unstakeWithCallData|switchValidatorWithCallData|feeAddressTransfer|tokenApproval|transferStake|validatorRegistration|increaseStake|decreaseStake|signalExit|withdrawStake|spotTransfer|bridgeFunds|enableBridging|goUnstake|createBtcDelegation|transferAccept|transferReject|transferAcknowledge|transferOfferWithdrawn|cosignDelegationProposal|cosignDelegationAccept|allocationRequest|cantonCommand|allocationAllocate|allocationOfferWithdrawn|allocationReject|cantonEndInvestorOnboardingOffer|cantonEndInvestorOnboardingAccept|cantonEndInvestorOnboardingReject|cantonParticipantOnboardingRequest|defi-deposit|defi-redeem|defi-approve|delegateResource|undelegateResource|export|import|importtoc)) (required) ("payment"|"transferToken"|"consolidate"|"consolidateToken"|"fanout"|"stake"|"unstake"|"delegate"|"undelegate"|"switchValidator"|"claim"|"stakeClaimRewards"|"pledge"|"voteDelegation"|"vote"|"createAccount"|"updateAccount"|"addTrustLine"|"removeTrustLine"|"signMessage"|"signTypedStructuredData"|"enableToken"|"authorize"|"acceleration"|"fillNonce"|"walletRecovery"|"contractCall"|"deactivate"|"customTx"|"closeAssociatedTokenAccount"|"stakeWithCallData"|"unstakeWithCallData"|"switchValidatorWithCallData"|"feeAddressTransfer"|"tokenApproval"|"transferStake"|"validatorRegistration"|"increaseStake"|"decreaseStake"|"signalExit"|"withdrawStake"|"spotTransfer"|"bridgeFunds"|"enableBridging"|"goUnstake"|"createBtcDelegation"|"transferAccept"|"transferReject"|"transferAcknowledge"|"transferOfferWithdrawn"|"cosignDelegationProposal"|"cosignDelegationAccept"|"allocationRequest"|"cantonCommand"|"allocationAllocate"|"allocationOfferWithdrawn"|"allocationReject"|"cantonEndInvestorOnboardingOffer"|"cantonEndInvestorOnboardingAccept"|"cantonEndInvestorOnboardingReject"|"cantonParticipantOnboardingRequest"|"defi-deposit"|"defi-redeem"|"defi-approve"|"delegateResource"|"undelegateResource"|"export"|"import"|"importtoc")
- **txRequestId** (string) (required)
- **sequenceId** (string)
- **comment** (string)
- **nonce** (string)

```

--------------------------------

### GET /api/stablecoin/v1/assets

Source: https://assets.bitgo.com/api/openapi

Returns a list of assets.

```markdown
### Parameters

- **ids** (string (uuid), query, optional): Unique identifier for the asset. (example: "d1c27189-764c-4197-af06-e2623658f410")
- **token** (string, query, optional): Token symbol or identifier for the stablecoin. (example: "eth:usd1")
- **chain** (string, query, optional): Blockchain network or chain name where the asset exists. (example: "eth")
- **baseAsset** (string, query, optional): Base asset type to filter by. (example: "usd1")
- **isIssuedByBitgo** (boolean, query, optional): Flag to filter assets based on whether they were issued by BitGo.
- **isEnabledGlobally** (boolean, query, optional): Filter assets by global enabled status for mint/burn operations.

### Responses

#### 200 - OK

**AssetsResponse**
- Array of object
  - **id** (string (uuid)) (required): Unique identifier for the asset. (example: "d1c27189-764c-4197-af06-e2623658f410")
  - **token** (string) (required): Token symbol (example: "eth:usd1")
  - **name** (string) (required): Human-readable name of the token (example: "USD1")
  - **decimals** (number) (required): Number of decimal places for token precision (example: 18)
  - **isIssuedByBitgo** (boolean) (required): Flag indicating if BitGo issued this token (example: false)
  - **baseAsset** (string (gousd|usd1|sofid|cusd|fyusd|qxmp|scaasacme|usd)) (required): Base asset for the token (example: "usd1") ("gousd"|"usd1"|"sofid"|"cusd"|"fyusd"|"qxmp"|"scaasacme"|"usd")
  - **reserveManagementType** (string (bitgo_managed|issuer_managed|bitgo_and_issuer_managed)): How the reserve backing this stablecoin is managed. Absent for fiat USD
and other non-stablecoin assets that have no corresponding base_asset row. (example: "bitgo_managed") ("bitgo_managed"|"issuer_managed"|"bitgo_and_issuer_managed")
  - **chain** (string): Blockchain network identifier for the token (example: "eth")
  - **backingAsset** (string): Token that provides backing value (example: "fiatusd")
  - **treasuryAccountWalletId** (string (uuid)): Unique identifier for the treasury account (example: "37c60261db7cbfdfab26b9156eabcdef")
  - **minimumLimit** (number): Minimum order amount for mint and burn orders, in full units (deprecated, use minimumMintAmount and minimumBurnAmount) (example: 100)
  - **minimumMintAmount** (string): Minimum order amount for mint orders, in base units (example: "'10000'")
  - **minimumBurnAmount** (string): Minimum order amount for burn orders, in base units (example: "'10000'")
  - **burnFeeBps** (number): Resolved burn fee rate in basis points for this enterprise using the
enterprise → org → base_asset hierarchy. Defaults to 0 when no fee hierarchy
row exists in the DB for this base asset. (example: 25)
  - **mintFeeBps** (number): Resolved mint fee rate in basis points for this enterprise using the
enterprise → org → base_asset hierarchy. Defaults to 0 when no fee hierarchy
row exists in the DB for this base asset. (example: 0)
  - **smartContractMetadata** (object): Smart-contract metadata for an asset.

Flat shape: every field is optional. Which fields are populated depends on
the asset's contract type (TokenGovernor, UUPS Stablecoin, SPL Token, SPL
Token-2022, Aptos RegulatedToken, Tempo precompile). Consumers should treat
absent fields as "not applicable for this asset/chain".

See the contract-roles reference doc for the per-asset, per-chain mapping.
    - **contractAddress** (string): Primary contract address: governor / proxy / SPL mint / Aptos package.
    - **implementationAddress** (string): EIP-1967 implementation address (UUPS Stablecoin proxies only).
    - **governedTokenAddress** (string): Underlying token address governed by a TokenGovernor (EVM/Tron USD1 only).
    - **tokenProgramId** (string): Solana token program (Tokenkeg... or Token-2022).
    - **recoveryManagers** (array (string))
    - **minters** (array (string))
    - **burners** (array (string))
    - **bridgeMintersOrBurners** (array (string))
    - **freezers** (array (string))
    - **unfreezers** (array (string))
    - **pausers** (array (string))
    - **unpausers** (array (string))
    - **owner** (string)
    - **freezer** (string)
    - **blacklister** (string)
    - **rescuer** (string)
    - **upgrader** (string)
    - **mintAuthority** (string)
    - **freezeAuthority** (string)
    - **transferFeeConfigAuthority** (string)
    - **confidentialTransferAuthority** (string)
    - **transferHookAuthority** (string)
    - **scaledUiAmountAuthority** (string)
    - **metadataPointerAuthority** (string)
    - **pausableAuthority** (string)
    - **tokenMetadataUpdateAuthority** (string)
  - **publicDescription** (string): Public-facing description of the base asset (example: "\"A stablecoin backed by US dollar reserves\"")
  - **publicTagline** (string): Public-facing tagline of the base asset (example: "\"The stablecoin for global payments\"")
  - **publicMarketingUrl** (string): Public-facing URL of the base asset (example: "\"https://example.com/stablecoin\"")

#### 400 - Bad Request


#### 500 - Internal Server Error


### Example Usage

```bash
curl -X GET "//api/stablecoin/v1/assets?ids=d1c27189-764c-4197-af06-e2623658f410&token=eth:usd1&chain=eth&baseAsset=usd1&isIssuedByBitgo=true&isEnabledGlobally=true"
```

```

--------------------------------

### GET /api/network/v1/enterprises/{enterpriseId}/clients/settlements

Source: https://assets.bitgo.com/api/openapi

This API call allows clients to get a list of settlements that involve their accounts and their metadata.
Results can be filtered by various parameters and are paginated.

Error scenarios:
- 400: Invalid Request Error
- Occurs when the request parameters are invalid or malformed.
- Examples: Invalid UUID format, invalid pagination parameters.

- 401: Authentication Error
- Occurs when the request is not authorized.
- Examples: Caller is not a member of the enterprise.

- 403: Permission Denied Error
- Occurs when the authenticated client doesn't have necessary permissions.
- Examples: Enterprise does not have OES license.

- 404: Not Found Error
- Occurs when the specified enterprise cannot be found.
- Examples: Enterprise ID doesn't exist.

- 500: Internal Server Error
- Occurs when there's an unexpected server error processing the request.
- Examples: Database connection issues, query errors.

**Requires access token scope:** `settlement_network_read`

```markdown
### Parameters

- **pageNumber** (string (integer), query, optional): The page number (integer) you wish to fetch.
When provided, the API will skip pageSize * pageNumber records.
Page numbers are zero-based, so the first page is 0.
If not provided, defaults to 0.
- **pageSize** (string, query, optional): The page size (integer) you wish to fetch. 
When provided, the API will return at most pageSize records per page.
If not provided, a default page size defined by the server will be used.
- **settlementIds** (array (string), query, optional): Filter by specific settlement IDs.
When provided, only settlements matching these IDs will be returned.
- **onlyShowDisputed** (boolean, query, optional): Filter to show only disputed settlements.
When set to true, only settlements that have disputes will be returned.
Setting to false will have no effect.
- **partnerIds** (array (string), query, optional): Filter by specific partner IDs.
When provided, only settlements involving these partners will be returned.
- **partyConnectionIds** (array (string), query, optional): Filter by specific party connection IDs.
When provided, only settlements involving these connections as parties will be returned.
- **counterpartyConnectionIds** (array (string), query, optional): Filter by specific counterparty connection IDs.
When provided, only settlements involving these connections as counterparties will be returned.
- **statuses** (array (string (failed|completed|pending|rejected)), query, optional): Filter by settlement statuses.
When provided, only settlements with these statuses will be returned.
- **enterpriseId** (string, path, required): The enterprise identifier of the client.
This identifies the client enterprise making the API request.

### Responses

#### 200 - OK

**V1ClientListSettlementsOkPayload**
- **settlements** (array (union)) (required)
  Array items:
    - **transferDirection** (string (send|receive|send-and-receive)) (required) ("send"|"receive"|"send-and-receive")
    - **id** (string) (required): The unique identifier of the settlement.
This is a UUID that uniquely identifies the settlement record.
    - **partnerId** (string) (required): The unique identifier of the partner the settlement is associated with.
This is a UUID that uniquely identifies the partner.
    - **externalId** (string) (required): External identifier provided by the partner when creating the settlement.
    - **status** (string (pending)) (required) ("pending")
    - **settlementType** (string (onchain|offchain)) (required) ("onchain"|"offchain")
    - **reconciled** (boolean) (required): Whether or not the settlement is reconciled against trade data.
Currently there are no reconciled settlements.
This field is always false.
    - **initiatedBy** (string) (required): Id of the user which initiated the settlement.
    - **notes** (string): The notes associated with the settlement.
This is a free-form text field that can contain any additional information about the settlement.
    - **createdAt** (string (date-time)) (required): The date and time when the settlement was created.
This is a timestamp in ISO 8601 format.
    - **updatedAt** (string (date-time)) (required): The date and time when the settlement was last updated.
This is a timestamp in ISO 8601 format.
    - **rtId** (string): Routed transaction id associated with the settlement.
This is a UUID that uniquely identifies the routed transaction.
This field is only populated for on-chain settlements for partners with automation enabled.
    - **lossSLAAlertSent** (boolean) (required): Whether or not an alert has been sent if loss settlement SLA is close to being breached.
Only relevant for on-chain settlements.
    - **gainSLAAlertSent** (boolean) (required): Whether or not an alert has been sent if gain settlement SLA is close to being breached.
Only relevant for on-chain settlements.
    - **cutoffAt** (string (date-time)): The date and time of the newest trade being settled in the partner system.
This is a timestamp in ISO 8601 format.
This field is only populated for dispute enabled partners.
    - **disputed** (boolean): Whether or not a dispute was raised on this settlement.

#### 400 - Bad Request


#### 401 - Unauthorized

**V1ErrorPayload**
- **error** (string) (required)

#### 403 - Forbidden

**V1ErrorPayload**
- **error** (string) (required)

#### 404 - Not Found

**V1ErrorPayload**
- **error** (string) (required)

#### 500 - Internal Server Error

**V1ErrorPayload**
- **error** (string) (required)

### Example Usage

```bash
curl -X GET "//api/network/v1/enterprises/{enterpriseId}/clients/settlements?pageNumber=string&pageSize=string&settlementIds=item1,item2&onlyShowDisputed=true&partnerIds=item1,item2&partyConnectionIds=item1,item2&counterpartyConnectionIds=item1,item2&statuses=item1,item2"
```

```

--------------------------------

### GET /api/v2/wallets/count

Source: https://assets.bitgo.com/api/openapi

Get a count of all wallets you can access, including:
- Wallets you have a role on (admin, spender, or viewer).
- Wallets in enterprises you belong to that have the `View All Wallets` option
enabled from the enterprise settings.

You can use this endpoint in conjunction with the <b>List wallets</b> endpoint to
enable paginating a list of wallets. For example, once you get the wallets count,
you can use the total count to calculate the number of pages you need in order to
display all the wallets.

```markdown
### Parameters

- **id** (array (string), query, optional): Filter by ID.
- **coin** (array (string), query, optional): Filter by coin
- **enterprise** (array (string), query, optional): Filter by enterprise
- **type** (array (string (backing|cold|custodial|custodialPaired|hot|advanced|trading)), query, optional): Filter by wallet type.
- **deleted** (boolean, query, optional): Filter by deleted state.
- **labelContains** (string, query, optional): Filter by label substring
- **bitgoOrg** (string (BitGo Trust|BitGo New York|BitGo Germany|BitGo Switzerland|BitGo Europe ApS|Frankfurt DE Trust|BitGo Singapore|BitGo Korea|BitGo Custody MENA FZE|BitGo India|BitGo Sister Trust 1), query, optional): Return only wallets belong to the BitGo trust org

### Responses

#### 200 - OK

**WalletCountResponse**
- **count** (number) (required): The number of wallets that match the query.

#### 400 - Bad Request

**PlatformError**
- **name** (string): Error code
- **context** (object) (required): Properties that apply to a specific error name
- **error** (string) (required): Human-readable error message
- **requestId** (string) (required): Client request id

### Example Usage

```bash
curl -X GET "//api/v2/wallets/count?id=item1,item2&coin=item1,item2&enterprise=item1,item2&type=item1,item2&deleted=true&labelContains=string&bitgoOrg=BitGo Trust"
```

```

--------------------------------

### Schema: Canton End Investor Onboarding Offer Intent

Source: https://assets.bitgo.com/api/openapi

Schema definition for CantonEndInvestorOnboardingOfferIntent

```markdown
## Schema: Canton End Investor Onboarding Offer Intent

Schema definition for CantonEndInvestorOnboardingOfferIntent

**Type:** object

- **intentType** (string (payment|transferToken|consolidate|consolidateToken|fanout|stake|unstake|delegate|undelegate|switchValidator|claim|stakeClaimRewards|pledge|voteDelegation|vote|createAccount|updateAccount|addTrustLine|removeTrustLine|signMessage|signTypedStructuredData|enableToken|authorize|acceleration|fillNonce|walletRecovery|contractCall|deactivate|customTx|closeAssociatedTokenAccount|stakeWithCallData|unstakeWithCallData|switchValidatorWithCallData|feeAddressTransfer|tokenApproval|transferStake|validatorRegistration|increaseStake|decreaseStake|signalExit|withdrawStake|spotTransfer|bridgeFunds|enableBridging|goUnstake|createBtcDelegation|transferAccept|transferReject|transferAcknowledge|transferOfferWithdrawn|cosignDelegationProposal|cosignDelegationAccept|allocationRequest|cantonCommand|allocationAllocate|allocationOfferWithdrawn|allocationReject|cantonEndInvestorOnboardingOffer|cantonEndInvestorOnboardingAccept|cantonEndInvestorOnboardingReject|cantonParticipantOnboardingRequest|defi-deposit|defi-redeem|defi-approve|delegateResource|undelegateResource|export|import|importtoc)) (required) ("payment"|"transferToken"|"consolidate"|"consolidateToken"|"fanout"|"stake"|"unstake"|"delegate"|"undelegate"|"switchValidator"|"claim"|"stakeClaimRewards"|"pledge"|"voteDelegation"|"vote"|"createAccount"|"updateAccount"|"addTrustLine"|"removeTrustLine"|"signMessage"|"signTypedStructuredData"|"enableToken"|"authorize"|"acceleration"|"fillNonce"|"walletRecovery"|"contractCall"|"deactivate"|"customTx"|"closeAssociatedTokenAccount"|"stakeWithCallData"|"unstakeWithCallData"|"switchValidatorWithCallData"|"feeAddressTransfer"|"tokenApproval"|"transferStake"|"validatorRegistration"|"increaseStake"|"decreaseStake"|"signalExit"|"withdrawStake"|"spotTransfer"|"bridgeFunds"|"enableBridging"|"goUnstake"|"createBtcDelegation"|"transferAccept"|"transferReject"|"transferAcknowledge"|"transferOfferWithdrawn"|"cosignDelegationProposal"|"cosignDelegationAccept"|"allocationRequest"|"cantonCommand"|"allocationAllocate"|"allocationOfferWithdrawn"|"allocationReject"|"cantonEndInvestorOnboardingOffer"|"cantonEndInvestorOnboardingAccept"|"cantonEndInvestorOnboardingReject"|"cantonParticipantOnboardingRequest"|"defi-deposit"|"defi-redeem"|"defi-approve"|"delegateResource"|"undelegateResource"|"export"|"import"|"importtoc")
- **endInvestorPartyId** (string) (required)
- **comment** (string)
- **sequenceId** (string)
- **nonce** (string)

```

--------------------------------

### PUT /api/address-book/v1/listing/{listingId}

Source: https://assets.bitgo.com/api/openapi

You can update the following:
* Description of your enterprise listing.
* Description of the target listing on connections you added from the directory.
* Description and or name of the target listing name from connections you directly added by wallet ID.

**Requires access token scope:** `wallet_spend_all`

```markdown
### Parameters

- **listingId** (string, path, required)
- **enterprise-id** (string, header, required)
- **user-id** (string, header, required)

### Request Body

**Content-Type:** application/json

- **description** (string): Description is always updatable
- **name** (string): The name of your listing that displays in the global directory. `editable` must be `true`

### Responses

#### 200 - OK

**V1ListingUpdateResponse**
- **id** (string) (required)
- **enterpriseId** (string)
- **description** (string)
- **name** (string) (required)
- **owner** (string) (required)
- **createdAt** (string (date-time)) (required)
- **updatedAt** (string (date-time)) (required)
- **globalListing** (object): codec for global listing http response
  - **createdAt** (string (date-time)) (required)
  - **description** (string)
  - **enterpriseId** (string) (required)
  - **id** (string) (required)
  - **name** (string) (required)
  - **owner** (string) (required)
  - **updatedAt** (string (date-time)) (required)

#### 400 - Bad Request


#### 401 - Unauthorized

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

#### 404 - Not Found

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

#### 422 - Unprocessable Entity

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

#### 500 - Internal Server Error

**V1ErrorResponse**
- **errorName** (string) (required)
- **error** (string) (required)

### Example Usage

```bash
curl -X PUT "//api/address-book/v1/listing/{listingId}" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "name": "string"
}'
```

```