Documentacion Verify API documentation version v1
https://tudom.verify.com.pe/api/{version}
- version: required(v1)
Bienvenido
Bienvenido Gracias por preferirnos. Esta documentacion le guiará para consumir el servicio API REST.
/auth
Metodos de gestion de usuario.
Metodo de Login
post /auth/login
Metodo de Login
Body
Media type: application/json
Type:
{
"properties": {
"email": {
"type": "string|email",
"required": true,
},
"password": {
"type": "string",
"required": true,
}
}
}
Example:
{
"email": "example@example.com",
"password": "xxxxxxxx"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"expires_at": "Fecha de Expiracion del Token" ,
"permissions": "array de permisos de usuario" ,
"token": "token de session" ,
"token_type": "tipo de token" ,
"user": "array de datos de usuario"
}
Datos de Usuario
get /auth/user
Datos de Usuario
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"id": 1,
"email": "admin@admin.com",
"permissions": [
"menu.users",
"create.users"
]
}/company
Metodos de gestion de compañia.
Fondos para consultas disponibles
get /company/founds
Fondos para consultas disponibles
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"Persona: Consulta Reniec": "XX",
"Persona: Consulta Licencia": "XX",
"Persona: Consulta SBS": "XX",
"Persona: Sunedu": "XX",
"Persona: Antecedentes Penales": "XX",
"Persona: Antecedentes Judiciales": "XX",
"Persona: Antecedentes Policiales": "XX",
"Persona: Consulta Cedula Ec": "XX",
"Persona: Consulta Licencia Ec": "XX",
"Ruc: Consulta Sunat": "XX",
"Vehiculo: Consulta Vehicular": "XX",
"Vehiculo: Consulta Soat": "XX",
"Vehiculo: Consulta Orden de Captura": "XX",
"Vehiculo: Consulta Revision Tecnica": "XX",
"Vehiculo: Consulta SAT": "XX"
}/person
Metodos para Personas.
Listado de Personas
Este metodo registra el documento y solicita las categorias seleccionadas
get /person
Listado de Personas
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Query Parameters
- page: (integer)
- rowsPerPage: (integer)
- sortBy: (string)
- descending: (boolean)
- filter: (string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"current_page": 1,
"data": [],
"first_page_url": "http://demo.localhost:8000/api/v1/person?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://demo.localhost:8000/api/v1/person?page=1",
"next_page_url": null,
"path": "http://demo.localhost:8000/api/v1/person",
"per_page": 25,
"prev_page_url": null,
"to": 5,
"total": 5
}post /person
Este metodo registra el documento y solicita las categorias seleccionadas
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Body
Media type: application/json
Type:
{
"properties": {
"document": {
"type": "numeric",
"required": true,
},
"type": {
"type": "numeric",
"required": true,
"Peru_types": [
1: "DNI",
2: "CE",
3: "CS",
4: "PTP"
],
"Ecuador_types": [
101: "Cedula",
102: "Pasaporte"
]
},
"asocs": {
"type": "array",
"Peru_asocs": [
"reniec": "Reniec",
"license": "Brevete",
"sunedu": "Sunedu",
"apenal": "Antecedentes Penales",
"ajudicial": "Antecedentes Judiciales",
"apolicial": "Antecedentes Policiales"
],
"Ecuador_asocs": [
"ecCedula": "Cedula",
"ecLicense": "Licencia",
"ecPenal": "Antecedentes Penales"
]
}
}
}
Example:
{
"document": "12345678"
"type": "1",
"asocs": [
"reniec",
"sunedu"
]
}
Datos de Usuario
get /person/detailsByDocument/{document}
Datos de Usuario
URI Parameters
- document: required(string)
Documento de la Persona
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"created_at": "xxxx-xx-xx xx:xx:xx",
"document": "xxxxxxxx",
"license": [],
"reniec": [],
"type": "x",
"updated_at": "xxxx-xx-xx xx:xx:xx",
"_id": "xxxX##xx##xxxxx##"
}Datos de Usuario
get /person/detailsById/{id}
Datos de Usuario
URI Parameters
- id: required(string)
Identificador de Persona
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"created_at": "xxxx-xx-xx xx:xx:xx",
"document": "xxxxxxxx",
"license": [],
"reniec": [],
"type": "x",
"updated_at": "xxxx-xx-xx xx:xx:xx",
"_id": "xxxX##xx##xxxxx##"
}/vehicle
Metodos para Vehiculos
Listado de Vehiculos
Este metodo registra la placa y solicita las categorias seleccionadas
get /vehicle
Listado de Vehiculos
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Query Parameters
- page: (integer)
- rowsPerPage: (integer)
- sortBy: (string)
- descending: (boolean)
- filter: (string)
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"current_page": 1,
"data": [],
"first_page_url": "http://demo.localhost:8000/api/v1/vehicle?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://demo.localhost:8000/api/v1/vehicle?page=1",
"next_page_url": null,
"path": "http://demo.localhost:8000/api/v1/vehicle",
"per_page": 25,
"prev_page_url": null,
"to": 5,
"total": 5
}post /vehicle
Este metodo registra la placa y solicita las categorias seleccionadas
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Body
Media type: application/json
Type:
{
"properties": {
"plate: {
"type": "numeric",
"required": true,
},
"type": {
"type": "numeric",
"required": true,
"Peru_types": [
1001: "Vehiculo",
],
"Ecuador_types": [
1101: "Vehiculo"
]
},
"asocs": {
"type": "array",
"Peru_asocs": [
"vehicleData": "Datos de Vehiculo",
"soatData": "Datos de Soat",
"revisionData": "Datos de Revision Tecnica",
"ocaptureData": "Datos de Orden de captura",
"setameData": "Datos de SETAME",
],
"Ecuador_asocs": [
"ecVehicleData": "Datos de Vehiculo"
]
}
}
}
Example:
{
"plate": "AXXXXX"
"type": "1001",
"asocs": [
"vehicleData",
"soatData"
]
}
Datos de Vehiculo
get /vehicle/detailsByPlate/{plate}
Datos de Vehiculo
URI Parameters
- plate: required(string)
Placa del vehiculo
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"created_at": "xxxx-xx-xx xx:xx:xx",
"document": "xxxxxxxx",
"license": [],
"reniec": [],
"type": "x",
"updated_at": "xxxx-xx-xx xx:xx:xx",
"_id": "xxxX##xx##xxxxx##"
}Datos del Vehiculo
get /vehicle/detailsById/{id}
Datos del Vehiculo
URI Parameters
- id: required(string)
Identificador del vehiculo
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"created_at": "xxxx-xx-xx xx:xx:xx",
"inspect": [],
"ocapture": [],
"plate": "XXXXXX",
"soat": [],
"vehicle": [],
"_id": "xxxx##xx#xxx##xx"
}/reniec
Metodos para Reniec
Este metodo retorna resultado del match
post /reniec/match
Este metodo retorna resultado del match
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Body
Media type: application/json
Type: any
Example:
{
"documento": "12345678"
"tipo": "1"
"nombres": "nombres verificar"
"apellidos": "apellidos verificar"
}
Este metodo retorna el dato del dni consultado y el resultado del match
post /reniec/matchData
Este metodo retorna el dato del dni consultado y el resultado del match
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Body
Media type: application/json
Type: any
Example:
{
"documento": "12345678"
"tipo": "1"
"nombres": "nombres verificar"
"apellidos": "apellidos verificar"
}
HTTP status code 200
Body
Media type: application/json
Type: any
Example:
{
"match": true,
"data": {
"Apellidos": "APELLIDO1 APELLIDO2",
"Codigo de Verificacion": "X",
"DNI": "12345678",
"Fecha de Nacimiento": "XX/XX/XXXX",
"Genero": "XXXXXXXX",
"Nombres": "NOMBRE1 NOMBRE2"
}
}