Atlar · Schema
CounterpartyJSONPatchRequest
JSON Patch request to update a counterparty.
CompanyFintechTreasuryPaymentsBankingCash ManagementFinancial OperationsERP Integration
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/atlar/json-schema/atlar-counterparty-jsonpatch-request-schema.json",
"title": "CounterpartyJSONPatchRequest",
"description": "JSON Patch request to update a counterparty.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/atlar-counterparties-api-openapi.yml#/components/schemas/CounterpartyJSONPatchRequest",
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/$defs/CounterpartyJSONPatchReplaceLegalName"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchReplaceAlias"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchRemoveAlias"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchReplaceNationalIdentifier"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchRemoveNationalIdentifier"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchReplaceEmail"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchRemoveEmail"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchReplaceAddress"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchReplaceAddressCity"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchReplaceAddressCountry"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchReplacePhone"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchRemovePhone"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchReplacePartyType"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchRemovePartyType"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchReplaceEntityIds"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchRemoveEntityIds"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchReplaceExternalId"
},
{
"$ref": "#/$defs/CounterpartyJSONPatchRemoveExternalId"
}
]
},
"$defs": {
"Address": {
"description": "Postal address.",
"type": "object",
"properties": {
"country": {
"$ref": "#/$defs/CountryCode",
"x-go-type-skip-optional-pointer": true
},
"countrySubdivision": {
"$ref": "#/$defs/CountrySubdivision",
"x-go-type-skip-optional-pointer": true
},
"city": {
"type": "string",
"maxLength": 64
},
"postalCode": {
"type": "string",
"maxLength": 16
},
"streetName": {
"type": "string",
"maxLength": 64
},
"streetNumber": {
"type": "string",
"maxLength": 16
}
}
},
"CounterpartyJSONPatchRemoveAlias": {
"description": "Remove alias.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"remove"
]
},
"path": {
"type": "string",
"enum": [
"/alias"
]
}
},
"additionalProperties": false,
"required": [
"op",
"path"
]
},
"CounterpartyJSONPatchRemoveEmail": {
"description": "Remove email.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"remove"
]
},
"path": {
"type": "string",
"enum": [
"/email"
]
}
},
"additionalProperties": false,
"required": [
"op",
"path"
]
},
"CounterpartyJSONPatchRemoveEntityIds": {
"description": "Remove entities.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"remove"
]
},
"path": {
"type": "string",
"enum": [
"/entityIds"
]
}
},
"additionalProperties": false,
"required": [
"op",
"path"
]
},
"CounterpartyJSONPatchRemoveExternalId": {
"description": "Remove external ID.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"remove"
]
},
"path": {
"type": "string",
"enum": [
"/externalId"
]
}
},
"additionalProperties": false,
"required": [
"op",
"path"
]
},
"CounterpartyJSONPatchRemoveNationalIdentifier": {
"description": "Remove national identifier.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"remove"
]
},
"path": {
"type": "string",
"enum": [
"/nationalIdentifier"
]
}
},
"additionalProperties": false,
"required": [
"op",
"path"
]
},
"CounterpartyJSONPatchRemovePartyType": {
"description": "Remove party type.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"remove"
]
},
"path": {
"type": "string",
"enum": [
"/partyType"
]
}
},
"additionalProperties": false,
"required": [
"op",
"path"
]
},
"CounterpartyJSONPatchRemovePhone": {
"description": "Remove phone number.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"remove"
]
},
"path": {
"type": "string",
"enum": [
"/phone"
]
}
},
"additionalProperties": false,
"required": [
"op",
"path"
]
},
"CounterpartyJSONPatchReplaceAddress": {
"description": "Set postal address.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/address"
]
},
"value": {
"$ref": "#/$defs/Address"
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"CounterpartyJSONPatchReplaceAddressCity": {
"description": "Set address city.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/address/city"
]
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"CounterpartyJSONPatchReplaceAddressCountry": {
"description": "Set address country.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/address/country"
]
},
"value": {
"$ref": "#/$defs/CountryCode"
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"CounterpartyJSONPatchReplaceAlias": {
"description": "Set alias.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/alias"
]
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"CounterpartyJSONPatchReplaceEmail": {
"description": "Set email address.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/email"
]
},
"value": {
"type": "string",
"maxLength": 256
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"CounterpartyJSONPatchReplaceEntityIds": {
"description": "Set entities.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/entityIds"
]
},
"value": {
"type": "array",
"items": {
"$ref": "#/$defs/ResourceID"
},
"maxItems": 100,
"uniqueItems": true
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"CounterpartyJSONPatchReplaceExternalId": {
"description": "Set external ID.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/externalId"
]
},
"value": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"CounterpartyJSONPatchReplaceLegalName": {
"description": "Set legal name.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/legalName"
]
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"CounterpartyJSONPatchReplaceNationalIdentifier": {
"description": "Set national identifier.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/nationalIdentifier"
]
},
"value": {
"$ref": "#/$defs/NationalIdentifier"
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"CounterpartyJSONPatchReplacePartyType": {
"description": "Set party type.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/partyType"
]
},
"value": {
"type": "string",
"$ref": "#/$defs/PartyType"
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"CounterpartyJSONPatchReplacePhone": {
"description": "Set phone number.",
"type": "object",
"properties": {
"op": {
"type": "string",
"enum": [
"replace"
]
},
"path": {
"type": "string",
"enum": [
"/phone"
]
},
"value": {
"type": "string",
"maxLength": 64
}
},
"additionalProperties": false,
"required": [
"op",
"path",
"value"
]
},
"CountryCode": {
"type": "string",
"description": "Two-letter ISO 3166-1 alpha2 country code.",
"minLength": 2,
"maxLength": 2,
"pattern": "^[A-Z]{2,2}$"
},
"CountrySubdivision": {
"type": "string",
"description": "Country subdivision code (second part of the ISO 3166-2 code).\nE.g. state code `CA` for the state of California in the USA, `ON` for the province of Ontario in Canada, `NSW` for the state of New South Wales in Australia.\nISO 3166-2 codes can be found on the ISO website, for example, for the USA: https://www.iso.org/obp/ui/#iso:code:3166:US.\nIn the USA the state code is required for domestic payments, in Canada the province code is required for domestic payments.",
"maxLength": 6,
"pattern": "^[A-Z]{2,2}-[A-Z0-9]{1,3}$"
},
"MarketCode": {
"type": "string",
"description": "Two-letter ISO 3166-1 alpha2 country code.",
"minLength": 2,
"maxLength": 2,
"pattern": "^[A-Z]{2,2}$"
},
"NationalIdentifier": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of the national identifier.",
"enum": [
"CIVIC",
"COMPANY"
]
},
"market": {
"$ref": "#/$defs/MarketCode"
},
"number": {
"type": "string",
"description": "The identifier itself."
}
},
"required": [
"type",
"market",
"number"
]
},
"PartyType": {
"type": "string",
"description": "The legal type of a party",
"enum": [
"INDIVIDUAL",
"COMPANY"
]
},
"ResourceID": {
"type": "string",
"description": "Unique resource identifier.",
"minLength": 32,
"maxLength": 64
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/atlar-counterparty-jsonpatch-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.