> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zupy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get your partner profile

> The features enabled for your partner account and your current commercial conditions. Scope `partner.read`. Rates are fractions (`0.2000` = 20%). Never returns PIX, CNPJ or contact data.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/partner/profile/
openapi: 3.0.3
info:
  title: Zupy API v2
  version: 2.0.0
  description: >-
    Zupy API v2 — versioned, gateway-aware API with envelope responses, RFC 7807
    errors, and multi-auth support (JWT, API Key, Device Key).
servers:
  - url: https://api.zupy.com
    description: Production
security: []
tags:
  - name: Authentication
    description: OTP request and verification endpoints
  - name: Customers
    description: Customer management, points, history, and data operations
  - name: Loyalty Programs
    description: Loyalty program configuration and details
  - name: Rewards
    description: Loyalty reward catalog (definitions redeemed with points)
  - name: Companies
    description: Company information and loyalty configuration
  - name: Coupons
    description: >-
      Issued coupons (RewardRedemption) — both loyalty-reward redemptions and
      marketing claims
  - name: Wallet
    description: Apple Wallet pass generation and notifications
  - name: Webhooks
    description: Partner integration webhook endpoints
  - name: Webhook Management
    description: Configure and test outbound webhook delivery
  - name: Partner
    description: >-
      Issuer partner API: credit and transfer Z$ with your partner key (scopes
      `partner.read`, `partner.credit`, `partner.transfer`).
paths:
  /api/v2/partner/profile/:
    get:
      tags:
        - Partner
      summary: Get your partner profile
      description: >-
        The features enabled for your partner account and your current
        commercial conditions. Scope `partner.read`. Rates are fractions
        (`0.2000` = 20%). Never returns PIX, CNPJ or contact data.
      operationId: partner_profile_retrieve
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerProfile'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: ''
      security:
        - apiKeyAuth: []
components:
  schemas:
    PartnerProfile:
      type: object
      properties:
        status:
          type: string
        activated_at:
          type: string
          format: date-time
          nullable: true
        features:
          $ref: '#/components/schemas/PartnerFeatures'
        conditions:
          $ref: '#/components/schemas/PartnerConditions'
      required:
        - activated_at
        - conditions
        - features
        - status
    Error:
      type: object
      description: RFC 7807 Problem Details error response.
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
      required:
        - detail
        - instance
        - status
        - title
        - type
    PartnerFeatures:
      type: object
      properties:
        issuer:
          type: boolean
        commercial:
          type: boolean
        publisher:
          type: boolean
        originator:
          type: boolean
        communication:
          type: boolean
      required:
        - commercial
        - communication
        - issuer
        - originator
        - publisher
    PartnerConditions:
      type: object
      properties:
        commercial_model:
          type: string
          description: agency, revenda or empty.
        commission_rate:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,4})?$
          description: 'Fraction: 0.2000 = 20%.'
        originator_rate:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,4})?$
        publisher_rate:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,4})?$
        coupon_split_rate:
          type: string
          format: decimal
          pattern: ^-?\d{0,1}(?:\.\d{0,4})?$
        plan_discounts:
          type: object
          additionalProperties:
            type: string
          description: 'Monthly fee discount per plan tier, as a fraction: {"2": "0.20"}.'
      required:
        - commercial_model
        - commission_rate
        - coupon_split_rate
        - originator_rate
        - plan_discounts
        - publisher_rate
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Per-company partner API key (zupy_pk_…). Validated by Zupy against the
        company integration key hash (Story 14.x); send it on every request as
        the X-API-Key header. Scoped read-write to the owning company's data.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.