1. Clients
iCredit
  • Credit
    • Get Started
      • About
      • Authentication
      • Error Messages
    • Get Started APP
      • About
      • Authentication
      • Error Messages
      • Webhooks
    • Enums
      • ClientTypeEnum
      • ClientFilesStatusEnum
      • BankAccountTypeEnum
      • OperationFrequencyEnum
      • OperationModalityEnum
      • OperationCalcMethodEnum
      • SignAsEnum
    • Api Reference
      • Auth
        • Login
        • refresh
        • logout
        • update-password
      • Users
      • Clients
        • Banks
          • list
          • search
          • find
          • create
          • update
          • delete
        • Files
          • Types
            • search
            • list
            • fInd
            • create
            • update
            • delete
          • create
          • fInd
          • download
          • search
          • delete
        • search
          POST
        • fInd
          GET
        • audits
          POST
        • list-by-organization
          GET
        • get-me
          GET
        • required-fields
          GET
        • basic-create
          POST
        • create
          POST
        • create-legal
          POST
        • update
          PUT
        • update-legal
          PUT
        • get-client-banks
          GET
        • get-client-operations
          GET
        • get-client-requests
          GET
        • get-client-files
          GET
        • finalize-registration
          PUT
        • change-status
          POST
        • change-client-group
          POST
        • change-client-user
          POST
        • reset-password
          POST
        • update-client-representative
          PATCH
        • credit-analysis-validation
          PATCH
        • additional-information
          GET
        • create-client-from-onboarding
          POST
        • client-validation
          GET
        • sync
          POST
        • Ionboarding resync
          POST
      • Requests
        • Options
          • update
        • Files
          • search
          • find
          • create
          • update
          • delete
          • download
        • Listar Requests / obter request_uuid
        • Consultar detalhe da Request / capturar option
        • create
        • create-client-pj
        • create-client-pf
        • create-request-passing-client
        • update
        • delete
        • send-to-client-approval
        • handle-change-fund
        • handle-change-endorser
        • reject
        • accept
        • review file
        • request documents
        • resend documents
        • Get Request Participants
        • Add Participant
        • Add New Spouse
        • Add Existing Spouse
        • Check Request Readiness
        • client-reject
        • get requests
      • Operations
        • required-fields
        • search
        • find
        • audit
        • create
        • simulate
        • generic-simulate
        • update
        • delete
        • files
        • resend-notification
        • update-deadline-at
        • add-signatories
        • remove-signatory
        • cancel-document
        • finish-document
        • reprocess-current-status
        • change-status
        • update-status-to-grant
        • update-status-to-endorsement
        • update-status-to-approval
        • operation-status
        • Listar arquivos da operação
        • Get Operation Participants
        • Add Participant
        • Edit Participants
        • Delete Participants
        • Add New Spouse
        • Select Existing Spouse
        • Remover garantidor da operação
        • signature-sync
      • Credit Analysis
        • Serasa
          • analysis
          • new-report
      • Supplires
        • find
        • search
        • create
        • send-or-update-public-key
        • delete
        • inactive
        • set-status
      • System Settings
        • list
        • search
        • find
        • create
        • update
        • delete
        • activate
        • audits
  • Credit V2
    • Dashboard
      • home-admin
    • Monitoramento
      • check
      • documentation
      • signature-diagnosis
    • Operações
      • Arquivos
        • files
        • list-by-operation
      • Assinaturas e documentos
        • add-signatories
        • cancel-document
        • finish-document
        • resend-notification
        • remove-signatory
        • update-deadline-atIn-document
        • get_file_events_operation
      • Cônjuges
        • Criar cônjuge na operação
      • Fluxo e status
        • status-labels
        • approval
        • endorsement
        • grant
        • reprocess-current-status
        • change-status
      • Garantidores
        • Listar garantidores da operação
        • Listar clientes elegíveis para garantidores da operação
      • Geral
        • Criar operação com participantes e garantidores
        • update
      • Participantes
        • Listar candidatos a participantes
        • Listar participantes da operação
        • Listar candidatos a participantes da operação
        • Listar clientes elegíveis para garantidores da operação
    • Organizações
      • create
      • get form options
      • contract-by-organization
      • get organization
    • Requests
      • Cônjuges
        • Criar Person e relacionamento conjugal
        • Anexar cônjuge existente
      • Documentos
        • review-files
        • resend-documents
      • Fluxo e status
        • QA-01 — Confirmar catálogo de status V2
        • accept
        • generate-operation
        • check-readiness
        • reject
        • send-to-client-approval
        • change-status
      • Garantidores
        • REQ-03 — Listar Guarantors
        • REQ-03 — Criar candidato a Guarantor
        • REQ-03 — Clients elegíveis para Guarantor
        • REQ-03 — Vincular Client existente
        • REQ-03 — Suggestions de Guarantors
        • REQ-03 — Remover Guarantor
        • REQ-03 — Aprovar Guarantor
        • REQ-03 — Rejeitar Guarantor
        • REQ-03 — Solicitar correção do Guarantor
        • REQ-03 — Reenviar Guarantor para revisão
      • Geral
        • Criar Request
        • update
        • create-client
        • create-passing-the-client
        • search
        • request details
        • set-calculation-method
        • set-endorser
        • set-fund
        • handle-option
      • Participantes
        • Listar participantes da Request
        • Criar ou reativar participante
        • Listar candidatos a participante da Request
        • Remover participante da Request
        • Alterar papel do participante
    • Simulações
      • preview
      • Create Operation
      • export pdf
    • Timeline
      • show
    • Tipos de arquivo
      • QA-09 — Selecionar tipo de documento requestable
      • Create File Type
      • delete file type
      • find file type
      • update file type
    • Tipos de contrato
      • list
      • create
      • find
      • update
      • approve
      • effective-settings
      • update-link-organization
      • link-organization
      • request-revision
      • submit-validation
    • CADOC
      • Arquivos
        • Transmissões STA
          • Listar transmissões STA do arquivo
          • Consultar transmissão STA
        • Validações oficiais
          • Listar validações oficiais do arquivo
          • Download de artefato (audita)
        • Buscar arquivos CADOC
        • Consultar arquivo
        • download files
      • CADOCs
        • 200 — Buscar CADOCs
        • Consultar CADOC
      • Configurações
        • 200 — Buscar configurações
        • Consultar configuração
      • Entidades reportantes
        • 200 — Listar entidades reportantes
        • Endossantes elegíveis
        • Readiness regulatório
      • Lotes de geração
        • 200 — Buscar lotes de geração
        • Consultar lote
      • Mapeamentos de produtos
        • 200 — Buscar mapeamentos
        • Consultar mapeamento
      • Perfis regulatórios
        • 200 — Buscar perfis regulatórios
        • Consultar perfil regulatório
    • Witness
      • Create Witness
  1. Clients

list-by-organization

GET
/api/v1/clients/{organization_uuid}
Listar clientes pertencentes a uma organização específica.

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200Success
application/json
Bodyapplication/json

Exemplo
{
    "uuid": "0a0064f1-e719-5f99-92c0-04e78d883dbe",
    "organization_uuid": "ca7d368e-9c5e-4ec3-b59f-5d437e1c7c07",
    "official_name": "D3 SINGULAR FI FINANCEIRO MULTIMERCADO IE",
    "trade_name": "D3 SINGULAR FI FINANCEIRO",
    "foundation_date": "2023-11-16",
    "cnae_code": "0647-01-01",
    "taxid_number": "52910545000139",
    "email": "financeiro@monetar.com.br",
    "phone_number": "1131656000",
    "address_zip_code": "04534000",
    "address_public_place": "R JOAQUIM FLORIANO",
    "address_number": "100",
    "address_complement": "ANDAR 18 CONJ 182",
    "address_district": "ITAIM BIBI",
    "address_city": "SAO PAULO",
    "address_federal_unit": "SP",
    "representative_name": "Rafael Takeo Kiyuna",
    "representative_birth_date": "1991-03-14",
    "representative_taxid_number": "75426483060",
    "representative_mother_name": "Gauci Takeo Kiyuna",
    "created_at": "2024-05-14T16:21:44.000000Z",
    "updated_at": "2024-05-14T16:21:44.000000Z",
    "organization_name": "Inovanti IP",
    "organization": {
        "uuid": "ca7d368e-9c5e-4ec3-b59f-5d437e1c7c07",
        "third_party_identifier": "ca7d368e-9c5e-4ec3-b59f-5d437e1c7c07",
        "name": "Inovanti IP",
        "taxid_number": "37511258000162",
        "email": "teste_dev_inovanti@inovanti.com.br",
        "created_at": "2024-05-02T19:48:51.000000Z",
        "updated_at": null,
        "domain": "localhost:3000",
        "settings": [
            {
                "uuid": "a1a43ba8-04ae-4af9-b054-bf4220abd721",
                "key": "onboarding",
                "is_active": true,
                "settings": {
                    "background": {
                        "background_legal_uuid": "9aded5b9-7175-461d-983f-4bd8875178a3",
                        "background_physical_uuid": "fc0276d4-2bcd-406d-a21f-9be4f24dfccd"
                    }
                },
                "created_at": "2024-05-02T19:48:51.000000Z",
                "updated_at": "2024-05-02T19:48:51.000000Z"
            }
        ]
    }
}
🟢200Success
Modificado em 2025-02-19 17:29:38
Página anterior
audits
Próxima página
get-me
Built with