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

# Criar parceiro financeiro



## OpenAPI

````yaml https://api.juridiq.com.br/api-docs/client/openapi.json post /financial/partners
openapi: 3.1.0
info:
  title: Juridiq API — Documentação para Integradores
  description: >-
    API REST para integradores autenticados com chave (`x-juridiq-api-key`).


    ## Rate limit


    A API aberta limita **120 requisições a cada 60s por chave**.

    Ao exceder, a resposta é `429 Too Many Requests` com os headers
    `x-ratelimit-limit`, `x-ratelimit-remaining`, `x-ratelimit-reset` e
    `retry-after`.

    Respeite o `retry-after` antes de tentar de novo. Sincronizações em lote
    devem paginar e tratar 429 com backoff.
  version: 1.0.0
servers:
  - url: https://api.juridiq.com.br
    description: Production server
security:
  - apiKeyAuth: []
tags: []
paths:
  /financial/partners:
    post:
      tags:
        - Financial
      summary: Criar parceiro financeiro
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  maxLength: 255
                  description: Nome de exibição
                photoUrl:
                  anyOf:
                    - type: string
                      maxLength: 2048
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: URL da foto
                personType:
                  anyOf:
                    - type: string
                      enum:
                        - PF
                        - PJ
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: PF ou PJ
                document:
                  anyOf:
                    - type: string
                      maxLength: 32
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: CPF ou CNPJ
                phone:
                  anyOf:
                    - type: string
                      maxLength: 32
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: Telefone
                email:
                  anyOf:
                    - type: string
                      format: email
                      maxLength: 255
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: E-mail
                oabNumber:
                  anyOf:
                    - type: string
                      maxLength: 32
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: Número da OAB
                oabState:
                  anyOf:
                    - type: string
                      minLength: 2
                      maxLength: 2
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: UF da OAB
                oabStatus:
                  anyOf:
                    - type: string
                      enum:
                        - active
                        - inactive
                        - suspended
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: Situação da OAB
                practiceType:
                  anyOf:
                    - type: string
                      enum:
                        - correspondent
                        - partner
                        - associated
                        - expert
                        - dispatcher
                        - translator
                        - other
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: Tipo de atuação
                pixKeyType:
                  anyOf:
                    - type: string
                      enum:
                        - cpf
                        - cnpj
                        - email
                        - phone
                        - random
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: Tipo da chave PIX
                pixKey:
                  anyOf:
                    - type: string
                      maxLength: 255
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: Chave PIX
                city:
                  anyOf:
                    - type: string
                      maxLength: 255
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: Cidade da comarca
                state:
                  anyOf:
                    - type: string
                      minLength: 2
                      maxLength: 2
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: UF da comarca
                observation:
                  anyOf:
                    - type: string
                      maxLength: 5000
                    - type: string
                      enum:
                        - ''
                    - enum:
                        - 'null'
                      nullable: true
                  description: Observação interna do escritório
                commissionType:
                  type: string
                  enum:
                    - FIXED
                    - PERCENTAGE
                    - FIXED_AND_PERCENTAGE
                  description: Tipo de comissão
                percentage:
                  type: number
                  nullable: true
                  description: Percentual
                fixedValue:
                  type: number
                  nullable: true
                  description: Valor fixo
              required:
                - name
                - commissionType
              additionalProperties: false
        required: true
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: ID do parceiro
                  name:
                    type: string
                    description: Nome de exibição
                  photoUrl:
                    type: string
                    nullable: true
                    description: URL da foto
                  personType:
                    type: string
                    enum:
                      - PF
                      - PJ
                    nullable: true
                    description: PF ou PJ
                  document:
                    type: string
                    nullable: true
                    description: CPF ou CNPJ
                  phone:
                    type: string
                    nullable: true
                    description: Telefone
                  email:
                    type: string
                    nullable: true
                    description: E-mail
                  oabNumber:
                    type: string
                    nullable: true
                    description: Número da OAB
                  oabState:
                    type: string
                    nullable: true
                    description: UF da OAB
                  oabStatus:
                    type: string
                    enum:
                      - active
                      - inactive
                      - suspended
                    nullable: true
                    description: Situação da OAB
                  practiceType:
                    type: string
                    enum:
                      - correspondent
                      - partner
                      - associated
                      - expert
                      - dispatcher
                      - translator
                      - other
                    nullable: true
                    description: Tipo de atuação
                  pixKeyType:
                    type: string
                    enum:
                      - cpf
                      - cnpj
                      - email
                      - phone
                      - random
                    nullable: true
                    description: Tipo da chave PIX
                  pixKey:
                    type: string
                    nullable: true
                    description: Chave PIX
                  pixHolderName:
                    type: string
                    nullable: true
                    description: Titular da chave PIX
                  city:
                    type: string
                    nullable: true
                    description: Cidade da comarca
                  state:
                    type: string
                    nullable: true
                    description: UF da comarca
                  status:
                    type: string
                    enum:
                      - active
                      - under_review
                      - blocked
                      - inactive
                    description: Status de gestão
                  observation:
                    type: string
                    nullable: true
                    description: Observação interna do escritório
                  commissionType:
                    type: string
                    enum:
                      - FIXED
                      - PERCENTAGE
                      - FIXED_AND_PERCENTAGE
                    description: Tipo de comissão
                  percentage:
                    type: number
                    nullable: true
                    description: Percentual
                  fixedValue:
                    type: number
                    nullable: true
                    description: Valor fixo
                  commissionPaid:
                    type: number
                    description: Comissão paga
                  commissionTotal:
                    type: number
                    description: Comissão total
                  lawSuitCount:
                    type: number
                    description: Quantidade de processos vinculados
                  createdAt:
                    anyOf:
                      - type: string
                      - type: string
                        format: date-time
                    description: Criado em
                  updatedAt:
                    anyOf:
                      - type: string
                      - type: string
                        format: date-time
                    description: Atualizado em
                required:
                  - id
                  - name
                  - photoUrl
                  - personType
                  - document
                  - phone
                  - email
                  - oabNumber
                  - oabState
                  - oabStatus
                  - practiceType
                  - pixKeyType
                  - pixKey
                  - pixHolderName
                  - city
                  - state
                  - status
                  - observation
                  - commissionType
                  - percentage
                  - fixedValue
                  - commissionPaid
                  - commissionTotal
                  - lawSuitCount
                  - createdAt
                  - updatedAt
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  translateMessage:
                    type: string
                required:
                  - message
                  - statusCode
                  - translateMessage
                additionalProperties: false
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-juridiq-api-key
      description: >-
        Chave de API do escritório (criada no painel). Envie o valor no header
        x-juridiq-api-key. A API aberta aplica rate limit por chave (veja a
        documentação de integradores).

````

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