Listagem de análises do motor de crédito para uma pessoa física ou jurídica

Esse endpoint permite a busca e listagem de análises do motor de crédito realizadas por um determinado Tomador, permite realizar paginação e aplicação de filtros no resultado.

Parâmetros da URL

• borrower_id (string/uuid v4): ID do tomador.

• page (integer): O número da página para paginação.

• size (integer): O número de itens por página.

• product (string/uuid v4): ID do produto.

• enabled (boolean): Flag para indicar o status da análise.

Resposta

Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:

• content (object): Objeto contendo o resultado com as análises do tomador que atendam aos filtros aplicados.

• total_pages (int): Quantidade de páginas para paginação.

• total_elements (int): Quantidade total de registros encontrados.

• has_next (boolean): Flag para indicar se terá a próxima página para paginação.

Objeto "content"

• id (string/uuid v4):ID da solicitação consultada.

• enabled (boolean): Flag para indicar o status da analise.

• product_id (string/uuid v4): ID de identificação do produto desejado na solicitação.

• originator_id (string/uuid v4): ID de identificação do originador.

• settings_id (string/uuid v4): ID de identificação da configuração do motor para realização da análise.

• borrower_id (string/uuid v4): ID de identificação da pessoa tomadora do empréstimo consultada.

• request_payload (object): Objeto contendo os detalhes do payload enviado na requisição.

• response_payload (object): Objeto contendo os detalhes do payload retornado na requisição.

Objeto "response_payload"

• id (string/uuid v4): ID da análise executada.

• borrower_id (string/uuid v4): ID de identificação da pessoa consultada.

• product_id (string/uuid v4): ID de identificação do produto utilizado na análise realizada.

• bureau (object): Objeto contendo os dados da consulta externa realizada em um bureau.

• limits (object): Objeto contendo os parâmetros calculados para a política de crédito.

• message (object): Objeto contendo a mensagem de retorno para uma consulta realizada.

Exemplo de resposta

{
    "content": [
        {
            "id": "<uuid>",
            "product_id": "<uuid>",
            "enabled": "<boolean>",
            "originator_id": "<uuid>",
            "settings_id": "<uuid>",
            "borrower_id": "<uuid>",
            "request_payload": {},
            "response_payload": {
                "id": "<uuid>",
                "product_id": "<uuid>",
                "borrower_id": "<uuid>",
                "funding_id": "<uuid>",
                "bureau": {
                    "est95": "<string>"
                },
                "limits": {
                    "term_max": "<number>",
                    "term_min": "<number>",
                    "currency": "<string>",
                    "created_at": "<string>",
                    "credit_max": "<double>",
                    "credit_min": "<double>",
                    "expires_at": "<string>",
                    "periodicity": "<string>",
                    "document_type": "<string>",
                    "interest_rate": "<number>",
                    "min_retention": "<double>",
                    "document_number": "<string>",
                    "max_grace_period": "<long>",
                    "min_grace_period": "<long>",
                    "estimated_revenue": "<double>",
                    "max_payment_number": "<long>",
                    "min_payment_number": "<long>",
                    "retention_rate_max": "<double>",
                    "retention_type": "<string>"
                },
                "message": "<string>"
            },
            "limits": {
                "term_max": "<number>",
                "term_min": "<number>",
                "currency": "<string>",
                "created_at": "<string>",
                "credit_max": "<double>",
                "credit_min": "<double>",
                "expires_at": "<string>",
                "periodicity": "<string>",
                "document_type": "<string>",
                "interest_rate": "<number>",
                "min_retention": "<double>",
                "document_number": "<string>",
                "max_grace_period": "<long>",
                "min_grace_period": "<long>",
                "estimated_revenue": "<double>",
                "max_payment_number": "<long>",
                "min_payment_number": "<long>",
                "retention_rate_max": "<double>",
                "retention_type": "<string>"
            }
        },
        {
            "id": "<uuid>",
            "product_id": "<uuid>",
            "enabled": "<boolean>",
            "originator_id": "<uuid>",
            "settings_id": "<uuid>",
            "borrower_id": "<uuid>",
            "request_payload": {},
            "response_payload": {
                "id": "<uuid>",
                "product_id": "<uuid>",
                "borrower_id": "<uuid>",
                "funding_id": "<uuid>",
                "bureau": {
                    "qui75f": "<string>",
                    "cupidatat_b9": "<string>",
                    "reprehenderit58": "<string>"
                },
                "limits": {
                    "term_max": "<number>",
                    "term_min": "<number>",
                    "currency": "<string>",
                    "created_at": "<string>",
                    "credit_max": "<double>",
                    "credit_min": "<double>",
                    "expires_at": "<string>",
                    "periodicity": "<string>",
                    "document_type": "<string>",
                    "interest_rate": "<number>",
                    "min_retention": "<double>",
                    "document_number": "<string>",
                    "max_grace_period": "<long>",
                    "min_grace_period": "<long>",
                    "estimated_revenue": "<double>",
                    "max_payment_number": "<long>",
                    "min_payment_number": "<long>",
                    "retention_rate_max": "<double>",
                    "retention_type": "<string>"
                },
                "message": "<string>"
            },
            "limits": {
                "term_max": "<number>",
                "term_min": "<number>",
                "currency": "<string>",
                "created_at": "<string>",
                "credit_max": "<double>",
                "credit_min": "<double>",
                "expires_at": "<string>",
                "periodicity": "<string>",
                "document_type": "<string>",
                "interest_rate": "<number>",
                "min_retention": "<double>",
                "document_number": "<string>",
                "max_grace_period": "<long>",
                "min_grace_period": "<long>",
                "estimated_revenue": "<double>",
                "max_payment_number": "<long>",
                "min_payment_number": "<long>",
                "retention_rate_max": "<double>",
                "retention_type": "<string>"
            }
        }
    ],
    "total_pages": "<integer>",
    "total_elements": "<long>",
    "has_next": "<boolean>"
}