ZapSign API
Português
Português
  • Informações gerais
  • Como começar
  • Ambiente de testes
  • Todas as requisições prontas!
  • Autenticação
    • Token estático (Api Token)
    • JWT (recomendado)
      • Obter token de acesso
      • Atualize seu token de acesso
  • Tipos de Tokens e Como Localizá-los
  • Versionamento da API
  • Políticas de Rate Limit
  • Alerta de incidentes
  • Ambiente de produção: Como funciona o pagamento
  • Status de erros
  • Conta
    • Informações do Plano
    • Listar usuários da conta
    • Criar usuários na conta
    • Excluir usuário da conta
  • Documentos
    • Criar documento via Upload
    • OneClick (ClickWrap)
      • Criar documento (OneClick)
    • Criar documento via Modelo
    • Adicionar anexo (documento extra)
    • Adicionar anexo (documento extra) via Modelo
    • Detalhar documento
    • Listar documentos
    • Excluir documento
    • Histórico de atividades do documento
    • Opcional: Posicionar assinaturas
    • Reprovar documentos
    • Validação de assinaturas
  • Signatários
    • Detalhar signatário
    • Atualizar signatário
    • Adicionar signatário
    • Excluir signatário
    • Resetar tentativas de validação
    • Grupo de signatários
      • Definir grupos de signatários
      • Excluir grupos de signatários
    • Assinar em lote via API
    • Reprovar documentos pelo usuário
  • Modelos
    • Criar modelo DOCX
      • Atualizar formulario
    • Listar modelos
    • Detalhar modelo
    • Atualizar modelo
    • Excluir modelo
  • Antecedentes
    • Introdução
    • Entendendo o Resultado
    • Criar uma Consulta (Check)
      • Consulta de Pessoa
      • Consulta de Empresa
  • Consultar Check
  • Detalhe do Check
  • Parcerias
    • Atualizar status de pagamento
  • Criar conta
  • CARIMBO DE TEMPO
    • Como funciona Carimbo de Tempo?
    • Carimbo de Tempo padrão
    • Carimbo de tempo preservando a assinatura original
  • Webhooks
    • Como funcionam os Webhooks
    • Testando Webhooks
    • Criar webhook
    • Logs de Webhooks
    • Eventos
      • Documento
        • Documento criado
        • Documento removido
        • Signatário criado
      • Signatário
        • Notificação de assinatura
        • Documento visualizado
        • Confirmação de leitura
        • Documento assinado
        • Documento recusado
        • Email bounce
        • Falha na Validação
      • Antecedentes
        • Consulta concluída
    • Reprocessamento de Documentos e Webhooks
    • Deletar webhook
  • Widget
    • Como funciona o Widget
Powered by GitBook
On this page
  • Possíveis estados de cada base de dados (result)
  • Response

Was this helpful?

Detalhe do Check

PreviousConsultar CheckNextAtualizar status de pagamento

Last updated 1 month ago

Was this helpful?

Este endpoint retorna todas as informações completas de uma consulta de antecedentes, incluindo:

  • Os datasets que foram consultados.

  • As informações encontradas em cada base de dados.

  • As severidades associadas a cada achado.

A resposta inclui um JSON estruturado com todos os dados disponíveis, permitindo que você os analise e tome decisões automatizadas ou manuais conforme suas necessidades.

Recomendamos ler primeiro a seção para compreender como interpretar o score, os datasets, as severidades e como utilizar essas informações de forma eficaz.

GET https://api.zapsign.com.br/api/v1/checks/{{check_id}}/details/

Header

Nome
Tipo
Descrição

Authorization*

string

Token da API com o prefixo "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Parâmetros de Path

Nome
Tipo
Descrição

check_id

string

Identificador da consulta

Parâmetros de Query

Nome
Tipo
Descrição

lang

string

Idioma dos resultados. Se não for especificado, os resultados estarão no idioma original das fontes. Valores possíveis: es, en, pt-br.

start_key

string

Paginação dos resultados. O parâmetro next na resposta indica a próxima página.

Possíveis estados de cada base de dados (result)

  • not_started: A coleta de dados da fonte foi ativada.

  • skipped: A fonte de dados foi ignorada por falta de informações suficientes para realizar a consulta.

  • delayed: A base de dados está demorando para responder.

  • completed: Os dados foram obtidos com sucesso.

  • error: Não foi possível obter dados da fonte.

  • expired: A fonte de dados estava indisponível no momento da consulta.

Response

{
    "details": [
        {
            "categorization": [],
            "check_id": "CHK8b7d9384620528617768575540b777ca",
            "data_set": "personal_identity",
            "database_id": "DBId638e0b47c76bc20b2171ec4367a486f98b82823",
            "database_name": "Registraduría Nacional del Estado Civil - RNEC",
            "depth": 0,
            "document_type": "national-id",
            "found_company_name": "",
            "found_date_of_birth": "",
            "found_first_name": "MARIA",
            "found_last_name": "PEREZ",
            "found_rfc": "",
            "id": "DTLde981fccc2fba6fd6bc44a7d6f539209",
            "identity_result": "",
            "identity_state": "",
            "result": "found",
            "route": "id",
            "severity": "none",
            "tables": [
                {
                    "title": "Información Personal",
                    "rows": [
                        {
                            "cells": [
                                {
                                    "label": "Cédula de ciudadanía",
                                    "value": "11111111"
                                },
                                {
                                    "label": "Apellidos",
                                    "value":PEREZ"
                                },
                                {
                                    "label": "Nombres",
                                    "value": "MARIA"
                                },
                                {
                                    "label": "Municipio de expedición",
                                    "value": "BOGOTA D.C."
                                },
                                {
                                    "label": "Departamento de expedición",
                                    "value": "CUNDINAMARCA"
                                },
                                {
                                    "label": "Fecha de expedición",
                                    "value": "DD/MM/YYYY"
                                },
                                {
                                    "label": "Estado de la cédula",
                                    "value": "Vigente"
                                }
                            ]
                        }
                    ]
                }
            ],
            "update_date": "2025-03-31T14:46:47.019713697Z"
        },
        {
            "categorization": [],
            "check_id": "CHK8b7d9384620528617768575540b777ca",
            "data_set": "credit_history",
            "database_id": "DBIb2ecd883c70c976e013f15b0f4f3acdba9d040f4",
            "database_name": "Datacredito Qualities",
            "depth": 0,
            "document_type": "national-id",
            "found_company_name": "",
            "found_date_of_birth": "",
            "found_first_name": "",
            "found_last_name": "",
            "found_rfc": "",
            "id": "DTL38c9c1f57b61bb61167bb004821b255f",
            "identity_result": "",
            "identity_state": "",
            "result": "found",
            "route": "name",
            "severity": "none",
            "tables": [
                {
                    "title": "Desempeño actual en todos los portafolios",
                    "rows": [
                        {
                            "cells": [
                                {
                                    "label": "Mora Maxima del portafolio a la fecha",
                                    "value": "0 días"
                                },
                                {
                                    "label": "Numero total de productos al dia a la fecha",
                                    "value": "4 productos"
                                },
                                {
                                    "label": "Numero total de productos castigados a la fecha",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero total de productos en mora de 120 días o mas a la fecha",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero total de productos en mora de 30 días a la fecha",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero total de productos en mora de 60 días a la fecha",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero total de productos en mora de 90 días a la fecha",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Número total de productos recuperados a la fecha",
                                    "value": "0 productos"
                                }
                            ]
                        }
                    ]
                },
                {
                    "title": "Desempeño a corto plazo en todos los portafolios",
                    "rows": [
                        {
                            "cells": [
                                {
                                    "label": "Mora Maxima en los Ultimos 6 meses",
                                    "value": "0 días"
                                },
                                {
                                    "label": "Numero de productos Ever 120 en los ultimos 6 meses",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero de productos Ever 30 en los ultimos 6 meses",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero de productos Ever 60 en los ultimos 6 meses",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero de productos Ever 90 en los ultimos 6 meses",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero total de productos Castigados en los ultimos 6 meses",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero total de productos Siempre Al dia en los ultimos 6 meses",
                                    "value": "4 productos"
                                }
                            ]
                        }
                    ]
                },
                {
                    "title": "Desempeño a mediano plazo en todos los portafolios",
                    "rows": [
                        {
                            "cells": [
                                {
                                    "label": "Mora Maxima en los Ultimos 12 meses",
                                    "value": "0 días"
                                },
                                {
                                    "label": "Numero de productos Ever 120 en los ultimos 12 meses",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero de productos Ever 30 en los ultimos 12 meses",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero de productos Ever 60 en los ultimos 12 meses",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero de productos Ever 90 en los ultimos 12 meses",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero total de productos Castigados en los ultimos 12 meses",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero total de productos Siempre Al dia en los ultimos 12 meses",
                                    "value": "4 productos"
                                }
                            ]
                        }
                    ]
                },
                {
                    "title": "Desempeño a largo plazo en todos los portafolios",
                    "rows": [
                        {
                            "cells": [
                                {
                                    "label": "Mora Maxima Historica",
                                    "value": "0 días"
                                }
                            ]
                        }
                    ]
                },
                {
                    "title": "Experiencia financiera",
                    "rows": [
                        {
                            "cells": [
                                {
                                    "label": "Meses desde la apertura del producto abierto mas antiguo en todos los portafolios",
                                    "value": "98 meses"
                                },
                                {
                                    "label": "Meses desde la apertura del producto mas antiguo en todos los portafolios",
                                    "value": "133 meses"
                                },
                                {
                                    "label": "Meses desde la apertura del producto mas reciente en todos los portafolios",
                                    "value": "4 meses"
                                },
                                {
                                    "label": "Numero de Productos Abiertos en el portafolio: créditos rotativos, cartera bancaria, microcrédito, cartera compañías de financiamiento comercial, Tarjetas de Crédito",
                                    "value": "3 productos"
                                },
                                {
                                    "label": "Numero de Productos Abiertos en el portafolio: cartera bancaria, cartera de corporaciones financieras, cartera de fondos de empleados, cartera de compañías de leasing, cartera compañías de financiamiento comercial, cartera de compensación y salud, créditos de consumo, microcrédito",
                                    "value": "0 productos"
                                },
                                {
                                    "label": "Numero de Productos Abiertos en el portafolio: cartera automotriz, cartera bancaria, cartera compañías de financiamiento comercial, cartera compañías de seguros",
                                    "value": "No tiene información en el portafolio"
                                },
                                {
                                    "label": "Numero de Productos Abiertos en el portafolio: cartera de vivienda, cartera bancaria, cartera de corporaciones financieras, cartera de fondos de empleados, cartera compañías de financiamiento comercial, microcrédito",
                                    "value": "No tiene información en el portafolio"
                                },
                                {
                                    "label": "Numero de Productos Abiertos en el portafolio cuenta corriente",
                                    "value": "1 productos"
                                },
                                {
                                    "label": "Numero de Productos Abiertos en el portafolio otros tipos de cartera",
                                    "value": "No tiene información en el portafolio"
                                },
                                {
                                    "label": "Numero de Productos Abiertos en el portafolio codeudores",
                                    "value": "No tiene información en el portafolio"
                                },
                                {
                                    "label": "Numero de Productos Abiertos en el portafolio cuentas de ahorros bancarias",
                                    "value": "4 productos"
                                },
                                {
                                    "label": "Numero de Productos Abiertos en el portafolio cuentas corrientes bancarias",
                                    "value": "No tiene información en el portafolio"
                                },
                                {
                                    "label": "Numero de Productos Abiertos en el portafolio tarjetas de crédito",
                                    "value": "3 productos"
                                },
                                {
                                    "label": "Numero de Productos Abiertos en el portafolio carteras de entidades fintech",
                                    "value": "No tiene información en el portafolio"
                                }
                            ]
                        }
                    ]
                },
                {
                    "title": "Endeudamiento financiero",
                    "rows": [
                        {
                            "cells": [
                                {
                                    "label": "Saldo total en productos a la fecha en el portafolio créditos rotativos, cartera bancaria, microcrédito, cartera compañías de financiamiento comercial, Tarjetas de Crédito",
                                    "value": "0.140 salarios mínimos"
                                },
                                {
                                    "label": "Saldo total en productos a la fecha en el portafolio cartera bancaria, cartera de corporaciones financieras, cartera de fondos de empleados, cartera de compañías de leasing, cartera compañías de financiamiento comercial, cartera de compensación y salud, créditos de consumo, microcrédito",
                                    "value": "No tiene cuentas abiertas"
                                },
                                {
                                    "label": "Saldo total en productos a la fecha en el portafolio cartera automotriz, cartera bancaria, cartera compañías de financiamiento comercial, cartera compañías de seguros",
                                    "value": "No tiene información en el portafolio"
                                },
                                {
                                    "label": "Saldo total en productos a la fecha en el portafolio de cartera de vivienda, cartera bancaria, cartera de corporaciones financieras, cartera de fondos de empleados, cartera compañías de financiamiento comercial, microcrédito",
                                    "value": "No tiene información en el portafolio"
                                },
                                {
                                    "label": "Saldo total en productos a la fecha en el portafolio otros tipos de cartera",
                                    "value": "No tiene información en el portafolio"
                                },
                                {
                                    "label": "Saldo total en productos a la fecha en el portafolio codeudores",
                                    "value": "No tiene información en el portafolio"
                                },
                                {
                                    "label": "Saldo total en productos a la fecha en el portafolio tarjetas de crédito",
                                    "value": "0.140 salarios mínimos"
                                },
                                {
                                    "label": "Cuota total en productos a la fecha en todos los portafolios",
                                    "value": "0.590 salarios mínimos"
                                },
                                {
                                    "label": "Saldo total en productos a la fecha en el portafolio carteras de entidades fintech",
                                    "value": "No tiene información en el portafolio"
                                }
                            ]
                        }
                    ]
                },
                {
                    "title": "Variables demográficas",
                    "rows": [
                        {
                            "cells": [
                                {
                                    "label": "Estrato",
                                    "value": "DESCONOCIDO"
                                },
                                {
                                    "label": "Estado Civil",
                                    "value": "DESCONOCIDO"
                                },
                                {
                                    "label": "Nivel de Estudios",
                                    "value": "Desconocido"
                                }
                            ]
                        }
                    ]
                },
                {
                    "title": "Datacredito score",
                    "rows": [
                        {
                            "cells": [
                                {
                                    "label": "Score",
                                    "value": "881"
                                }
                            ]
                        }
                    ]
                }
            ],
            "update_date": "2025-03-31T14:46:48.860822828Z"
        },
        {
            "categorization": [],
            "check_id": "CHK8b7d9384620528617768575540b777ca",
            "data_set": "personal_identity",
            "database_id": "DBI01241e248d1ceab7f163e2d8357c9a955c6700b7",
            "database_name": "Lugar de votación",
            "depth": 0,
            "document_type": "national-id",
            "found_company_name": "",
            "found_date_of_birth": "",
            "found_first_name": "",
            "found_last_name": "",
            "found_rfc": "",
            "id": "DTLd996116c058c8ad28cbadc11d5cabfd3",
            "identity_result": "",
            "identity_state": "",
            "result": "found",
            "route": "id",
            "severity": "none",
            "tables": [
                {
                    "title": "Información general",
                    "rows": [
                        {
                            "cells": [
                                {
                                    "label": "NUIP",
                                    "value": "11111111"
                                },
                                {
                                    "label": "DEPARTAMENTO",
                                    "value": "BOGOTA D.C."
                                },
                                {
                                    "label": "MUNICIPIO",
                                    "value": "BOGOTA. D.C."
                                },
                                {
                                    "label": "PUESTO",
                                    "value": "CENTRO COMERCIAL"
                                },
                                {
                                    "label": "DIRECCIÓN",
                                    "value": "AV. 15"
                                },
                                {
                                    "label": "MESA",
                                    "value": "DD"
                                }
                            ]
                        }
                    ]
                }
            ],
            "update_date": "2025-03-31T14:46:49.495986237Z"
        },
        {
            "categorization": [],
            "check_id": "CHK8b7d9384620528617768575540b777ca",
            "data_set": "personal_identity",
            "database_id": "DBI7a2681a28ed8f86984cc8a41b2c09f36ed995824",
            "database_name": "Registro Único Nacional de Tránsito",
            "depth": 0,
            "document_type": "",
            "found_company_name": "",
            "found_date_of_birth": "",
            "found_first_name": "MARIA",
            "found_last_name": "PEREZ",
            "found_rfc": "",
            "id": "DTLb90bc39f59e9940d042849b12de3cf42",
            "identity_result": "",
            "identity_state": "",
            "result": "found",
            "route": "id",
            "severity": "none",
            "tables": [
                {
                    "title": "Nombre del conductor",
                    "rows": [
                        {
                            "cells": [
                                {
                                    "label": "Nombre",
                                    "value": "MARIA"
                                },
                                {
                                    "label": "Apellidos",
                                    "value": "PEREZ"
                                }
                            ]
                        }
                    ]
                }
            ],
            "update_date": "2025-03-31T14:46:59.528516112Z"
        },
        {
            "categorization": [],
            "check_id": "CHK8b7d9384620528617768575540b777ca",
            "data_set": "credit_history",
            "database_id": "DBI14efd094ec1c4715155be9fd527a5c3fae496f8c",
            "database_name": "Información de Contacto y Ubicación en Buró de Crédito",
            "depth": 0,
            "document_type": "national-id",
            "found_company_name": "",
            "found_date_of_birth": "",
            "found_first_name": "",
            "found_last_name": "",
            "found_rfc": "",
            "id": "DTL4502547ce36ccb798fa295025ddc91b8",
            "identity_result": "",
            "identity_state": "",
            "result": "ignored",
            "route": "name",
            "severity": "unknown",
            "tables": null,
            "update_date": "2025-03-31T14:46:47.515582895Z"
        },
        {
            "categorization": [],
            "check_id": "CHK8b7d9384620528617768575540b777ca",
            "data_set": "personal_identity",
            "database_id": "DBI14efd094ec1c4715155be9fd527a5c3fae496f8c",
            "database_name": "Información de Contacto y Ubicación en Buró de Crédito",
            "depth": 0,
            "document_type": "national-id",
            "found_company_name": "",
            "found_date_of_birth": "",
            "found_first_name": "",
            "found_last_name": "",
            "found_rfc": "",
            "id": "DTL45cb9653d6fc1547f2452c2adfd68105",
            "identity_result": "",
            "identity_state": "",
            "result": "ignored",
            "route": "name",
            "severity": "unknown",
            "tables": null,
            "update_date": "2025-03-31T14:46:47.594157254Z"
        },
        {
            "categorization": [],
            "check_id": "CHK8b7d9384620528617768575540b777ca",
            "data_set": "personal_identity",
            "database_id": "DBI0e769ed7cca8905f0261a2da9f4f9a90895552f2",
            "database_name": "Situación Militar",
            "depth": 0,
            "document_type": "national-id",
            "found_company_name": "",
            "found_date_of_birth": "",
            "found_first_name": "",
            "found_last_name": "",
            "found_rfc": "",
            "id": "DTLbcf4ab3258382bfcd89f0f4bca9accd2",
            "identity_result": "",
            "identity_state": "",
            "result": "not_found",
            "route": "id",
            "severity": "unknown",
            "tables": null,
            "update_date": "2025-03-31T14:46:51.527827107Z"
        }
    ],
    "self": "/api/v1/checks/CHK8b7d9384620528617768575540b777ca/details/",
    "next": ""
}
Entendendo o Resultado