---
updatedAt: 2026-04-21T08:13:02.000Z
agentTools:
  projectIndex: https://docs.exthand.com/llms.txt
---

# /ob/vop

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "BankingSDK Docker Release",
    "version": "Docker v5.1.0.0, SDK v5.1.0.0"
  },
  "paths": {
    "/ob/vop": {
      "post": {
        "tags": [
          "03 - Common"
        ],
        "requestBody": {
          "content": {
            "application/json-patch+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/VopRequestDto"
                  }
                ]
              }
            },
            "application/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/VopRequestDto"
                  }
                ]
              }
            },
            "text/json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/VopRequestDto"
                  }
                ]
              }
            },
            "application/*+json": {
              "schema": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/VopRequestDto"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "VOP",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VopResultDto"
                }
              }
            }
          },
          "400": {
            "description": "Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Bank": {
        "type": "object",
        "properties": {
          "bic": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "BankAccountHolder": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "identifier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Identifier"
              }
            ],
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "Error": {
        "type": "object",
        "properties": {
          "exceptionType": {
            "type": "string",
            "nullable": true
          },
          "message": {
            "type": "string",
            "nullable": true
          },
          "userContext": {
            "type": "string",
            "nullable": true
          },
          "log": {
            "type": "string",
            "nullable": true
          },
          "innerException": {
            "type": "string",
            "nullable": true
          },
          "statusCode": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "callId": {
            "type": "string",
            "nullable": true
          },
          "sdkStatus": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "innerMostMessage": {
            "type": "string",
            "nullable": true
          },
          "innerMostErrorType": {
            "type": "string",
            "nullable": true
          },
          "referenceId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "Identifier": {
        "required": [
          "type",
          "value"
        ],
        "type": "object",
        "properties": {
          "type": {
            "minLength": 1,
            "type": "string",
            "description": "The identifier type of the account holder. Can be LEI, BIC, or an ISO 20022 ExternalOrganisationIdentification1Code type:\r\n- **LEI**: Legal Entity Identifier\r\n- **BIC**: Bank Identifier Code\r\n- **BANK**: Bank Party Identification\r\n- **BDID**: Business Domain Identifier\r\n- **BOID**: Business Other Identification\r\n- **CBID**: Central Bank Identification Number\r\n- **CHID**: Clearing Identification Number\r\n- **CINC**: Certificate of Incorporation Number\r\n- **COID**: Country Identification Code\r\n- **CUST**: Customer Number\r\n- **DUNS**: Data Universal Numbering System\r\n- **EMPL**: Employer Identification Number\r\n- **GS1G**: GS1GLN Identifier\r\n- **SREN**: SIREN\r\n- **SRET**: SIRET\r\n- **TXID**: Tax Identification Number"
          },
          "value": {
            "minLength": 1,
            "type": "string"
          }
        },
        "additionalProperties": false
      },
      "MatchResult": {
        "type": "object",
        "properties": {
          "result": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "TppContext": {
        "type": "object",
        "properties": {
          "tppId": {
            "type": "string",
            "nullable": true
          },
          "app": {
            "type": "string",
            "nullable": true
          },
          "flow": {
            "type": "string",
            "nullable": true
          },
          "transaction": {
            "type": "string",
            "nullable": true
          },
          "unit": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Additional data to be used by TPP for tracking purposes"
      },
      "VopRequest": {
        "required": [
          "iban"
        ],
        "type": "object",
        "properties": {
          "iban": {
            "minLength": 1,
            "type": "string"
          },
          "name": {
            "maxLength": 140,
            "minLength": 0,
            "type": "string",
            "nullable": true
          },
          "identifier": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Identifier"
              }
            ],
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "VopRequestDto": {
        "required": [
          "vop"
        ],
        "type": "object",
        "properties": {
          "tppContext": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TppContext"
              }
            ],
            "description": "Additional data to be used by TPP for tracking purposes",
            "nullable": true
          },
          "vop": {
            "allOf": [
              {
                "$ref": "#/components/schemas/VopRequest"
              }
            ]
          }
        },
        "additionalProperties": false
      },
      "VopResult": {
        "type": "object",
        "properties": {
          "vopMatchResult": {
            "allOf": [
              {
                "$ref": "#/components/schemas/MatchResult"
              }
            ],
            "nullable": true
          },
          "bankAccountHolder": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BankAccountHolder"
              }
            ],
            "nullable": true
          },
          "bank": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Bank"
              }
            ],
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "VopResultDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "remoteId": {
            "type": "string",
            "nullable": true
          },
          "vopResult": {
            "allOf": [
              {
                "$ref": "#/components/schemas/VopResult"
              }
            ],
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    }
  }
}
```