iCredit
  1. Requests
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
        • fInd
        • audits
        • list-by-organization
        • get-me
        • required-fields
        • basic-create
        • create
        • create-legal
        • update
        • update-legal
        • get-client-banks
        • get-client-operations
        • get-client-requests
        • get-client-files
        • finalize-registration
        • change-status
        • change-client-group
        • change-client-user
        • reset-password
        • update-client-representative
        • credit-analysis-validation
        • additional-information
        • create-client-from-onboarding
        • client-validation
      • Requests
        • Options
          • update
        • Files
          • search
          • find
          • create
          • update
          • delete
          • download
        • search
          POST
        • find
          GET
        • create
          POST
        • create-client-pj
          POST
        • create-client-pf
          POST
        • create-request-passing-client
          POST
        • update
          PUT
        • delete
          DELETE
        • send-to-client-approval
          POST
        • handle-change-fund
          PUT
        • handle-change-endorser
          PUT
        • reject
          POST
        • accept
          POST
      • 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. Requests

create-client-pj

POST
/api/v1/requests/client
Criar uma solicitação para pessoa física

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Header
Accept
string 
opcional
Padrão:
application/json
Content-Type
string 
opcional
Padrão:
application/json
Parâmetros Bodyapplication/json
released_value
integer 
requerido
number_of_installments
integer 
requerido
payment_frequency
enum<string> 
requerido
Valores permitidos:
monthlyfortnightlyweeklydailybiweeklyyearlyquarterlysemi_annuallyannually
guarantors
array [object {10}] 
requerido
name
string 
opcional
taxid_number
string 
opcional
email
string 
opcional
foundation_date
string 
opcional
type
enum<string> 
opcional
Valores permitidos:
physicallegal
legal
object 
opcional
address
object 
opcional
phone
object 
opcional
banks
array[string]
opcional
files
array[string]
opcional
request_options
array [object {3}] 
requerido
interest_rate
number 
opcional
number_of_installments
integer 
opcional
payment_frequency
enum<string> 
opcional
Valores permitidos:
monthlyfortnightlyweeklydailybiweeklyyearlyquarterlysemi_annuallyannually
Exemplo
{
    "released_value": 5000,
    "number_of_installments": 12,
    "payment_frequency": "monthly",
    "guarantors": [
        {
            "name": "Carla Monique dos Santos da Luz Ribeiro",
            "taxid_number": "04310345913",
            "email": "teste@teste.com",
            "foundation_date": "2000-01-01",
            "type": "legal",
            "legal": {
                "trade_name": "Trade Name",
                "state_registration": "Brasileiro",
                "municipal_registration": "Curitiba",
                "representative": [
                    {
                        "representative_name": "Representante legal",
                        "representative_email": "representande@email.com",
                        "representative_taxid_number": "00000000000",
                        "representative_mother_name": "Mother Name",
                        "address": {
                            "zip_code": "",
                            "public_place": "",
                            "number": "",
                            "complement": "",
                            "district": "",
                            "city": "",
                            "federal_unit": ""
                        },
                        "phone": {
                            "telephone_number": ""
                        }
                    }
                ]
            },
            "address": {
                "zip_code": "33140000",
                "public_place": "Rua sem nome",
                "number": "123",
                "complement": "casa 1",
                "district": "Conjunto Palimital",
                "city": "Santa Luzia",
                "federal_unit": "MG"
            },
            "phone": {
                "telephone_number": "11999999999"
            },
            "banks": [],
            "files": []
        }
    ],
    "request_options": [
        {
            "interest_rate": 0.015,
            "number_of_installments": 12,
            "payment_frequency": "monthly"
        }
    ]
}

Respostas

🟢201Success
application/json
Body
uuid
string 
requerido
Exemplo
{
    "uuid": "bcaa44b9-8b00-495e-831f-fb7d9451337f"
}
Modificado em 2024-11-18 18:04:46
Página anterior
create
Próxima página
create-client-pf
Built with