> ## 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://api.augustus.com/openapi/2026-05-01.json) 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 surface covering the Pay by Bank products — Instant Bank Transfer (Open Banking) checkout and refunds, and Manual Bank Transfer (MBT); use it when one of those products is 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. # Create a counterparty > Create a counterparty owned by the merchant. ## OpenAPI ````yaml https://api.augustus.com/openapi/2023-01-01.json post /api/service/counterparty/create openapi: 3.0.0 info: title: Ivy API description: Ivy API schema version: '1.0' contact: name: Ivy url: https://www.getivy.io email: help@getivy.io servers: - url: https://api.getivy.de description: Production - url: https://api.sand.getivy.de description: Sandbox security: [] tags: [] paths: /api/service/counterparty/create: post: tags: - Counterparty summary: Create a counterparty description: Create a counterparty owned by the merchant. operationId: CounterpartyController_create parameters: - 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: false schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCounterpartyDto' responses: '200': description: The created counterparty content: application/json: schema: $ref: '#/components/schemas/CreateCounterpartyResponseDto' security: - ApiKeyAuth: [] components: schemas: CreateCounterpartyDto: type: object properties: financialAddress: description: The counterparty financial address type: object properties: type: type: string enum: - iban - sort_code - bank_code - bban - wallet - aba - bic x-enumNames: - IBAN - SORT_CODE - BANK_CODE - BBAN - WALLET - ABA - BIC iban: type: object properties: accountHolderName: type: string minLength: 1 iban: type: string bic: type: string required: - accountHolderName - iban aba: type: object properties: accountHolderName: type: string minLength: 1 routingNumber: type: string pattern: ^[0-9]+$ accountNumber: type: string pattern: ^[0-9]+$ required: - accountHolderName - routingNumber - accountNumber bic: type: object properties: accountHolderName: type: string minLength: 1 accountNumber: type: string bic: type: string localBankCode: type: string required: - accountHolderName - accountNumber - bic sortCode: type: object properties: accountHolderName: type: string minLength: 1 sortCode: type: string pattern: ^[0-9]+$ accountNumber: type: string pattern: ^[0-9]+$ maxLength: 8 required: - accountHolderName - sortCode - accountNumber bankCode: type: object properties: accountHolderName: type: string minLength: 1 code: type: string accountNumber: type: string required: - accountHolderName - code - accountNumber bban: type: object properties: accountHolderName: type: string minLength: 1 bban: type: string bic: type: string required: - accountHolderName - bban wallet: type: object properties: address: description: The blockchain wallet address type: string blockchain: description: The blockchain network type: string enum: - BTC - BTC-TESTNET4 - ETH - ETH-SEPOLIA - SOL - SOL-DEVNET - MATIC - MATIC-AMOY required: - address - blockchain required: - type name: description: The counterparty name type: string entityType: description: Whether the counterparty is a business or an individual type: string enum: - business - individual x-enumNames: - BUSINESS - INDIVIDUAL isSelfOwned: description: Whether the counterparty is owned by the merchant type: boolean default: false physicalAddress: description: A structured physical postal address. type: object properties: line1: description: Primary street address line. type: string minLength: 1 line2: description: Secondary street address line. type: string minLength: 1 city: description: City or locality. type: string minLength: 1 postalCode: description: Postal or ZIP code. type: string minLength: 1 state: description: State, province, or region. type: string minLength: 1 countryCode: description: ISO 3166-1 alpha-2 country code. 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 required: - city - countryCode dateOfBirth: description: The counterparty date of birth as YYYY-MM-DD type: string pattern: ^\d{4}-\d{2}-\d{2}$ metadata: description: The counterparty metadata type: object additionalProperties: type: string required: - financialAddress CreateCounterpartyResponseDto: type: object properties: id: description: The counterparty id type: string name: description: The counterparty name type: string nullable: true entityType: description: Whether the counterparty is a business or an individual type: string enum: - business - individual x-enumNames: - BUSINESS - INDIVIDUAL isSelfOwned: description: Whether the counterparty is owned by the merchant type: boolean blocked: description: Whether payments to and from the counterparty are blocked type: boolean financialAddress: description: The counterparty financial address type: object properties: type: type: string enum: - iban - sort_code - bank_code - bban - wallet - aba - bic x-enumNames: - IBAN - SORT_CODE - BANK_CODE - BBAN - WALLET - ABA - BIC iban: type: object properties: accountHolderName: type: string minLength: 1 iban: type: string bic: type: string required: - accountHolderName - iban aba: type: object properties: accountHolderName: type: string minLength: 1 routingNumber: type: string pattern: ^[0-9]+$ accountNumber: type: string pattern: ^[0-9]+$ required: - accountHolderName - routingNumber - accountNumber bic: type: object properties: accountHolderName: type: string minLength: 1 accountNumber: type: string bic: type: string localBankCode: type: string required: - accountHolderName - accountNumber - bic sortCode: type: object properties: accountHolderName: type: string minLength: 1 sortCode: type: string pattern: ^[0-9]+$ accountNumber: type: string pattern: ^[0-9]+$ maxLength: 8 required: - accountHolderName - sortCode - accountNumber bankCode: type: object properties: accountHolderName: type: string minLength: 1 code: type: string accountNumber: type: string required: - accountHolderName - code - accountNumber bban: type: object properties: accountHolderName: type: string minLength: 1 bban: type: string bic: type: string required: - accountHolderName - bban wallet: type: object properties: address: description: The blockchain wallet address type: string blockchain: description: The blockchain network type: string enum: - BTC - BTC-TESTNET4 - ETH - ETH-SEPOLIA - SOL - SOL-DEVNET - MATIC - MATIC-AMOY required: - address - blockchain required: - type physicalAddress: description: A structured physical postal address. type: object properties: line1: description: Primary street address line. type: string minLength: 1 line2: description: Secondary street address line. type: string minLength: 1 city: description: City or locality. type: string minLength: 1 postalCode: description: Postal or ZIP code. type: string minLength: 1 state: description: State, province, or region. type: string minLength: 1 countryCode: description: ISO 3166-1 alpha-2 country code. 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 required: - city - countryCode nullable: true dateOfBirth: description: The counterparty date of birth as YYYY-MM-DD type: string nullable: true metadata: description: The counterparty metadata type: object additionalProperties: type: string createdAt: description: When the counterparty was created updatedAt: description: When the counterparty was last updated required: - id - name - entityType - isSelfOwned - blocked - financialAddress - physicalAddress - dateOfBirth - metadata - createdAt - updatedAt securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-Ivy-Api-Key description: API key for authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.