{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/caliza/json-schema/caliza-integrator-response-schema.json",
  "title": "IntegratorResponse",
  "description": "Complete integrator information including business details, banking, configuration, and status.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/caliza-integrator-v1-api-openapi.yml#/components/schemas/IntegratorResponse",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "address": {
      "$ref": "#/$defs/AddressResponse"
    },
    "document": {
      "type": "string"
    },
    "telephones": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "contract": {
      "$ref": "#/$defs/ContractResponse"
    },
    "files": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "active": {
      "type": "boolean"
    },
    "callbackUrl": {
      "type": "string"
    },
    "contactEmails": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "credentials": {
      "$ref": "#/$defs/CredentialsResponse"
    },
    "banking": {
      "$ref": "#/$defs/IntegratorBankingResponse"
    },
    "webhookSecret": {
      "type": "string"
    },
    "deviationConfig": {
      "$ref": "#/$defs/IntegratorDeviationConfigResponse"
    },
    "customerSignupId": {
      "type": "string"
    },
    "marketExecutionType": {
      "type": "string",
      "enum": [
        "NONE",
        "EXECUTE_IMMEDIATELY",
        "MARKET_OPEN_TIME"
      ]
    }
  },
  "$defs": {
    "AddressResponse": {
      "type": "object",
      "description": "Physical address information for a beneficiary or integrator including all address components.",
      "properties": {
        "streetOne": {
          "type": "string"
        },
        "streetTwo": {
          "type": "string"
        },
        "geolocation": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "zipcode": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "country": {
          "type": "string"
        }
      }
    },
    "ContractResponse": {
      "type": "object",
      "description": "Contract details including pricing and fee structure between integrator and Caliza.",
      "properties": {
        "price": {
          "type": "number"
        },
        "transactionFee": {
          "type": "number"
        },
        "transactionFeeMode": {
          "type": "string",
          "enum": [
            "PERCENT",
            "BPS",
            "FIXED",
            "SPREAD"
          ]
        }
      }
    },
    "CredentialsResponse": {
      "type": "object",
      "description": "API credentials for integrator including API keys and authentication details.",
      "properties": {
        "clientId": {
          "type": "string"
        },
        "clientSecret": {
          "type": "string"
        }
      }
    },
    "IntegratorBankingResponse": {
      "type": "object",
      "description": "Banking information for integrator including PIX key and account details.",
      "properties": {
        "code": {
          "type": "integer",
          "format": "int64",
          "description": "Bank code number (Brazilian bank identifier)."
        },
        "agency": {
          "type": "integer",
          "format": "int64",
          "description": "Bank agency/branch number."
        },
        "account": {
          "type": "string",
          "description": "Bank account number."
        },
        "pixKey": {
          "type": "string"
        },
        "pixKeyType": {
          "type": "string"
        }
      }
    },
    "IntegratorDeviationConfigResponse": {
      "type": "object",
      "description": "Transaction deviation configuration for the integrator including tolerance thresholds.",
      "properties": {
        "percentDeviationDelayedTransactions": {
          "type": "number"
        }
      }
    }
  }
}