ZapSign API
Español
Español
  • Información General
  • Antes de empezar
  • Entornos de ZapSign
  • Solicitudes listas para usar
  • Autenticación
    • Token estático
    • Autenticación JWT
      • Obtener el access token
      • Actualizar access token
  • Tipos de Tokens
  • Versiones de la API
  • Políticas de Rate Limit
  • Alertas de Incidentes
  • Cómo Funciona el Pago
  • Códigos de estado
  • Cuenta
    • Información del Plan
    • Listar usuarios de la cuenta
    • Crear usuarios en la cuenta
    • Eliminar usuario de la cuenta
  • Documentos
    • Crear documento via Upload
    • OneClick - Clickwrap
      • Crear documento (OneClick)
    • Crear documento via Plantilla
    • Adicionar documento (sobre)
    • Adicionar documento extra via Plantilla
    • Detalle del documento
    • Listar documentos
    • Eliminar documento
    • Histórico de eventos
    • Posicionar firma (opcional)
    • Rechazar documentos
  • Validación de firmas
  • Firmantes
    • Detalles del firmante
    • Actualizar firmante
    • Adicionar firmante
    • Eliminar firmante
    • Firma en lote via API
    • Rechazar documentos por el usuario
  • Plantillas
    • Crear plantilla DOCX
      • Configurar formulario de plantilla
    • Listar plantillas
    • Actualizar plantilla
    • Eliminar plantilla
  • Aliados / Re-sellers
    • Actualizar estado de pago
    • Crear cuenta
  • Antecedentes
    • Introducción
    • Entendiendo el resultado
  • Crear un consulta (check)
    • Consulta de persona
    • Consulta de empresa
  • Consultar check
  • Detalle del check
  • Webhooks
    • ¿Cómo funcionan los webhooks?
    • Probar webhooks en ZapSign
    • Crear Webhook
    • Registro de Webhooks
    • Eventos
      • De documento
        • Doc creado
        • Doc eliminado
        • Firmante creado
      • De firmantes
        • Solicitud de firma enviada
        • Doc visualizado
        • Confirmación lectura
        • Doc firmado
        • Doc rechazado
        • Email bounce
        • Validación Fallida
      • De antecedentes
        • Consulta completada
    • Reprocesando documentos y webhooks
    • Eliminar Webhook
  • Widget
    • iFrame: ¿cómo funciona?
Powered by GitBook
On this page

Was this helpful?

  1. Crear un consulta (check)

Consulta de persona

PreviousCrear un consulta (check)NextConsulta de empresa

Last updated 14 days ago

Was this helpful?

Este endpoint es para crear una consulta de persona o historia crediticia de persona. Los parámetros que debes enviar, dependen del país y el tipo de consulta. Además, hay parámetros opcionales que pueden mejorar los resultados consultando más bases de datos y filtrar homónimos en algunos casos.

Importante: Para consulta de historial crediticio de personas en Colombia, es necesario comunicarse con el para activar esta funcionalidad.

POST https://api.zapsign.com.br/api/v1/checks/

Header

Nombre
Tipo
Descripción

Authorization*

string

API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Nombre
Tipo
Descripción

country*

string

type*

string

"person","credit_person_co", "credit_person_br",

user_authorized*

boolean

Indica si la persona autorizó la validación. Debe ser true para proceder.

force_creation

boolean

Si true fuerza la creación de una nueva búsqueda de antecedentes si ya existe un resultado. Si false, devuelve el resultado de la consulta de antecedentes creada anteriormente.

first_name

string

Nombre de la persona. Si se especifica, se hace una consulta a bases de datos internacionales para obtener más detalle en los resultados.

last_name

string

Apellido de la persona. Si se especifica, se hace una consulta a bases de datos internacionales para obtener más detalle en los resultados.

national_id

string

Documento de identidad oficial. Se debe enviar national_id, foreign_id, ptp o ppt.

foreign_id

string

Documento de identidad de extranjeria. Se debe enviar national_id, foreign_id, ptp o ppt.

Disponible para CO, CL, MX, PE.

ptp

string

Disponible para PE. Permiso de Protección Temporal.

ppt

string

Disponible para CO. Permiso de Protección Temporal.

state_id

string

RG (Registro Geral) en Brasil. Esta identificación tiene diferentes formatos según el estado que emite el documento. Puede tener números y letras, pero se omiten otros caracteres (- * , . ), Necesario para obtener antecedentes completos en Brasil.

date_of_birth

string

Fecha de nacimiento en formato YYYY-MM-DD. Es un campo obligatoria para consulta de extranjeros (foreign_id) en CL y CO, y documento oficial (national_id) en PE y BR. En otras casos, ayuda a obtener resultados más detallados.

region

string

Obligatorio para BR. Región para la búsqueda de antecedentes. Puede ser una región específica o ALL para búsqueda nacional. Búsquedas nacionales pueden tardar hasta 24 horas, mientras que las regionales tardan entre 2 a 20 minutos.

DF | AC | AL | AP | AM | BA | CE | ES | GO | MA | MT | MS | MG | PA | PB | PR | PE | PI | RJ | RN | RS | RO | RR | SC | SP | SE | TO | ALL

issue_date

DateTime

Fecha de emisión del documento en formato YYYY-MM-DD. Aplica para CL (national_id), CO (national_id y foreign_id),

custom_input

string

Identificador externo opcional para referencia. Máximo 128 caracteres.

verification_code

string

Código de verificación para registros criminales en Perú y Chile.

issue_number

string

Número de documento de identidad chileno. Este número se utiliza para obtener información adicional sobre una persona. Sólo para Chile

observers

array<string>

Representa a los observadores de la consulta de antecedentes (hasta 20 personas), es decir, direcciones de correo electrónico que serán notificadas cuando la consulta de antecedentes haya finalizado. Es un array de correos electrónicos.

Consulta de persona en CO, BR, CL y PE: 90 créditos (USD$1.8)

Consulta de persona en MX: 130 créditos (USD$2.6)

Consulta de historia crediticia de persona CO y BR: 200 créditos (USD$4)

Ejemplo de solicitud

{
    "user_authorized": true,
    "force_creation": true,
    "type": "person",
    "country": "CO",
    "national_id": "11111111"
}

Response

{
    "check_id": "CHK682a755bb7135140248cc8dd1d290a01",
    "status": "not_started",
    "company_name": "",
    "full_name": "",
    "first_name": "",
    "last_name": "",
    "date_of_birth": null,
    "issue_date": null,
    "national_id": "11111111",
    "foreign_id": "",
    "tax_id": "",
    "country": "CO",
    "native_country": "",
    "check_type": "person",
    "lang": "es",
    "region": "",
    "created_at": "2025-03-28T17:49:43.363416Z",
    "last_update_at": "2025-03-28T17:49:43.363435Z"
}

Recuerda que los resultados de una consulta pueden demorar entre 2 y 20 minutos. Para consultar los resultados se puede:

BR | CO | CL | MX | PE. Más detalle de consultas disponibles

Más detalle de consultas disponibles

Cada consulta de antecedentes tiene un costo adicional que depende del tipo de consulta. Para recargar tu cuenta ingresa a tu cuenta en la sección .

equipo comercial
Planes y Precios > Créditos
Endpoint de Resultados de una consulta
haz clic aqui
haz clic aqui