iCredit
  1. Serasa
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
        • 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
            POST
          • new-report
            POST
      • Supplires
        • find
        • search
        • create
        • send-or-update-public-key
        • delete
        • inactive
        • set-status
    • Enums
      • ClientTypeEnum
      • ClientFilesStatusEnum
      • BankAccountTypeEnum
      • OperationFrequencyEnum
      • OperationModalityEnum
      • OperationCalcMethodEnum
      • SignAsEnum
  1. Serasa

analysis

POST
/api/v1/credit-analysis/serasa/analysis
Realizar uma análise de crédito por meio da Serasa.

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
client_uuid
string 
requerido
organization_uuid
string 
requerido
Exemplo
{
    "client_uuid": "00e042d2-71c1-57be-960f-93d248ea6d3d",
    "organization_uuid": "c0b61bfd-0eda-5694-87c3-d049a9684b19"
}

Respostas

🟢200Analysis
application/json
Body
data
object 
requerido
name
string 
requerido
taxid_number
string 
requerido
taxid_status
string 
requerido
taxid_origin
string 
requerido
gender
string 
requerido
birth_date
string 
requerido
mother_name
string 
requerido
serasa_score
object 
requerido
serasa_negative_data
array [object {14}] 
requerido
serasa_negative_data_summary
array [object {8}] 
requerido
serasa_partners_summary
object 
requerido
serasa_partner
object 
requerido
serasa_stolen_documents
array [object {15}] 
requerido
serasa_inquiry_summary
object 
requerido
serasa_judgement_filings
array
requerido
serasa_judgement_filings_sumary
object 
requerido
serasa_bank_rupts
array [object {7}] 
requerido
serasa_bank_rupts_sumary
object 
requerido
serasa_attributes
object 
requerido
physical_phones
array [object {10}] 
requerido
physical_addresses
array [object {16}] 
requerido
Exemplo
{
    "data": {
        "name": "DAZMMXO OICLZNMKG MZAJXG",
        "taxid_number": "00000001163",
        "taxid_status": "REGULAR",
        "taxid_origin": "SERASA",
        "gender": "M",
        "birth_date": "2000-01-13",
        "mother_name": "WWVJRASC ONLSWDH WXJ MKOPDG LORDWFQWJ",
        "serasa_score": {
            "score": "964",
            "score_model": "HRLN",
            "range": "A",
            "default_rate": "0,0",
            "code_message": 99,
            "message": "ESPACO RESERVADO PARA MENSAGEM DA INSTITUICAO",
            "created_at": "2024-05-06T13:10:25.000000Z",
            "updated_at": "2024-05-06T13:10:25.000000Z"
        },
        "serasa_negative_data": [
            {
                "type": "pefin",
                "occurrence_date": "2023-02-23 00:00:00",
                "legal_nature_id": "AG",
                "legal_nature": "EMPRÉSTIMO",
                "contract_id": null,
                "creditor_name": "TESTE ELASTIC",
                "amount": "8000",
                "city": null,
                "federal_unit": "SP",
                "office_number": null,
                "office_name": null,
                "principal": true,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "pefin",
                "occurrence_date": "2022-08-13 00:00:00",
                "legal_nature_id": "AG",
                "legal_nature": "EMPRÉSTIMO",
                "contract_id": null,
                "creditor_name": "TESTE ELASTIC",
                "amount": "10001",
                "city": null,
                "federal_unit": "SP",
                "office_number": null,
                "office_name": null,
                "principal": true,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "pefin",
                "occurrence_date": "2021-10-25 00:00:00",
                "legal_nature_id": "AG",
                "legal_nature": "EMPRÉSTIMO",
                "contract_id": null,
                "creditor_name": "AURACOM TELECOM LTDA",
                "amount": "2191.55",
                "city": null,
                "federal_unit": "SP",
                "office_number": null,
                "office_name": null,
                "principal": true,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "pefin",
                "occurrence_date": "2021-05-10 00:00:00",
                "legal_nature_id": "AG",
                "legal_nature": "EMPRÉSTIMO",
                "contract_id": null,
                "creditor_name": "TESTE ELASTIC",
                "amount": "50001",
                "city": null,
                "federal_unit": "SP",
                "office_number": null,
                "office_name": null,
                "principal": true,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "refin",
                "occurrence_date": "2023-03-23 00:00:00",
                "legal_nature_id": "AG",
                "legal_nature": "EMPRÉSTIMO",
                "contract_id": null,
                "creditor_name": "TESTE ELASTIC",
                "amount": "20000",
                "city": null,
                "federal_unit": "SP",
                "office_number": null,
                "office_name": null,
                "principal": true,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "refin",
                "occurrence_date": "2023-02-23 00:00:00",
                "legal_nature_id": "AG",
                "legal_nature": "EMPRÉSTIMO",
                "contract_id": null,
                "creditor_name": "TESTE ELASTIC",
                "amount": "5000",
                "city": null,
                "federal_unit": "SP",
                "office_number": null,
                "office_name": null,
                "principal": true,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "refin",
                "occurrence_date": "2023-01-23 00:00:00",
                "legal_nature_id": "AG",
                "legal_nature": "EMPRÉSTIMO",
                "contract_id": null,
                "creditor_name": "TESTE ELASTIC",
                "amount": "10000",
                "city": null,
                "federal_unit": "SP",
                "office_number": null,
                "office_name": null,
                "principal": true,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "refin",
                "occurrence_date": "2021-10-25 00:00:00",
                "legal_nature_id": "FI",
                "legal_nature": "FINANCIAMENTO",
                "contract_id": null,
                "creditor_name": "AURACOM TELECOM LTDA",
                "amount": "4408.89",
                "city": null,
                "federal_unit": "SP",
                "office_number": null,
                "office_name": null,
                "principal": true,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "notary",
                "occurrence_date": "2020-01-01 00:00:00",
                "legal_nature_id": null,
                "legal_nature": null,
                "contract_id": null,
                "creditor_name": null,
                "amount": "3.9",
                "city": "SAO PAULO",
                "federal_unit": "SP",
                "office_number": "01",
                "office_name": null,
                "principal": null,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "notary",
                "occurrence_date": "2020-01-01 00:00:00",
                "legal_nature_id": null,
                "legal_nature": null,
                "contract_id": null,
                "creditor_name": null,
                "amount": "3.9",
                "city": "SAO PAULO",
                "federal_unit": "SP",
                "office_number": "01",
                "office_name": null,
                "principal": null,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "check",
                "occurrence_date": "2022-08-08 00:00:00",
                "legal_nature_id": null,
                "legal_nature": null,
                "contract_id": null,
                "creditor_name": null,
                "amount": null,
                "city": "ARAPONGAS",
                "federal_unit": "PR",
                "office_number": null,
                "office_name": null,
                "principal": null,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "check",
                "occurrence_date": "2022-01-06 00:00:00",
                "legal_nature_id": null,
                "legal_nature": null,
                "contract_id": null,
                "creditor_name": null,
                "amount": null,
                "city": null,
                "federal_unit": null,
                "office_number": null,
                "office_name": null,
                "principal": null,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "check",
                "occurrence_date": "2022-01-05 00:00:00",
                "legal_nature_id": null,
                "legal_nature": null,
                "contract_id": null,
                "creditor_name": null,
                "amount": null,
                "city": null,
                "federal_unit": null,
                "office_number": null,
                "office_name": null,
                "principal": null,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "collectionRecords",
                "occurrence_date": "2021-10-25 00:00:00",
                "legal_nature_id": "ME",
                "legal_nature": "MENSALIDADES ESCOLARES",
                "contract_id": null,
                "creditor_name": "AURACOM TELECOM LTDA",
                "amount": "8375.65",
                "city": "SAO PAULO",
                "federal_unit": "SP",
                "office_number": null,
                "office_name": null,
                "principal": true,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            }
        ],
        "serasa_negative_data_summary": [
            {
                "type": "pefin",
                "first_occurrence": "2021-05-10 00:00:00",
                "last_occurrence": "2023-02-23 00:00:00",
                "count": 4,
                "check_count": null,
                "balance": "70193.55",
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "refin",
                "first_occurrence": "2021-10-25 00:00:00",
                "last_occurrence": "2023-03-23 00:00:00",
                "count": 4,
                "check_count": null,
                "balance": "39408.89",
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "notary",
                "first_occurrence": "2020-01-01 00:00:00",
                "last_occurrence": "2020-01-01 00:00:00",
                "count": 2,
                "check_count": null,
                "balance": "7.8",
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "check",
                "first_occurrence": "2022-01-05 00:00:00",
                "last_occurrence": "2022-08-08 00:00:00",
                "count": 3,
                "check_count": null,
                "balance": "0",
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "collectionRecords",
                "first_occurrence": "2021-10-25 00:00:00",
                "last_occurrence": "2021-10-25 00:00:00",
                "count": 1,
                "check_count": null,
                "balance": "8375.65",
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            }
        ],
        "serasa_partners_summary": {
            "count": null,
            "balance": null,
            "created_at": "2024-05-06T13:10:25.000000Z",
            "updated_at": "2024-05-06T13:10:25.000000Z"
        },
        "serasa_partner": {
            "business_document": "05767575000158",
            "company_name": "EPDIKDFKJ - ZLZQGVIKH W WDDNLWWY SN YHDWX WKIHUW",
            "company_status": "SITUACAO DO CNPJ EM 30/04/2024: BAIXADA",
            "participation_percentage": 20,
            "company_status_code": null,
            "company_state": "RS",
            "company_status_date": null,
            "update_date": "2022-08-30 00:00:00",
            "created_at": "2024-05-06T13:10:25.000000Z",
            "updated_at": "2024-05-06T13:10:25.000000Z"
        },
        "serasa_stolen_documents": [
            {
                "type": "stolenDocuments",
                "occurrence_date": "2021-06-09 00:00:00",
                "inclusion_date": "2021-06-09 10:59:07",
                "document_type": "DI",
                "document_number": "DWu4aFv4itfCqscpxyz9crgzHYkunZ5tvhHFWXzxdmw",
                "issuing_authority": "SSP",
                "detailed_reason": "CLONADO",
                "occurrence_state": "GO",
                "phone_number": "39963166",
                "phone_number_region_code": "55",
                "phone_number_area_code": "62",
                "segment_description": null,
                "days_quantity": null,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "stolenDocuments",
                "occurrence_date": "2021-06-01 00:00:00",
                "inclusion_date": "2021-06-01 10:59:07",
                "document_type": "CPF",
                "document_number": "-fnYpJxfytxO43kbRBwK3t4NNh8HFl7TAXqxQQ-wMN0",
                "issuing_authority": "SRF",
                "detailed_reason": "CLONADO",
                "occurrence_state": "GO",
                "phone_number": "39963166",
                "phone_number_region_code": "55",
                "phone_number_area_code": "62",
                "segment_description": null,
                "days_quantity": null,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "stolenDocuments",
                "occurrence_date": "2021-02-20 00:00:00",
                "inclusion_date": "2021-03-27 14:03:04",
                "document_type": "CNH",
                "document_number": "6622498",
                "issuing_authority": "SRF",
                "detailed_reason": "PERDIDO",
                "occurrence_state": "PR",
                "phone_number": "988751583",
                "phone_number_region_code": "55",
                "phone_number_area_code": "47",
                "segment_description": null,
                "days_quantity": null,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "stolenDocuments",
                "occurrence_date": "2017-04-17 00:00:00",
                "inclusion_date": "2018-05-02 18:00:23",
                "document_type": "CPF",
                "document_number": "efnQIotCxPTPTdWLa_koamHqsZrDCplhvj-CS1zhGzo",
                "issuing_authority": "SRF",
                "detailed_reason": "EXTRAVIADO",
                "occurrence_state": "SP",
                "phone_number": "995586264",
                "phone_number_region_code": "55",
                "phone_number_area_code": "11",
                "segment_description": null,
                "days_quantity": null,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "type": "stolenDocuments",
                "occurrence_date": "2015-02-20 00:00:00",
                "inclusion_date": "2014-03-27 14:03:04",
                "document_type": "DI",
                "document_number": "00002530902",
                "issuing_authority": "SRF",
                "detailed_reason": "FURTADO",
                "occurrence_state": "PR",
                "phone_number": "96425828",
                "phone_number_region_code": "55",
                "phone_number_area_code": "41",
                "segment_description": null,
                "days_quantity": null,
                "created_at": "2024-05-06T13:10:25.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            }
        ],
        "serasa_inquiry_summary": {
            "actual": null,
            "credit_inquiries_quantity_inquiry_date": null,
            "credit_inquiries_quantity_occurrences": null,
            "created_at": "2024-05-06T13:10:25.000000Z",
            "updated_at": "2024-05-06T13:10:25.000000Z"
        },
        "serasa_judgement_filings": [],
        "serasa_judgement_filings_sumary": {
            "first_ocurrence": "2020-07-25 00:00:00",
            "last_ocurrence": "2021-10-25 00:00:00",
            "count": 2,
            "balance": "5228.3",
            "created_at": "2024-04-29T17:15:36.000000Z",
            "updated_at": "2024-04-29T17:15:36.000000Z"
        },
        "serasa_bank_rupts": [
            {
                "occurrence_date": "2017-08-22 00:00:00",
                "company_document_id": "64109570000105",
                "company_name": "CRICENTEL OPERADORA MOVEL LTDA",
                "company_legalNature_id": null,
                "company_legalNature": null,
                "created_at": "2024-04-29T17:15:36.000000Z",
                "updated_at": "2024-04-29T17:15:36.000000Z"
            },
            {
                "occurrence_date": "2017-08-21 00:00:00",
                "company_document_id": "64109570000105",
                "company_name": "CRICENTEL OPERADORA MOVEL LTDA",
                "company_legalNature_id": null,
                "company_legalNature": null,
                "created_at": "2024-04-29T17:15:36.000000Z",
                "updated_at": "2024-04-29T17:15:36.000000Z"
            },
            {
                "occurrence_date": "2017-08-20 00:00:00",
                "company_document_id": "64109570000105",
                "company_name": "CRICENTEL OPERADORA MOVEL LTDA",
                "company_legalNature_id": null,
                "company_legalNature": null,
                "created_at": "2024-04-29T17:15:36.000000Z",
                "updated_at": "2024-04-29T17:15:36.000000Z"
            },
            {
                "occurrence_date": "2017-07-20 00:00:00",
                "company_document_id": "64109570000105",
                "company_name": "VIZAM FQXHIP BSNKOKUFRK H PICDEUTLVWJ CW EZUULSE OPWK",
                "company_legalNature_id": "FD",
                "company_legalNature": "FALÊNCIA DECRETADA",
                "created_at": "2024-04-29T17:15:36.000000Z",
                "updated_at": "2024-04-29T17:15:36.000000Z"
            }
        ],
        "serasa_bank_rupts_sumary": {
            "first_ocurrence": "2020-07-25 00:00:00",
            "last_ocurrence": "2021-10-25 00:00:00",
            "count": 2,
            "balance": "5228.3",
            "created_at": "2024-04-29T17:15:36.000000Z",
            "updated_at": "2024-04-29T17:15:36.000000Z"
        },
        "serasa_attributes": {
            "type": "estimatedIncome",
            "scoring": "756",
            "attribute_model": "HRP9",
            "code_message": 99,
            "message": "ESPACO RESERVADO PARA MENSAGEM DA INSTITUICAO",
            "created_at": "2024-04-29T17:15:36.000000Z",
            "updated_at": "2024-04-29T17:15:36.000000Z"
        },
        "physical_phones": [
            {
                "order": "Serasa",
                "number": "31572",
                "area_code": "12",
                "country_code": "55",
                "complement": "",
                "type": "HOME",
                "phone_number_of_entities": "0",
                "last_update_date": "2024-04-26 12:44:12",
                "created_at": "2024-04-26T15:41:30.000000Z",
                "updated_at": "2024-04-26T15:44:12.000000Z"
            },
            {
                "order": "Serasa",
                "number": "31564",
                "area_code": "12",
                "country_code": "55",
                "complement": "",
                "type": "HOME",
                "phone_number_of_entities": "0",
                "last_update_date": "2024-04-26 12:44:12",
                "created_at": "2024-04-26T15:41:30.000000Z",
                "updated_at": "2024-04-26T15:44:12.000000Z"
            },
            {
                "order": "Serasa",
                "number": "31561",
                "area_code": "12",
                "country_code": "55",
                "complement": "",
                "type": "HOME",
                "phone_number_of_entities": "0",
                "last_update_date": "2024-04-26 12:44:12",
                "created_at": "2024-04-26T15:40:48.000000Z",
                "updated_at": "2024-04-26T15:44:12.000000Z"
            },
            {
                "order": "Serasa",
                "number": "30829999",
                "area_code": "11",
                "country_code": "55",
                "complement": "",
                "type": "HOME",
                "phone_number_of_entities": "0",
                "last_update_date": "2024-05-06 10:10:25",
                "created_at": "2024-04-26T15:55:24.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            },
            {
                "order": "Serasa",
                "number": "11111111",
                "area_code": "41",
                "country_code": "55",
                "complement": "",
                "type": "SERASA",
                "phone_number_of_entities": "0",
                "last_update_date": "2024-05-06 10:10:25",
                "created_at": "2024-04-26T15:55:24.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            }
        ],
        "physical_addresses": [
            {
                "order": "Primary",
                "typology": "",
                "title": "",
                "address_main": "T SHDXEH EFUSLBK",
                "number": "",
                "complement": "",
                "neighborhood": "PINHEIROS",
                "zip_code": "5409000",
                "city": "SAO PAULO",
                "state": "SP",
                "country": "BRA",
                "type": "SERASA",
                "complement_type": "",
                "last_update_date": "2024-05-06 10:10:25",
                "created_at": "2024-04-26T14:49:59.000000Z",
                "updated_at": "2024-05-06T13:10:25.000000Z"
            }
        ]
    }
}
Modificado em 2024-10-29 14:25:17
Página anterior
Credit Analysis
Próxima página
new-report
Built with