Documentacion Verify API documentation version v1
https://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.
post
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"
}
get
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"
]
}post
/company
Metodos de gestion de compañia.
get
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 Reniec Premium": "XX",
"Persona: Consulta Licencia": "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.
get
Listado de Personas
post
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: "PTP"
],
"Ecuador_types": [
101: "Cedula",
102: "Pasaporte"
]
},
"asocs": {
"type": "array",
"Peru_asocs": [
"reniec": "Reniec",
"reniecPremium": "Reniec Premium",
"license": "Brevete",
"penal": "Antecedentes Penales",
"judicial": "Antecedentes Judiciales",
"policial": "Antecedentes Policiales"
],
"Ecuador_asocs": [
"ecCedula": "Cedula",
"ecLicense": "Licencia",
"ecPenal": "Antecedentes Penales"
]
}
}
}
Example:
{
"document": "12345678",
"type": "1",
"asocs": [
"reniec",
"reniecPremium"
]
}
post
Registro con vehiculo asociado
post /person/registerWithVehicle
Registro con vehiculo asociado
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Body
Media type: application/json
Type: any
Media type: type
Type:
{
"properties": {
"plate: {
"type": "numeric",
"required": true,
},
"plateTypeAsoc": {
"type": "numeric",
"required": true,
"Peru_types": [
1001: "Vehiculo",
],
"Ecuador_types": [
1101: "Vehiculo"
]
},
"document": {
"type": "numeric",
"required": true,
},
"plateAsoc": {
"type": "boolean",
"options": [
1: Si,
0: No
]
},
"type": {
"type": "numeric",
"required": true,
"Peru_types": [
1: "DNI",
2: "CE",
3: "PTP"
],
"Ecuador_types": [
101: "Cedula",
102: "Pasaporte"
],
},
"province": {
"type": "string",
"required": "opcional"
},
"name": {
"type": string,
"required": "Opcional"
},
"last_name": {
"type": string,
"required": "Opcional"
},
"birthday": {
"type": string,
"format": "YYYY/MM/DD",
"required": "Opcional"
},
"birthplace": {
"type": numeric,
"required": "Opcional",
"birth_places": [
1: "Nacional",
2: "Extranjero"
]
},
"birthplaceTxt": {
"type": string,
"format": "XX",
"required": "Opcional"
},
"asocs": {
"type": "array",
"Peru_asocs": [
"reniec": "Consulta Reniec" ,
"reniecPremium": "Consulta Reniec Premium" ,
"rucData": "Consulta Datos Ruc",
"license": "Consulta Licencia" ,
"penal": "Consulta Antecedentes Penales" ,
"judicial": "Consulta Antecedentes Judiciales" ,
"policial": "Consulta Antecedentes Policiales" ,
"vehicleData": "Consulta Vehicular" ,
"soat": "Consulta Soat" ,
"ocapture": "Consulta Orden de Captura" ,
"inspect": "Consulta Revision Tecnica" ,
"atuData": "Consulta Atu" ,
],
"Ecuador_asocs": [
"ecCedula": "Consulta Cedula Ec",
"ecLicense": "Consulta Licencia Ec",
"ecVehicleData": "Consulta Vehicular",
"ecRevisionData" "Consulta Revision Tecnica"
]
}
}
}
Media type: example
Type:
{
"document": "XXXXXXX",
"type": 1,
"province": "xxxx",
"name": "XXXX XXX",
"last_name": "XXXXX XXXXX",
"plate": "AXXXXX",
"plateAsoc": "AXXXXX",
"birthday": "YYYY/MM/DD",
"birthPlace": X,
"birthPlaceTxt": "XXXX",
"asocs": [
"vehicleData",
"soatData"
]
}
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##"
}get
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##"
}get
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##"
}post
Este metodo solicita la informacion de un asoc
post /person/actionByDocument
Este metodo solicita la informacion de un asoc
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Body
Media type: application/json
Type:
{
"properties": {
"action": {
"type": "string|array",
"required": true,
"value": "asoc"
},
"document": {
"type": "string",
"required": true,
"value": "xxxxxxxx"
},
"asocs": {
"type": "array",
"Peru_asocs": [
"reniec": "Consulta Reniec" ,
"reniecPremium": "Consulta Reniec Premium" ,
"rucData": "Consulta Datos Ruc",
"license": "Consulta Licencia" ,
"penal": "Consulta Antecedentes Penales" ,
"judicial": "Consulta Antecedentes Judiciales" ,
"policial": "Consulta Antecedentes Policiales" ,
"vehicleData": "Consulta Vehicular" ,
"soat": "Consulta Soat" ,
"ocapture": "Consulta Orden de Captura" ,
"inspect": "Consulta Revision Tecnica" ,
"atuData": "Consulta Atu" ,
],
"Ecuador_asocs": [
"ecCedula": "Consulta Cedula Ec",
"ecLicense": "Consulta Licencia Ec",
"ecVehicleData": "Consulta Vehicular",
"ecRevisionData" "Consulta Revision Tecnica"
]
}
}
}
Example:
{
"action": "reniec",
"document": "xxxX##xx##xxxxx##"
}
ó
{
"action": ['reniec', 'reniecPremium'],
"document": "xxxX##xx##xxxxx##"
}
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##"
}post
Este metodo solicita la informacion de un asoc
post /person/actionById
Este metodo solicita la informacion de un asoc
Headers
- Authorization: required(string)
Bearer authentication header
Example:
Authorization: Bearer QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Body
Media type: application/json
Type:
{
"properties": {
"action": {
"type": "string|array",
"required": true,
"value": "asoc"
},
"id": {
"type": "string",
"required": true,
"value": "person._id"
},
"asocs": {
"type": "array",
"Peru_asocs": [
"reniec": "Consulta Reniec" ,
"reniecPremium": "Consulta Reniec Premium" ,
"rucData": "Consulta Datos Ruc",
"license": "Consulta Licencia" ,
"penal": "Consulta Antecedentes Penales" ,
"judicial": "Consulta Antecedentes Judiciales" ,
"policial": "Consulta Antecedentes Policiales" ,
"vehicleData": "Consulta Vehicular" ,
"soat": "Consulta Soat" ,
"ocapture": "Consulta Orden de Captura" ,
"inspect": "Consulta Revision Tecnica" ,
"atuData": "Consulta Atu" ,
],
"Ecuador_asocs": [
"ecCedula": "Consulta Cedula Ec",
"ecLicense": "Consulta Licencia Ec",
"ecVehicleData": "Consulta Vehicular",
"ecRevisionData" "Consulta Revision Tecnica"
]
}
}
}
Example:
{
"action": "reniec",
"id": "xxxX##xx##xxxxx##"
}
ó
{
"action": ['reniec', 'reniecPremium'],
"id": "xxxX##xx##xxxxx##"
}
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
get
Listado de Vehiculos
post
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"
]
}
get
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##"
}get
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"
}