> ## Documentation Index > Fetch the complete documentation index at: https://docs.augustus.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Treat the published Augustus OpenAPI specification (https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers. > Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate, older surface covering two products — Open Banking (instant bank transfer) checkout and refunds, and Manual Bank Transfer (MBT); use it only when one of those products is specifically required. > Cite or link the relevant docs.augustus.com page when answering integration questions. > Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation. > Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key. > The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions. # Update counterparty > Updates the mutable details of a counterparty owned by the merchant. ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml post /v1/counterparties/{id} openapi: 3.1.0 info: title: Augustus Banking API description: Augustus Banking API version: 0.1.0 contact: name: Augustus url: https://docs.augustus.com email: developer@augustus.com servers: - url: https://api.augustus.com description: Production - url: https://api.sandbox.augustus.com description: Sandbox security: - BearerAuth: [] tags: [] paths: /v1/counterparties/{id}: post: tags: - Counterparties summary: Update counterparty description: Updates the mutable details of a counterparty owned by the merchant. operationId: CounterpartiesController_update parameters: - name: id required: true in: path description: Unique identifier of the counterparty. schema: type: string format: uuid - name: Idempotency-Key in: header description: >- Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409. required: true schema: type: string requestBody: required: true description: Counterparty fields to update content: application/json: schema: $ref: '#/components/schemas/UpdateCounterpartyBodyDto' responses: '200': description: The updated counterparty content: application/json: schema: $ref: '#/components/schemas/CounterpartyResourceDto' x-codeSamples: - lang: JavaScript source: >- import Augustus from '@augustusbank/typescript-sdk'; const client = new Augustus({ apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted }); const counterparty = await client.counterparties.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); console.log(counterparty.id); components: schemas: UpdateCounterpartyBodyDto: type: object properties: name: type: string description: New name, or null to clear the current name. nullable: true physical_address: type: object properties: line_1: description: Primary street address, or null if not recorded. type: string nullable: true line_2: type: string description: Secondary street address, or null if not recorded. nullable: true city: description: City or locality. type: string postal_code: description: Postal or ZIP code, or null if not recorded. type: string nullable: true state: type: string description: State, province, or region, or null if not recorded. nullable: true country_code: $ref: '#/components/schemas/Alpha2Code' example: DE description: ISO 3166-1 alpha-2 country code. required: - line_1 - line_2 - city - postal_code - state - country_code additionalProperties: false description: New physical address, or null to clear the current physical address. nullable: true date_of_birth: type: string format: date description: >- New date of birth in YYYY-MM-DD format, or null to clear the current date of birth. nullable: true is_self_owned: description: New ownership status. Omit to keep the current ownership status. type: boolean additionalProperties: false CounterpartyResourceDto: type: object properties: id: description: Unique identifier of the counterparty. type: string format: uuid type: description: Resource type discriminator. type: string enum: - counterparty name: type: string description: Name of the counterparty, or null if not recorded. nullable: true physical_address: type: object properties: line_1: description: Primary street address, or null if not recorded. type: string nullable: true line_2: type: string description: Secondary street address, or null if not recorded. nullable: true city: description: City or locality. type: string postal_code: description: Postal or ZIP code, or null if not recorded. type: string nullable: true state: type: string description: State, province, or region, or null if not recorded. nullable: true country_code: $ref: '#/components/schemas/Alpha2Code' example: DE description: ISO 3166-1 alpha-2 country code. required: - line_1 - line_2 - city - postal_code - state - country_code additionalProperties: false description: Physical address of the counterparty, or null if not recorded. nullable: true financial_address: description: Financial address of the counterparty. anyOf: - $ref: '#/components/schemas/IbanFinancialAddress' - $ref: '#/components/schemas/SortCodeFinancialAddress' - $ref: '#/components/schemas/AbaFinancialAddress' - $ref: '#/components/schemas/CryptoWalletFinancialAddress' date_of_birth: type: string format: date description: Date of birth in YYYY-MM-DD format, or null if not recorded. nullable: true is_self_owned: description: >- Whether the counterparty is self-owned. `false` if the counterparty is not owned by you, `true` if it is. type: boolean required: - id - type - name - physical_address - financial_address - date_of_birth - is_self_owned additionalProperties: false Alpha2Code: example: DE type: string enum: - AF - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IL - IT - JM - JP - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - MK - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - AX - BQ - CW - GG - IM - JE - ME - BL - MF - RS - SX - SS - XK IbanFinancialAddress: title: IBAN example: type: iban iban: DE89370400440532013000 account_holder_name: Acme Sandbox Ltd. bic: COBADEFFXXX type: object properties: type: description: Discriminator for IBAN financial address. type: string enum: - iban iban: description: International Bank Account Number. type: string account_holder_name: description: Name of the account holder. type: string bic: type: string description: Bank Identifier Code, or null if not provided. nullable: true required: - type - iban - account_holder_name - bic additionalProperties: false SortCodeFinancialAddress: title: UK Sort Code example: type: sort_code sort_code: '040075' account_number: '37778842' account_holder_name: Acme Sandbox Ltd. type: object properties: type: description: Discriminator for UK sort code financial address. type: string enum: - sort_code sort_code: description: UK sort code (6 digits). type: string account_number: description: UK account number (8 digits). type: string account_holder_name: description: Name of the account holder. type: string required: - type - sort_code - account_number - account_holder_name additionalProperties: false AbaFinancialAddress: title: ABA example: type: aba routing_number: '110000000' account_number: '000123456789' account_holder_name: Acme Sandbox Ltd. type: object properties: type: description: Discriminator for ABA wire financial address. type: string enum: - aba routing_number: description: ABA routing number (9 digits). type: string account_number: description: Bank account number. type: string account_holder_name: description: Name of the account holder. type: string required: - type - routing_number - account_number - account_holder_name additionalProperties: false CryptoWalletFinancialAddress: title: Wallet example: type: crypto_wallet address: '0x1111111111111111111111111111111111111111' blockchain: ethereum_sepolia type: object properties: type: description: Discriminator for crypto wallet financial address. type: string enum: - crypto_wallet address: description: Wallet address on the specified blockchain. type: string blockchain: description: Blockchain network for the crypto wallet. example: ethereum_sepolia type: string enum: - bitcoin - ethereum - solana - polygon - bitcoin_testnet4 - ethereum_sepolia - solana_devnet - polygon_amoy required: - type - address - blockchain additionalProperties: false securitySchemes: BearerAuth: scheme: bearer bearerFormat: JWT type: http description: Bearer token for authentication with Augustus Banking API ````