iCredit
  1. Clients
iCredit
  • Credit
    • Get Started
      • About
      • Authentication
      • Error Messages
    • Get Started APP
      • About
      • Authentication
      • Error Messages
      • Webhooks
    • Api Reference
      • Auth
        • login
        • refresh
        • logout
        • update-password
      • Users
        • me
      • 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
      • Requests
        • Options
          • update
        • Files
          • search
          • find
          • create
          • update
          • delete
          • download
        • search
        • find
        • 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
      • Operations
        • required-fields
        • search
        • find
        • audit
        • create
        • 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
      • Credit Analysis
        • Serasa
          • analysis
          • new-report
      • Supplires
        • find
        • search
        • create
        • send-or-update-public-key
        • delete
        • inactive
        • set-status
    • Enums
      • ClientTypeEnum
      • ClientFilesStatusEnum
      • BankAccountTypeEnum
      • OperationFrequencyEnum
      • OperationModalityEnum
      • OperationCalcMethodEnum
      • SignAsEnum
  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 Path
organization_uuid
string 
requerido
Parâmetros Header
Accept
string 
opcional
Padrão:
application/json
Content-Type
string 
opcional
Padrão:
application/json

Respostas

🟢200Success
application/json
Body
uuid
string 
requerido
organization_uuid
string 
requerido
official_name
string 
requerido
trade_name
string 
requerido
foundation_date
string 
requerido
cnae_code
string 
requerido
taxid_number
string 
requerido
email
string 
requerido
phone_number
string 
requerido
address_zip_code
string 
requerido
address_public_place
string 
requerido
address_number
string 
requerido
address_complement
string 
requerido
address_district
string 
requerido
address_city
string 
requerido
address_federal_unit
string 
requerido
representative_name
string 
requerido
representative_birth_date
string 
requerido
representative_taxid_number
string 
requerido
representative_mother_name
string 
requerido
created_at
string 
requerido
updated_at
string 
requerido
organization_name
string 
requerido
organization
object 
requerido
uuid
string 
requerido
third_party_identifier
string 
requerido
name
string 
requerido
taxid_number
string 
requerido
email
string 
requerido
created_at
string 
requerido
updated_at
null 
requerido
domain
string 
requerido
settings
array [object {6}] 
requerido
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