BlackList

Operaciones
POST /v1/validarPersona
POST /v1/validarEmpresa
POST /v1/validarEmail
POST /v1/informacion/persona
POST /v1/informacion/empresa
Validar Persona
POST /v1/validarPersona

Este método nos permitirá validar una persona natural

Request body

Examples

Ejemplo de Request de Validar Persona

{
    "tipoDocumento": "1",
    "nroDocumento": "12345678"
}

Responses

200 OK

Respuesta Exitosa

Body
Examples

Ejemplo de respuesta de Proveedor 1

{
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "monitoreo": "98",
    "validaciones": {
        "flagNroDocumento": "0",
        "flagCtaBancaria": "1",
        "flagRubro": "1"
    },
    "indicacionValidacion": "Validar Cuenta Bancaria ,Validar Rubro",
    "traza": "W-B-E",
    "datos": {
        "resultado": {
            "msgNumeroOperacion": "2021020916074087",
            "msgFechaHoraOperacion": "20210209 16:02:40",
            "msgEstadoConsulta": "13",
            "msgDescripcionConsulta": "La consulta fue efectiva",
            "respuesta": 200
        },
        "informacionConsultado": {
            "tipoPersona": "N",
            "tipoDocumento": "1",
            "numeroDocumento": "00046846255",
            "apellidoPaterno": "DE LOS SANTOS",
            "apellidoMaterno": "GARCIA",
            "nombres": "CARLOS HUBI",
            "fechaNacimiento": "19920314",
            "sexo": "MASCULINO",
            "estadoCivil": "SOLTERO",
            "estadoDNI": "VIGENTE",
            "domicilio": {
                "tipoDireccion": "",
                "direccion": "",
                "distrito": "",
                "provincia": "",
                "departamento": "",
                "ubigeo": ""
            }
        },
        "contribuyente": {},
        "mensajesLibres": [
            {
                "nombre": "NOMBRE-MENSAJE",
                "valor": ""
            }
        ]
    }
}

Ejemplo de respuesta de Proveedor 2

{
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "monitoreo": "00",
    "validaciones": {
        "flagNroDocumento": "1",
        "flagCtaBancaria": "1",
        "flagRubro": "1"
    },
    "indicacionValidacion": "Validar DNI/CE contra Reniec/Migraciones ,Validar Cuenta Bancaria ,Validar Rubro",
    "traza": "W-B-E-S",
     "datos": {
        "Resultado": {
            "Documento": "46846255",
            "RazonSocial": "DE LOS SANTOS GARCIA CARLOS HUBI",
            "FechaProceso": "23/01/2021",
            "Semaforos": "RVVVVVVVVVVVVVVVVVVVVVVV",
            "Nota": "0.0000",
            "NroBancos": "5",
            "DeudaTotal": "10269.48",
            "VencidoBanco": "0.00",
            "Calificativo": "NOR 100% CPP   0% DEF   0% DUD   0% PER   0%",
            "SemaActual": "4",
            "SemaPrevio": "4",
            "SemaPeorMejor": "4",
            "Documento2": "10468462554",
            "EstDomic": "00",
            "CondDomic": "00",
            "DeudaTributaria": "0.00",
            "DeudaLaboral": "0.00",
            "DeudaImpaga": "0.00",
            "DeudaProtestos": "0.00",
            "DeudaSBS": "10269.48",
            "TarCtas": "0",
            "RepNeg": "0",
            "TipoActv": "CONSULTORES  PROG. Y SUMIN. INFORMATIC.",
            "FechIniActv": "27/11/2011",
            "DireccionFiscal": "CALLE SIN NOMBRE  MZA. A  LTE. 15 PUEBLO JOVEN LADERAS DE CHILLON PUENTE PIEDRA - LIMA - LIMA",
            "CodigoWS": "0"
        }
    }
}
200 No existen datos

No existen datos

Body
Object
codigoRespuesta
string
Example:
15
mensajeRespuesta
string
Example:
NO EXISTEN DATOS
traza
string
Example:
W-B-E-S
monitoreo
string
Example:
96
400 Request Inválido

Request inválido

Body
Object
codigoRespuesta
string
Example:
11
mensajeRespuesta
string
Example:
REQUEST INVÁLIDO
401 No autorizado

No autorizado

Body
Object
codigoRespuesta
string
Example:
13
mensajeRespuesta
string
Example:
NO AUTORIZADO
Validar Empresa
POST /v1/validarEmpresa

Este método nos permitirá validar la correspondencia entre una empresa y el documento de identidad

Request body

Examples

Ejemplo de Request de Validar Empresa

{
    "ruc": "10123456784",
    "tipoDocumento": "1",
    "nroDocumento": "12345678"
}

Responses

200 OK

Respuesta Exitosa

Body
Examples

Ejemplo de respuesta de Proveedor 1

{
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "traza": "W-B-E",
    "monitoreo": "98",
    "validaciones": {
        "flagNroDocumento": 0,
        "flagRuc": 0,
        "flagCtaBancaria": 1,
        "flagRubro": 1
    },
    "indicacionValidacion": "Validar Cuenta Bancaria ,Validar Rubro",
    "actividadEconomica": "ACTIV. DE INVESTIGACION Y SEGURIDAD.",
    "datos": {
        "resultado": {
            "msgNumeroOperacion": "2021032301005404",
            "msgFechaHoraOperacion": "20210323 01:03:54",
            "msgEstadoConsulta": "13",
            "msgDescripcionConsulta": "La consulta fue efectiva",
            "respuesta": 200
        },
        "informacionConsultado": {
            "tipoPersona": "J",
            "tipoDocumento": "2",
            "numeroDocumento": "20100161932",
            "apellidoPaterno": "",
            "apellidoMaterno": "",
            "nombres": "",
            "fechaNacimiento": "",
            "sexo": "",
            "estadoCivil": "",
            "estadoDNI": "",
            "domicilio": {
                "tipoDireccion": "1",
                "direccion": "CAL. LOS MERCADERES NRO. 164 INT. 203 URB. LAS GARDENIAS ET. TRES",
                "distrito": "SANTIAGO DE SURCO",
                "provincia": "LIMA",
                "departamento": "LIMA",
                "ubigeo": "150140"
            }
        },
        "contribuyente": {
            "ruc": "20100161932",
            "razonSocial": "SERVICIO NACIONAL DE VIGILANCIA INDUSTRIAL S.A. EN LIQUIDACION",
            "nombreComercial": "SENAVISA",
            "fechaInicioActividades": "19781201",
            "tipoContribuyente": "26",
            "actividadEconomicaCIIU": "74927",
            "dependencia": "0023",
            "estadoContribuyente": "00",
            "numeroTrabajadores": "00000",
            "representantesLegales": [
                {
                    "nombresRazonSocial": "ORELLANA CUADROS JORGE LUIS",
                    "tipoDocumento": "1",
                    "numeroDocumento": "00009857249",
                    "cargo": "APODERADO",
                    "fechaInicioCargo": "20061218",
                    "fechaNacimiento": "19740403",
                    "sexo": "MASCULINO",
                    "estadoCivil": "SOLTERO",
                    "estadoDNI": "VIGENTE"
                },
                {
                    "nombresRazonSocial": "",
                    "tipoDocumento": "2",
                    "numeroDocumento": "20511542317",
                    "cargo": "LIQUIDADOR",
                    "fechaInicioCargo": "20061218",
                    "fechaNacimiento": "00000000",
                    "sexo": "",
                    "estadoCivil": "",
                    "estadoDNI": ""
                }
            ]
        },
        "mensajesLibres": [
            {
                "nombre": "NOMBRE-MENSAJE",
                "valor": ""
            }
        ]
    }
}
200 No existen datos

No existen datos

Body
Object
codigoRespuesta
string
Example:
15
mensajeRespuesta
string
Example:
NO EXISTEN DATOS
traza
string
Example:
W-B-E-S
monitoreo
string
Example:
96
400 Request inválido

Request inválido

Body
Object
codigoRespuesta
string
Example:
11
mensajeRespuesta
string
Example:
REQUEST INVÁLIDO
401 No autorizado

No autorizado

Body
Object
codigoRespuesta
string
Example:
13
mensajeRespuesta
string
Example:
NO AUTORIZADO
Validar Email
POST /v1/validarEmail

Este método nos permitirá validar si un email es correcto y activo

Request body

Examples

Ejemplo de request de validar email

{
    "email": "jcamacho@vendemas.niubiz.com.pe"
}

Responses

200 OK
Body
Examples

Ejemplo de respuesta de validar email

{
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "datos": {
        "email": "carlos.dls.1992@gmail.com",
        "verdict": "Valid",
        "score": 0.93902,
        "local": "carlos.dls.1992",
        "host": "gmail.com",
        "checks": {
            "domain": {
                "has_valid_address_syntax": true,
                "has_mx_or_a_record": true,
                "is_suspected_disposable_address": false
            },
            "local_part": {
                "is_suspected_role_address": false
            },
            "additional": {
                "has_known_bounces": false,
                "has_suspected_bounces": false
            }
        },
        "ip_address": "190.237.163.234"
    }
}
401 Unauthorized

No autorizado

Body
Object
codigoRespuesta
string
Example:
13
mensajeRespuesta
string
Example:
NO AUTORIZADO
400 EMAIL NO VÁLIDO
Body
Object
Examples

Ejemplo de Email no válido

{
    "codigoRespuesta": "30",
    "mensajeRespuesta": "EMAIL NO VÁLIDO",
    "datos": {
        "email": "carlos.dls.1992",
        "verdict": "Invalid",
        "score": 0,
        "checks": {
            "domain": {
                "has_valid_address_syntax": false,
                "has_mx_or_a_record": false,
                "is_suspected_disposable_address": false
            },
            "local_part": {
                "is_suspected_role_address": false
            },
            "additional": {
                "has_known_bounces": false,
                "has_suspected_bounces": false
            }
        },
        "ip_address": "190.237.163.234"
    }
}
Informacion Persona
POST /v1/informacion/persona

Este método nos permitirá obtener la información de una persona

Request body

Examples

Ejemplo con DNI

{
    "tipoDocumento": "1",
    "nroDocumento": "12345678"
}

Responses

200 OK

Respuesta HTTP correcta

Body
Examples

Ejemplo DNI encontrado

{
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "traza": "B-W-D",
    "datos": {
        "apellidoPaterno": "ROJAS",
        "apellidoMaterno": "LOPEZ",
        "nombres": "JOSE",
        "nroDocumento": "12345678"
    }
}

Ejemplo en listas negras

{
    "codigoRespuesta": "19",
    "mensajeRespuesta": "DOCUMENTO NO PERMITIDO POR POLITICAS INTERNAS",
    "traza":"B-W-D"
}

Ejemplo NO encontrado

{
    "codigoRespuesta": "15",
    "mensajeRespuesta": "DOCUMENTO NO ENCONTRADO",
    "traza":"B-W-D"
}
401 Unauthorized

Error de autorizacion por credenciales

Body
Examples

No autorizado

{
    "codigoRespuesta": "13",
    "mensajeRespuesta": "No autorizado"
}
Informacion Empresa
POST /v1/informacion/empresa

Este método nos permitirá obtener la información de una empresa

Request body

Examples

Ejemplo con DNI

{
    "ruc": "10123456781",
    "tipoDocumento": "1",
    "nroDocumento": "12345678"
}

Ejemplo con CE

{
    "ruc": "20123456781",
    "tipoDocumento": "2",
    "nroDocumento": "012345678"
}

Responses

200 OK
Body
Examples

Ejemplo consulta correcta con datos

{
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "traza":"B-W-D",
    "datos":{
        "razonSocial": "FARMACIA SAC",
        "ruc":"20123456781",
        "representanteLegal": {
            "apellidoPaterno": "ROJAS",
            "apellidoMaterno": "LOPEZ",
            "nombres": "JOSE",
            "nroDocumento": "12345678"
        }
    }
}

Ejemplo listas negras

{
    "codigoRespuesta": "19",
    "mensajeRespuesta": "DOCUMENTOS NO PERMITIDOS POR POLITICAS INTERNAS",
    "traza":"B-W-D"
}

Ejemplo RUC no encontrado

{
    "codigoRespuesta": "14",
    "mensajeRespuesta": "RUC NO ENCONTRADO",
    "traza":"B-W-D"
}

Ejemplo DNI no encontrado

{
    "codigoRespuesta": "15",
    "mensajeRespuesta": "DOCUMENTO NO ENCONTRADO",
    "traza":"B-W-D"
}
401 Unauthorized
Body
Examples

Ejemplo NO autorizado

{
    "codigoRespuesta": "13",
    "mensajeRespuesta": "NO AUTORIZADO"
}
Estructuras de Entrada y Salida
Validar Persona

Estructuras de entrada y salida para Validar Persona

Validar Persona Request

Estructura de la petición para validar persona

Object
tipoDocumento
string required

El tipo de documento a validar

Enumeration:
1

DNI

2

RUC

3

CARNET DE EXTRANJERIA

4

PASAPORTE

nroDocumento
string required

El número de documento a validar

Example:
45111111
email
string

Correo electrónico de la persona que requiere afiliarse

Example:
correo@gmail.com
telefono
string

Teléfono celular de la persona que requiere afiliarse

Example:
987654321

Examples

{
    "tipoDocumento": "1",
    "nroDocumento": "45111111",
    "email": "correo@gmail.com",
    "telefono": "987654321"
}
{
    "tipoDocumento": "4",
    "nroDocumento": "45111111"
}
Validar Persona Response

Estructura de salida de la respuesta de Validar Persona

Object
codigoRespuesta
string

Código interno del tipo de respuesta

Enumeration:
00

Consulta exitosa, con datos

10

Error interno del servidor

11

Petición con formato incorrecto

12

Token de seguridad inválido

13

Token de seguridad no autorizado para este servicio

15

Consulta exitosa, pero no existen datos

16

El documento es de un menor de edad

17

El tipoDocumento del request no es válido

19

El documento de identidad está en listas negras

mensajeRespuesta
string

Descripcion de la respuesta

Example:
EXITO
monitoreo
string

Tipo de monitoreo con el que deberá registrarse el comercio (en el caso de 96, es solo como informativo ya que no se haria un registro del comercio)

Enumeration:
00

Validado

96

Rechazado (solo cuando codigoRespuesta sea diferente de 00)

98

Pendiente

validaciones
Object

Indicadores para acciones a realizar por monitoreo

flagNroDocumento
integer
Enumeration:
0

No es necesario que se valide por monitoreo

1

Se tiene que validar por monitoreo

flagCtaBancaria
integer
Enumeration:
0

No es necesario que se valide por monitoreo

1

Se tiene que validar por monitoreo

flagRubro
integer
Enumeration:
0

No es necesario que se valide por monitoreo

1

Se tiene que validar por monitoreo

indicacionValidacion
string

Texto descriptivo de las acciones a realizar por monitoreo

Example:
Validar DNI/CE contra Reniec/Migraciones ,Validar Cuenta Bancaria ,Validar Rubro
traza
string

Trazabilidad interna de los servicios por los que se ha validado, es un dato de control

Enumeration:
E

Experian

E-S

Experian-Sentinel

mensajeFront
string

Aparece cuando codigoRespuesta es diferente de 00, es el mensaje de error a mostrar en el front respectivo

Example:
Afiliación no permitida por políticas internas
datos
Object

Datos de la persona devuelto por el proveedor interno, son datos de control, se mostrará un valor en este campo cuando el “codigoRespuesta” sea 00

Examples:
{
    "Resultado": {
        "Documento": "46846255",
        "RazonSocial": "DE LOS SANTOS GARCIA CARLOS HUBI",
        "FechaProceso": "23/01/2021",
        "Semaforos": "RVVVVVVVVVVVVVVVVVVVVVVV",
        "Nota": "0.0000",
        "NroBancos": "5",
        "DeudaTotal": "10269.48",
        "VencidoBanco": "0.00",
        "Calificativo": "NOR 100% CPP   0% DEF   0% DUD   0% PER   0%",
        "SemaActual": "4",
        "SemaPrevio": "4",
        "SemaPeorMejor": "4",
        "Documento2": "10468462554",
        "EstDomic": "00",
        "CondDomic": "00",
        "DeudaTributaria": "0.00",
        "DeudaLaboral": "0.00",
        "DeudaImpaga": "0.00",
        "DeudaProtestos": "0.00",
        "DeudaSBS": "10269.48",
        "TarCtas": "0",
        "RepNeg": "0",
        "TipoActv": "CONSULTORES  PROG. Y SUMIN. INFORMATIC.",
        "FechIniActv": "27/11/2011",
        "DireccionFiscal": "CALLE SIN NOMBRE  MZA. A  LTE. 15 PUEBLO JOVEN LADERAS DE CHILLON PUENTE PIEDRA - LIMA - LIMA",
        "CodigoWS": "0"
    }
}
{
    "resultado": {
        "msgNumeroOperacion": "2021020916194121",
        "msgFechaHoraOperacion": "20210209 16:02:41",
        "msgEstadoConsulta": "13",
        "msgDescripcionConsulta": "La consulta fue efectiva",
        "respuesta": 200
    },
    "informacionConsultado": {
        "tipoPersona": "N",
        "tipoDocumento": "1",
        "numeroDocumento": "00046846255",
        "apellidoPaterno": "DE LOS SANTOS",
        "apellidoMaterno": "GARCIA",
        "nombres": "CARLOS HUBI",
        "fechaNacimiento": "19920314",
        "sexo": "MASCULINO",
        "estadoCivil": "SOLTERO",
        "estadoDNI": "VIGENTE",
        "domicilio": {
            "tipoDireccion": "",
            "direccion": "",
            "distrito": "",
            "provincia": "",
            "departamento": "",
            "ubigeo": ""
        }
    },
    "contribuyente": {},
    "mensajesLibres": [
        {
            "nombre": "NOMBRE-MENSAJE",
            "valor": ""
        }
    ]
}
Validar Empresa

Estructuras de entrada y salida para validar empresa

Validar Empresa Request

Estructura de la petición para validar empresa

Object
ruc
string required

El RUC de la empresa a validar

Example:
10123456784
tipoDocumento
string required

El tipo de documento a validar del representante legal

Enumeration:
1

DNI

2

RUC

3

CARNET DE EXTRANJERIA

4

PASAPORTE

nroDocumento
string required

El número de documento a validar del representante legal

Example:
12345678
email
string

Correo de la persona que requiere afiliar a su empresa

Example:
correo@gmail.com
telefono
string

Teléfono celular de la persona que requiere afiliar a su empresa

Example:
987654321

Examples

{
    "ruc": "10123456784",
    "tipoDocumento": "1",
    "nroDocumento": "12345678",
    "email": "correo@gmail.com",
    "telefono": "987654321"
}
Validar Empresa Response

Estructura de salida de la respuesta de validar empresa

Object
codigoRespuesta
string

Código interno del tipo de respuesta

Enumeration:
00

Consulta exitosa, con datos

10

Error interno del servidor

11

Petición con formato incorrecto

12

Token de seguridad inválido

13

Token de seguridad no autorizado para este servicio

15

Consulta exitosa, pero no existen datos de abonos

16

El documento es de un menor de edad

17

El tip documento del request no es válido

18

El ruc y el documento de identidad no corresponden a una empresa

19

El documento de identidad está en listas negras

20

El ruc está en listas negras

mensajeRespuesta
string

Descripcion de la respuesta

Example:
EXITO
monitoreo
string

Tipo de monitoreo con el que deberá registrarse el comercio

Enumeration:
00

Validado

96

Rechazado ( si el valor de codigoRespuesta es diferente a 00 )

98

Pendiente

traza
string

Trazabilidad interna de los servicios por los que se ha validado

Enumeration:
E

Experian

E-S-B

Experian-Sentinel-Listas Negras

validaciones
Object

Indicadores de las validaciones a realizar por monitore

flagNroDocumento
integer
Enumeration:
0

No es necesario que se valide por monitoreo

1

Se tiene que validar por monitoreo

flagRuc
string
Enumeration:
0

No es necesario que se valide por monitoreo

1

Se tiene que validar por monitoreo

flagCtaBancaria
string
Enumeration:
0

No es necesario que se valide por monitoreo

1

Se tiene que validar por monitoreo

flagRubro
string
Enumeration:
0

No es necesario que se valide por monitoreo

1

Se tiene que validar por monitoreo

indicacionValidacion
string

Texto descriptivo de las acciones a realizar por monitoreo

Example:
Validar Cuenta Bancaria ,Validar Rubro
actividadEconomica
string

Actividad económica a la que se dedica la empresa

Example:
OTRAS ACTIVID.DE TIPO SERVICIO NCP
mensajeFront
string

Aparece cuando el codigo de respuesta es diferente a 00, es el texto a mostrar en el front respectivo

Example:
RUC no existe.
datos
Object

Datos de la empresa devuelto por el proveedor interno, son datos de control, se mostrará un valor en este campo cuando el “codigoRespuesta” sea 00

Examples:
{
    "Resultado": {
        "Documento": "10468462554",
        "RazonSocial": "DE LOS SANTOS GARCIA CARLOS HUBI",
        "FechaProceso": "31/01/2021",
        "Semaforos": "GGGGGGGGGGGGGGGGGGGGGGGG",
        "Nota": "0.0000",
        "NroBancos": "0",
        "DeudaTotal": "0.00",
        "VencidoBanco": "0.00",
        "Calificativo": "NOR   0% CPP   0% DEF   0% DUD   0% PER   0%",
        "SemaActual": "3",
        "SemaPrevio": "3",
        "SemaPeorMejor": "3",
        "Documento2": "46846255",
        "EstDomic": "00",
        "CondDomic": "00",
        "DeudaTributaria": "0.00",
        "DeudaLaboral": "0.00",
        "DeudaImpaga": "0.00",
        "DeudaProtestos": "0.00",
        "DeudaSBS": "0.00",
        "TarCtas": "0",
        "RepNeg": "0",
        "TipoActv": "CONSULTORES  PROG. Y SUMIN. INFORMATIC.",
        "FechIniActv": "27/11/2011",
        "DireccionFiscal": "CALLE SIN NOMBRE  MZA. A  LTE. 15 PUEBLO JOVEN LADERAS DE CHILLON PUENTE PIEDRA - LIMA - LIMA",
        "CodigoWS": "0"
    }
}
{
    "resultado": {
        "msgNumeroOperacion": "2021020916194121",
        "msgFechaHoraOperacion": "20210209 16:02:41",
        "msgEstadoConsulta": "13",
        "msgDescripcionConsulta": "La consulta fue efectiva",
        "respuesta": 200
    },
    "informacionConsultado": {
        "tipoPersona": "N",
        "tipoDocumento": "1",
        "numeroDocumento": "00046846255",
        "apellidoPaterno": "DE LOS SANTOS",
        "apellidoMaterno": "GARCIA",
        "nombres": "CARLOS HUBI",
        "fechaNacimiento": "19920314",
        "sexo": "MASCULINO",
        "estadoCivil": "SOLTERO",
        "estadoDNI": "VIGENTE",
        "domicilio": {
            "tipoDireccion": "",
            "direccion": "",
            "distrito": "",
            "provincia": "",
            "departamento": "",
            "ubigeo": ""
        }
    },
    "contribuyente": {},
    "mensajesLibres": [
        {
            "nombre": "NOMBRE-MENSAJE",
            "valor": ""
        }
    ]
}
Validar Email
Validar Email Request

Estructura de la petición para validar email

Object
email
string required

Correo electronico a validar

Example:
jcamacho@vendemas.niubiz.com.pe
Validar Email Response

Estructura de salida de la respuesta de validar email

Object
codigoRespuesta
string

Código de respuesta de la validación

Enumeration:
00

Correcto

11

Peticion con formato incorrecto

30

Email no valido

mensajeRespuesta
string

Mensaje de respuesta de la validación

Example:
EXITO
datos
Object

Metadata devuelta por el validador interno

Example:
{
        "email": "carlos.dls.1992@gmail.com",
        "verdict": "Valid",
        "score": 0.93902,
        "local": "carlos.dls.1992",
        "host": "gmail.com",
        "checks": {
            "domain": {
                "has_valid_address_syntax": true,
                "has_mx_or_a_record": true,
                "is_suspected_disposable_address": false
            },
            "local_part": {
                "is_suspected_role_address": false
            },
            "additional": {
                "has_known_bounces": false,
                "has_suspected_bounces": false
            }
        },
        "ip_address": "190.237.163.234"
    }
Informacion Persona
Informacion Persona Request

Estructura de entrada de peticion de informacion de persona

Object
tipoDocumento
string required

Tipo documento de la persona

Enumeration:
1

DNI: Documento Nacional de Identidad

2

CE: Carnet de extranjeria

nroDocumento
string required

Nro de documento a obtener la información

Max length: 12
Examples:
123456780123456789

Examples

Ejemplo con DNI

{
    "tipoDocumento": "1",
    "nroDocumento": "12345678"
}

Ejemplo con carnet de extranjeria

{
    "tipoDocumento": "2",
    "nroDocumento": "012345678"
}
Información Persona Response

Estructura de salida de la respuesta de “informacion persona”

Object
codigoRespuesta
string required

Identificador de la respuesta

Enumeration:
00

Consulta exitosa con datos

10

Error interno del servidor

11

Petición con formato incorrecto

12

Token de seguridad inválido

13

Token de seguridad no autorizado para este servicio

15

Consulta exitosa pero no existen datos

19

El documento está en listas negras

mensajeRespuesta
string nullable

Descripción de la respuesta a nivel técnico

Example:
Documento en listas negras
mensajeFront
string nullable

Descripción de la respuesta a nivel coloquial para usuario final. Solo se deberá mostrar en el front para los casos donde “codigoRespuesta” no sea “00”

Example:
Afiliación no permitida por políticas internas
traza
string nullable

Traza de control para validar hacia que entidades fue la api para buscar informacion (no es necesario que el partner trabaje esta clave)

Example:
B-W-D
datos
Object nullable

Datos de la persona

apellidoPaterno
string required

Apellido paterno

Example:
ROJAS
apellidoMaterno
string required

Apellido materno

Example:
LOPEZ
nombres
string required

Nombres de la persona

Example:
JUAN
nroDocumento
string required

Nro documento devuelto por la entidad de riesgos

Example:
12345678

Examples

Caso 00 - La consulta es correcta

{
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "mensajeFront": "Consulta exitosa, con datos",
    "traza": "B-W-D",
    "datos": {
        "apellidoPaterno": "ROJAS",
        "apellidoMaterno": "LOPEZ",
        "nombres": "JOSE",
        "nroDocumento": "12345678"
    }
}

Caso 12 - Caso donde el token ya no servirá

{
    "codigoRespuesta": "12",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO",
    "mensajeFront": "Ocurrió un error en nuestros sistemas, te pedimos por favor que intentes más tarde o comunícate al (01) 6149800"
}

Caso 15 - El DNI/CE no existe

{
    "codigoRespuesta": "15",
    "mensajeRespuesta": "NO EXISTEN DATOS",
    "mensajeFront": "DNI/CE no existe",
    "traza": "B-W-E"
}

Caso 19 - El DNI/CE está en listas negras

{
    "codigoRespuesta": "19",
    "mensajeRespuesta": "DOCUMENTO EN BLACKLIST",
    "mensajeFront": "Afiliación no permitida por políticas internas",
    "traza": "B"
}
Informacion Empresa
Informacion Empresa Request

Estructura de entrada de peticion de información de empresa

Object
ruc
string required

Identificador en SUNAT

Max length: 11
Examples:
2012345678110123456781
tipoDocumento
string required

Tipo de documento del representante legal

Enumeration:
1

DNI

2

CE

nroDocumento
string required

Nro de documento del representante legal

Max length: 12
Examples:
12345678012345678

Examples

Empresa con representante legal DNI

{
    "ruc": "20123456781",
    "tipoDocumento": "1",
    "nroDocumento": "012345678"
}

Empresa con representante legal CE

{
    "ruc": "20123456781",
    "tipoDocumento": "2",
    "nroDocumento": "012345678"
}
Informacion Empresa Response

Estructura de salida de la respuesta de “informacion empresa”

Object
codigoRespuesta
string required

Identificador de la respuesta

Enumeration:
00

Consulta exitosa con datos

10

Error interno del servidor

11

Petición con formato incorrecto

12

Token de seguridad inválido

13

Token de seguridad no autorizado para este servicio

14

Consulta exitosa pero no existen datos del RUC

15

Consulta exitosa pero no existen datos de la persona

18

El documento de identidad no corresponde a la empresa (no es un representante legal)

19

El dni/ce está en listas negras

20

El ruc está en listas negras

25

Consulta exitosa, pero no existen datos por error en parametros

mensajeRespuesta
string nullable

Descripción de la respuesta a nivel técnico

Examples:
EXITORuc en listas negras
mensajeFront
string nullable

Descripción de la respuesta a nivel coloquial para usuario final. Solo se deberá mostrar en el front para los casos donde “codigoRespuesta” no sea “00”

Example:
Afiliación no permitida por politicas internas
traza
string nullable

Traza de control para validar hacia que entidades fue la api para buscar informacion (no es necesario que el partner trabaje esta clave)

Example:
B-W-D
datos
Object nullable

Datos de la persona representante legal

razonSocial
string required

Razon social de la empresa en SUNAT

Example:
FARMACIA SAC
ruc
string required

RUC de la empresa devuelto por SUNAT

Example:
20512605611
representanteLegal
Object required

Datos del representante legal

apellidoPaterno
string required

Apellido paterno

Example:
ROJAS
apellidoMaterno
string required

Apellido materno

Example:
LOPEZ
nombres
string required

Nombres de la persona

Example:
JUAN
nroDocumento
string required

Nro documento devuelto por la entidad de riesgos

Example:
12345678

Examples

Caso 00 - Persona jurídica con RUC 20

{
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "mensajeFront": "Consulta exitosa, con datos",
    "traza": "B-W-D",
    "datos": {
        "razonSocial": "SOLUCIONES Y SERVICIOS INTEGRADOS S.A.C.",
        "ruc": "20602370497",
        "representanteLegal": {
            "apellidoPaterno": "CASTAÑEDA",
            "apellidoMaterno": "BARRETO",
            "nombres": "IVAN EDUARDO",
            "nroDocumento": "06447888"
        }
    }
}

Caso 00- Persona natural con RUC 10

{
    "codigoRespuesta": "00",
    "mensajeRespuesta": "EXITO",
    "mensajeFront": "Consulta exitosa, con datos",
    "traza": "B-W-D",
    "datos": {
        "razonSocial": "CAMACHO AYBAR JONATHAN RUBEN'S",
        "ruc": "10451473391",
        "representanteLegal": {
            "apellidoPaterno": "CAMACHO",
            "apellidoMaterno": "AYBAR",
            "nombres": "JONATHAN RUBEN S",
            "nroDocumento": "45147339"
        }
    }
}

Caso 12 - El token ya no sirve para la consulta

{
    "codigoRespuesta": "12",
    "mensajeRespuesta": "TOKEN INVÁLIDO O EXPIRADO",
    "mensajeFront": "Ocurrió un error en nuestros sistemas, te pedimos por favor que intentes más tarde o comunícate al (01) 6149800"
}

Caso 14- No existen datos del ruc

{
    "codigoRespuesta": "14",
    "mensajeRespuesta": "NO EXISTEN DATOS RUC",
    "mensajeFront": "RUC no existe",
    "traza": "B-W-SU-E"
}

Caso 15 - El RUC-20 si existe y es correcto, pero el DNI no

{
    "codigoRespuesta": "15",
    "mensajeRespuesta": "NO EXISTEN DATOS",
    "mensajeFront": "DNI/CE no existe",
    "traza": "B-W-D-E"
}

Caso 15- El RUC-10 si existe y es correcto, pero el DNI no

{
    "codigoRespuesta": "15",
    "mensajeRespuesta": "NO EXISTEN DATOS",
    "mensajeFront": "DNI/CE no existe",
    "traza": "B-W-D-E"
}

Caso 18 - El documento ingresado no es representante legal de la empresa

{
    "codigoRespuesta": "18",
    "mensajeRespuesta": "El documento no es representante legal",
    "mensajeFront": "El documento ingresado no corresponde al representante legal de la empresa",
    "traza": "B-W-D-E"
}

Caso 19 - RUC es correcto, pero el DNI/CE del rep-legal está en listas negras

{
    "codigoRespuesta": "19",
    "mensajeRespuesta": "DOCUMENTO EN BLACKLIST",
    "mensajeFront": "Afiliación no permitida por políticas internas",
    "traza": "B"
}

Caso 20 - RUC en listas negras

{
    "codigoRespuesta": "20",
    "mensajeRespuesta": "RUC EN BLACKLIST",
    "mensajeFront": "Afiliación no permitida por políticas internas",
    "traza": "B"
}