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

# Get your partner configuration: country, currency, status and limits



## OpenAPI

````yaml /api-reference/openapi.json get /api/v3/partners/{shortName}
openapi: 3.0.0
info:
  title: Ndovu Partner API
  description: API for partners distributing Ndovu investment products to their customers.
  version: '3'
  contact: {}
servers:
  - url: https://be-dev-1.dev.ndovu.co
    description: Development
security: []
tags: []
paths:
  /api/v3/partners/{shortName}:
    get:
      tags:
        - partners
      summary: 'Get your partner configuration: country, currency, status and limits'
      operationId: PartnerCustomersController_getConfig_v3
      parameters:
        - name: shortName
          required: true
          in: path
          description: Your partner short name
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerConfigResponseDto'
      security:
        - bearer: []
components:
  schemas:
    PartnerConfigResponseDto:
      type: object
      properties:
        name:
          type: string
          example: Acme Bank
        shortName:
          type: string
          example: acme-bank
        logoUrl:
          type: string
          nullable: true
          example: https://cdn.ndovu.co/corporate/acme-bank.png
        kycPolicy:
          type: string
          example: PARTNER
        identityPolicy:
          type: string
          example: SHARED
          description: >-
            SHARED: send your customers' names, email and phone. REFERENCED:
            send only externalUserId, no personal data
        country:
          type: string
          nullable: true
          example: KE
        currency:
          type: string
          nullable: true
          example: KES
        status:
          type: string
          example: ACTIVE
        referenceCode:
          type: string
          nullable: true
          example: DTB
          description: >-
            The prefix of your customers' payment references, e.g. DTB7F3K9Q.
            Investing needs it set
        bankTransferEnabled:
          type: boolean
          example: true
          description: Your customers can invest by bank transfer
        mpesaEnabled:
          type: boolean
          example: false
          description: Your customers can invest by M-Pesa
        limits:
          type: object
          properties:
            tokenLifetimeSeconds:
              type: number
            requestsPerMinute:
              type: number
          required:
            - tokenLifetimeSeconds
            - requestsPerMinute
        environment:
          type: string
          example: staging
      required:
        - name
        - shortName
        - kycPolicy
        - identityPolicy
        - status
        - bankTransferEnabled
        - mpesaEnabled
        - limits
        - environment
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````

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