SDK Web ReconoSER ID (1.0.0)

Download OpenAPI specification:Download

Contacto de Soporte: gestion@reconoserid.com URL: https://reconoserid.com/ License: MIT Terms of Service

Esta es la documentación web del SDK de ReconoSER ID. Puedes realizar las peticiones con las credenciales otorgadas en el Sandbox. Para estos ejemplos, debes usar la api key Bearer TOKEN para los filtros de autorización.

Introducción

El Objetivo de esta documentación, es mostrar los métodos y puntos de acceso para el SDK web de ReconoSER ID. Esta documentación contiene información que permite a los desarrolladores explorar las diferentes soluciones que tiene el SDK web.

Cross-Origin Uso Compartido entre Orígenes

Esta API presenta Intercambio de recursos de origen cruzado (CORS) implementado de acuerdo con la especificación W3C. Y eso permite la comunicación entre dominios desde el navegador. Todas las respuestas tienen un comodín del mismo origen que las hace completamente públicas y accesibles para todos, incluido cualquier código en cualquier sitio.

Authorization

ReconoSER ID ofrece dos formas de autenticación.

TOKEN
guidConv guidConv - Es un gruid otorgado a cada cliente con los servicios que puede acceder. Este convenio lo provee ReconoSER ID.

Bearer

Debe proporcionar el JWT obtenido con el método 'traerToken' y agregarlo en la cabecera Authorization.

Security Scheme Type	API Key
Header parameter name:	Authorization

Token

Método para generar token de autenticación.

Traer JWT Token

Servicio que permite obtener un token que permite consumir los demás métodos del SDK Web.

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

datos para traer token ServicesAPI.DTOs.Token.ClientCredentials

clientId	string Id del cliente otorgado por ReconoSER ID.
clientSecret	string Clave secreta del cliente otorgada por ReconoSER ID.

Responses

Request samples

Payload

Content type


{"clientId": "string",
"clientSecret": "string"
}

Traer JWT Token de usuario con rol

POST { "Username ": "client", "Password ": "secretPass", }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

datos para traer token ServicesAPI.DTOs.Token.LogInViewModel

userName required	string [ 2 .. 100 ] characters Nullable
password required	string <password> [ 6 .. 100 ] characters Nullable

Responses

Request samples

Payload

Content type


{"userName": "string",
"password": "pa$$word"
}

Refresca el token de acceso mediante un Refresh Token

Authorizations:

Bearer

query Parameters

refreshToken

string

token de refresco

header Parameters

x-api-version

string

Responses

Validacion

API para SDK Web que permite generar y consultar validaciones a un ciudadano.

Genera o actualiza una solicitud de validación

POST { "guidConv": "44221A55-EFCD-4431-85BF-57017554A318", "tipoValidacion": "1", "asesor": "asesorT", "sede": "000100", "codigoCliente": "00000124", "tipoDoc": "CC", "numDoc": "1031158460", "email": "test@domain.com", "celular": "3112568978", "usuario": "username", "clave": "clave" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to create new DatosRespuestaValidacion ServicesAPI.DTOs.Validacion.DatosEntradaValidacion

guidConv	string <uuid>
tipoValidacion	integer <int32>
asesor	string Nullable
sede	string Nullable
codigoCliente	string Nullable
tipoDoc	string Nullable
numDoc	string Nullable
email	string Nullable
celular	string Nullable
usuario	string Nullable
clave	string Nullable
infCandidato	string Nullable

Responses

Request samples

Payload

Content type


{"guidConv": "ea73044f-e022-4736-a8f0-b1a1b7c33e07",
"tipoValidacion": 0,
"asesor": "string",
"sede": "string",
"codigoCliente": "string",
"tipoDoc": "string",
"numDoc": "string",
"email": "string",
"celular": "string",
"usuario": "string",
"clave": "string",
"infCandidato": "string"
}

Response samples

200

Content type


{"code": 0,
"data": 
{"procesoConvenioGuid": "string",
"url": "string"
},
"codeName": "string"
}

Genera o actualiza una solicitud de validación

POST { "guidConv": "44221A55-EFCD-4431-85BF-57017554A318", "tipoValidacion": "1", "asesor": "asesorT", "sede": "000100", "codigoCliente": "00000124", "tipoDoc": "CC", "numDoc": "1031158460", "email": "test@domain.com", "celular": "3112568978", "usuario": "username", "clave": "clave", "primerNombre": "Juan", "segundoNombre": "Andres", "primerApellido": "Sandoval", "segundoApellido": "Ramos" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to create new DatosRespuestaValidacion ServicesAPI.DTOs.Validacion.DatosEntradaValidacionZoom

primerNombre	string Nullable
segundoNombre	string Nullable
primerApellido	string Nullable
segundoApellido	string Nullable
guidConv	string <uuid>
tipoValidacion	integer <int32>
asesor	string Nullable
sede	string Nullable
codigoCliente	string Nullable
tipoDoc	string Nullable
numDoc	string Nullable
email	string Nullable
celular	string Nullable
usuario	string Nullable
clave	string Nullable
infCandidato	string Nullable

Responses

Request samples

Payload

Content type


{"primerNombre": "string",
"segundoNombre": "string",
"primerApellido": "string",
"segundoApellido": "string",
"guidConv": "ea73044f-e022-4736-a8f0-b1a1b7c33e07",
"tipoValidacion": 0,
"asesor": "string",
"sede": "string",
"codigoCliente": "string",
"tipoDoc": "string",
"numDoc": "string",
"email": "string",
"celular": "string",
"usuario": "string",
"clave": "string",
"infCandidato": "string"
}

Response samples

200

Content type


{"code": 0,
"data": 
{"procesoConvenioGuid": "string",
"url": "string"
},
"codeName": "string"
}

Consulta una solicitud de validación

POST { "guidConv": "dc5ada78-c694-40f3-a2b5-439d8db93247", "procesoConvenioGuid": "dc5ada78-c694-40f3-a2b5-439d8db93247", "codigoCliente": "000100", "usuario": "asesor1", "clave": "12345" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

filtro para la búsqueda de los datos

guidConv	string Nullable
procesoConvenioGuid	string <uuid> Nullable
codigoCliente	string Nullable
usuario	string Nullable
clave	string Nullable

Responses

Request samples

Payload

Content type


{"guidConv": "string",
"procesoConvenioGuid": "b9eec147-4298-42bf-8da5-eb9f279ad74c",
"codigoCliente": "string",
"usuario": "string",
"clave": "string"
}

Response samples

200

Content type


{"code": 0,
"data": 
{"guidConv": "string",
"procesoConvenioGuid": "string",
"primerNombre": "string",
"segundoNombre": "string",
"primerApellido": "string",
"segundoApellido": "string",
"tipoDoc": "string",
"numDoc": "string",
"email": "string",
"celular": "string",
"asesor": "string",
"sede": "string",
"nombreSede": "string",
"codigoCliente": "string",
"estadoProceso": 0,
"scoreProceso": 0,
"aprobado": true,
"cancelado": true,
"motivoCancelacion": "string",
"finalizado": true,
"encontradoEnFuente": true,
"fuentesAbiertas": { },
"fechaRegistro": "2019-08-24T14:15:22Z",
"fechaFinalizacion": "2019-08-24T14:15:22Z",
"servicios": 
[
{"servicio": "string",
"tipo": "string",
"subTipos": "string",
"score": 0,
"barcode": 
{"numDoc": "string",
"tipoDoc": "string",
"primerNombre": "string",
"segundoNombre": "string",
"primerApellido": "string",
"segundoApellido": "string",
"sexo": "string",
"rh": "string",
"fechaNacimiento": "2019-08-24T14:15:22Z",
"fechaExpedicion": "2019-08-24T14:15:22Z"
},
"fecha": "2019-08-24T14:15:22Z",
"terminado": true
}
]
},
"codeName": "string"
}

Ejecuta la comparación de dos rostros

POST CompararRostros { "rostro1": "/9j/4AAQSkZJRgABAQEBLAEsAAD/...", "formato1": "PNG_B64", "rostro2": "/9j/4AAQSkZJGFAFUEEMGAEsADFG...", "formato2": "PNG_B64" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

guidConvenio	string <uuid>
rostro1	string Nullable
formato1	string Nullable
rostro2	string Nullable
formato2	string Nullable

Responses

Request samples

Payload

Content type


{"guidConvenio": "b282af6b-1709-47c2-8987-84efbf5f7b72",
"rostro1": "string",
"formato1": "string",
"rostro2": "string",
"formato2": "string"
}

Response samples

200

Content type


{"data": 
{"esValido": true,
"resultado": "OK",
"score": 0,
"provider": 0
},
"code": 0,
"codeName": "string"
}

Manda una notificación mail si el proceso ha terminado

POST CompararRostros { "procesoGuid": "20124c19-a5e2-4057-b805-0c4a2eabed7e", }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

procesoGuid

string <uuid>

Responses

Request samples

Payload

Content type


{"procesoGuid": "673f4a0f-9502-43ec-a228-af600c590202"
}

Response samples

200

Content type


{"code": 0,
"data": 
{"enviado": true,
"mensajeError": "string"
},
"codeName": "string"
}

ANI

Consultas a la ANI.

Modelo de fuente.

codigo	string Nullable
nombre	string Nullable
mensaje	string Nullable
riesgo	boolean
score	integer <int32>


{"codigo": "string",
"nombre": "string",
"mensaje": "string",
"riesgo": true,
"score": 0
}

Endpoint para consultar usuario en fuente

POST { "CodigoPais": "57", "NumDocumento": "1032473321", "TipoDocumento": "CC" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to search Domain.Models.Fuente.ConsultaFuenteEntry

tipoDocumento	string Nullable
numDocumento	string Nullable
codigoPais	string Nullable
guidConvenio	string <uuid>

Responses

Request samples

Payload

Content type


{"tipoDocumento": "string",
"numDocumento": "string",
"codigoPais": "string",
"guidConvenio": "b282af6b-1709-47c2-8987-84efbf5f7b72"
}

Response samples

200

Content type


{"code": 0,
"data": 
{"existe": true,
"listaImagenes": 
[
{"fecha": "string",
"fuente": "string"
}
]
},
"codeName": "string"
}

Endpoint para validar usuario en fuente

POST { "CodigoPais": "57", "NumDocumento": "1032473321", "TipoDocumento": "CC", "Imagen": "dsaddsadsdaf", "Formato": "PNG_B64" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to validate user Domain.Models.Fuente.ValidarFuenteEntry

guidConvenio	string <uuid>
tipoDocumento	string Nullable
numDocumento	string Nullable
codigoPais	string Nullable
imagen	string Nullable
formato	string Nullable

Responses

Request samples

Payload

Content type


{"guidConvenio": "b282af6b-1709-47c2-8987-84efbf5f7b72",
"tipoDocumento": "string",
"numDocumento": "string",
"codigoPais": "string",
"imagen": "string",
"formato": "string"
}

Response samples

200

Content type


{"data": { },
"code": 0,
"codeName": "string"
}

Endpoint para validar usuario en ANI y fuente

POST { "CodigoPais": "57", "NumDocumento": "1032473321", "TipoDocumento": "CC", "Imagen": "dsaddsadsdaf", "Formato": "PNG_B64" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to validate user Domain.Models.Fuente.ValidarFuenteEntry

guidConvenio	string <uuid>
tipoDocumento	string Nullable
numDocumento	string Nullable
codigoPais	string Nullable
imagen	string Nullable
formato	string Nullable

Responses

Request samples

Payload

Content type


{"guidConvenio": "b282af6b-1709-47c2-8987-84efbf5f7b72",
"tipoDocumento": "string",
"numDocumento": "string",
"codigoPais": "string",
"imagen": "string",
"formato": "string"
}

Response samples

200

Content type


{"data": { },
"code": 0,
"codeName": "string"
}

Admin

API Administrativa de los procesos creados por cada cliente.

Get a list of Processes

The list is paginated

Authorizations:

Bearer

query Parameters

NumDoc	string
TipoDoc	string
Estado	integer <int32>
Finalizado	boolean
Cancelado	boolean
FechaCreacion	string <date-time>
FechaFinalizado	string <date-time>
PageSize	integer <int32>
PageNumber	integer <int32>

header Parameters

x-api-version

string

Responses

Response samples

200

Content type


{"data": 
{"processesList": 
[
{"procesoGuid": "673f4a0f-9502-43ec-a228-af600c590202",
"nombreConvenio": "string",
"tipoDoc": "string",
"numDoc": "string",
"tipoProceso": 0,
"finalizado": true,
"cancelado": true,
"fechaCreado": "string"
}
],
"totalPages": 0
},
"code": 0,
"codeName": "string"
}

Get images for specific process

Returns image base64 string

Authorizations:

Bearer

query Parameters

procesoGuid

string <uuid>

header Parameters

x-api-version

string

Responses

Response samples

200

Content type


{"data": 
{"detalle": 
{"procesoGuid": "673f4a0f-9502-43ec-a228-af600c590202",
"pais": "string",
"estado": 0,
"tipoDocumento": "string",
"tipo": "string",
"numeroDocumento": "string",
"nombreCompleto": "string",
"fechaCreacion": "2019-08-24T14:15:22Z"
},
"facial": 
{"rostro": "string",
"fechaDeCaptura": "2019-08-24T14:15:22Z",
"score": "string",
"reintentos": 0,
"datosAdi": "string",
"formato": "string",
"centralFacial": 
{"existe": true,
"match": true
},
"esValido": true
},
"documento": 
[
{"tipo": "string",
"foto": "string",
"fechaDeCaptura": "2019-08-24T14:15:22Z",
"reintentos": 0,
"formato": "string"
}
],
"otp": 
[
{"tipo": "string",
"codigo": "string",
"validado": true,
"fechaValidado": "2019-08-24T14:15:22Z",
"fechaCreado": "2019-08-24T14:15:22Z"
}
],
"psd": 
{"resultado": "string",
"score": "string",
"questionario": "string",
"fechaCreacion": "2019-08-24T14:15:22Z"
},
"fuentesAbiertas": 
{"estado": "string",
"fuentes": 
[
{"codigo": "string",
"nombre": "string",
"mensaje": "string",
"riesgo": true,
"score": 0
}
]
},
"centralFacial": 
{"existe": true,
"match": true
}
},
"code": 0,
"codeName": "string"
}

Gets all document types

Authorizations:

Bearer

header Parameters

x-api-version

string

Responses

Response samples

200

Content type


{"data": 
[
{"id": 0,
"pais": "string",
"tipo": "string",
"nombre": "string"
}
],
"code": 0,
"codeName": "string"
}

GetAllCountries

Authorizations:

Bearer

header Parameters

x-api-version

string

Responses

Response samples

200

Content type


{"data": 
[
{"id": 0,
"nombre": "string",
"codigo": "string"
}
],
"code": 0,
"codeName": "string"
}

Gets FuentesAbiertas Results

Authorizations:

Bearer

query Parameters

procesoGuid

string <uuid>

procesoGuid

header Parameters

x-api-version

string

Responses

Convenio

Consulta la información relacionada con el convenio.

Endpoint to get a Convenio by Guid

POST { "guidConv": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "datos": "string" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to create new Convenio ServicesAPI.DTOs.Convenio.SalidaConvenio

guidConv	string <uuid>
datos	string Nullable

Responses

Request samples

Payload

Content type


{"guidConv": "ea73044f-e022-4736-a8f0-b1a1b7c33e07",
"datos": "string"
}

Endpoint to get all sedes by GuidConvenio

POST { "guidConv": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "datos": "string" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to create new Convenio ServicesAPI.DTOs.Convenio.SalidaConvenio

guidConv

string <uuid>

Responses

Request samples

Payload

Content type


{"guidConv": "ea73044f-e022-4736-a8f0-b1a1b7c33e07"
}

Endpoint para crear convenio con sus respectivos servicios

POST { "ClienteId": 2, "NombreConvenio": "ConvenioTest", "NombreSede": "Guali", "NombreAsesor":"Lin Millan", "Login":"linapaolix", "Clave":"12345", "CorreoAsesor":"linap@gmail.com", "TelAsesor":"3123662899", "RolAsesorId":1,
"Servicios":[{"servicioId":5, "subtipoId":1,"orden":1},{"servicioId":6,"orden":2},{"servicioId":7, "subtipoId":2,"orden":3},{"servicioId":7, "subtipoId":3}], "Scores":[{"valorInicial":0.00, "valorFinal":20.00, "resultado":3},{"valorInicial":21.00, "valorFinal":80.00, "resultado":2},{"valorInicial":98.00, "valorFinal":100.00, "resultado":1}] }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to create new Convenio ServicesAPI.DTOs.Convenio.SalidaConvenio

clienteId	integer <int32>
nombreConvenio	string Nullable
nombreSede	string Nullable
nombreAsesor	string Nullable
login	string Nullable
clave	string Nullable
correoAsesor	string Nullable
telAsesor	string Nullable
rolAsesorId	integer <int32>
	Array of objects (ConvenioServicios) Nullable
	Array of objects (Scores) Nullable

Responses

Request samples

Payload

Content type


{"clienteId": 0,
"nombreConvenio": "string",
"nombreSede": "string",
"nombreAsesor": "string",
"login": "string",
"clave": "string",
"correoAsesor": "string",
"telAsesor": "string",
"rolAsesorId": 0,
"servicios": 
[
{"servicioId": 0,
"subtipoId": 0,
"orden": 0,
"claseServicio": 0
}
],
"scores": 
[
{"valorInicial": 0,
"valorFinal": 0,
"resultado": 0
}
]
}

Response samples

200

Content type


{"data": { },
"code": 0,
"codeName": "string"
}

CEA

API para los CRC.

Cliente

API para CRUD de clientes. (Uso interno de ReconoSER ID).

Endpoint to get a client by Id

Authorizations:

Bearer

path Parameters

clienteId

required

integer <int32>

header Parameters

x-api-version

string

Responses

Response samples

200
404
500

Content type


{"data": 
{"clienteId": 0,
"paisId": 0,
"nombre": "string",
"tipoDoc": "string",
"numeroDocumento": "string",
"correo": "string",
"telefono": "string",
"estado": true
},
"code": 0,
"codeName": "string"
}

Endpoint for update a client by id.

PATCH{ "clienteNombre": "Client one", "clienteNumDoc": "123456788", "clienteCorreo": "example@olimpia.com", "clienteTelefono": "3143303338", "clienteEstado" : "1" }

Authorizations:

Bearer

path Parameters

clienteId

required

integer <int64>

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

paisId	integer <int64>
nombre	string Nullable
tipoDoc	string Nullable
numeroDocumento	string Nullable
correo	string Nullable
telefono	string Nullable
estado	boolean Nullable

Responses

Request samples

Payload

Content type


{"paisId": 0,
"nombre": "string",
"tipoDoc": "string",
"numeroDocumento": "string",
"correo": "string",
"telefono": "string",
"estado": true
}

Response samples

200
400
404
500

Content type


{"data": 
{"clienteId": 0,
"paisId": 0,
"nombre": "string",
"tipoDoc": "string",
"numeroDocumento": "string",
"correo": "string",
"telefono": "string",
"estado": true
},
"code": 0,
"codeName": "string"
}

Delete a Client by id

Authorizations:

Bearer

path Parameters

clienteId

required

integer <int32>

header Parameters

x-api-version

string

Responses

Response samples

204
404
500

Content type


{"code": 0,
"codeName": "string"
}

Get a list of Clients

The list is paginated

Authorizations:

Bearer

query Parameters

Nombre	string The name of the client
Pais	string Country of the client
TipoDoc	string Document type
Estado	boolean Client status
PageSize	integer <int32>
PageNumber	integer <int32>

header Parameters

x-api-version

string

Responses

Response samples

200
500

Content type


{"data": 
[
{"clienteId": 0,
"paisId": 0,
"nombre": "string",
"tipoDoc": "string",
"numeroDocumento": "string",
"correo": "string",
"telefono": "string",
"estado": true
}
],
"code": 0,
"codeName": "string"
}

Endpoint to create a new client

POST { "clienteNombre": "Client one", "clienteNumDoc": "123456788", "clienteCorreo": "example@olimpia.com", "clienteTelefono": "3143303338" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to create new client ServicesAPI.DTOs.Client.ClientForCreation

paisId	integer <int64>
nombre	string Nullable
tipoDoc	string Nullable
numeroDocumento	string Nullable
correo	string Nullable
telefono	string Nullable

Responses

Request samples

Payload

Content type


{"paisId": 0,
"nombre": "string",
"tipoDoc": "string",
"numeroDocumento": "string",
"correo": "string",
"telefono": "string"
}

Response samples

201
400
500

Content type


{"data": 
{"clienteId": 0,
"paisId": 0,
"nombre": "string",
"tipoDoc": "string",
"numeroDocumento": "string",
"correo": "string",
"telefono": "string",
"estado": true
},
"code": 0,
"codeName": "string"
}

Forense

API ReconoSER Forense.

Get a list of forense transaction

The list is paginated

Authorizations:

Bearer

query Parameters

NumDoc	string
TipoDoc	string
NombreCliente	string
Usuario	string
Aprobada	boolean
Revisada	boolean
FechaRevision	string <date-time>
FechaRecepcion	string <date-time>
PageSize	integer <int32>
PageNumber	integer <int32>

header Parameters

x-api-version

string

Responses

Response samples

200

Content type


{"data": 
{"forenseList": 
[
{"id": 0,
"forenseGuid": "9919a72b-64f3-4836-ad09-12c6f3c6e671",
"tipoDoc": "string",
"numDoc": "string",
"nombreCliente": "string",
"aprobada": true,
"revisada": true,
"score": 0,
"motivoOpcionalId": 0,
"motivoPrincipalId": 0,
"descripcion": "string",
"fechaRecepcion": "2019-08-24T14:15:22Z",
"fechaRevision": "2019-08-24T14:15:22Z",
"tiempoRevision": 0,
"forenseDetail": 
[
{"objetoGuid": "67e9885f-d93d-4f0b-bbe0-5daecb2ddc2c",
"tipoObjeto": "string",
"objeto": "string",
"formatoObjeto": "string"
}
]
}
],
"totalPages": 0
},
"code": 0,
"codeName": "string"
}

Get detail for specific forensic transaction

Returns image base64 string

Authorizations:

Bearer

query Parameters

forenseGuid	string <uuid>
user	string

header Parameters

x-api-version

string

Responses

Response samples

200

Content type


{"data": { },
"code": 0,
"codeName": "string"
}

Gets all forensic motives

Authorizations:

Bearer

header Parameters

x-api-version

string

Responses

Response samples

200

Content type


{"data": 
[
{"id": 0,
"motivo": "string",
"descripcion": "string",
"aprobado": true,
"score": 0
}
],
"code": 0,
"codeName": "string"
}

Update forensic transaction

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

forenseGuid	string <uuid>
aprobada	boolean
score	integer <int32>
motivoPrincipalId	integer <int64>
motivoOpcionalId	integer <int64> Nullable
descripcion	string Nullable
fechaRevision	string <date-time> Nullable
usuario	string Nullable
tiempoRevision	integer <int64>

Responses

Request samples

Payload

Content type


{"forenseGuid": "9919a72b-64f3-4836-ad09-12c6f3c6e671",
"aprobada": true,
"score": 0,
"motivoPrincipalId": 0,
"motivoOpcionalId": 0,
"descripcion": "string",
"fechaRevision": "2019-08-24T14:15:22Z",
"usuario": "string",
"tiempoRevision": 0
}

Response samples

200

Content type


{"data": 
{"ejecuciónCorrecta": true,
"error": "string"
},
"code": 0,
"codeName": "string"
}

Gets the state of the forensic transaction and his veredict

Authorizations:

Bearer

query Parameters

TxGuid

string <uuid>

header Parameters

x-api-version

string

Responses

Response samples

200

Content type


{"data": 
{"txGuid": "039a377e-0095-4534-8a09-5e3f43802ffb",
"revisada": true,
"fechaRevision": "2019-08-24T14:15:22Z",
"aprobada": true,
"score": 0,
"motivoPrincipal": "string",
"motivoOpcional": "string",
"descripcion": "string"
},
"code": 0,
"codeName": "string"
}

Create a Forensic transaction

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

guidConvenio	string <uuid>
tipoDocumentoId	integer <int64>
numeroDocumento	string Nullable
	Array of objects (ObjetoForense) Nullable

Responses

Request samples

Payload

Content type


{"guidConvenio": "b282af6b-1709-47c2-8987-84efbf5f7b72",
"tipoDocumentoId": 0,
"numeroDocumento": "string",
"objetos": 
[
{"tipoObjeto": "string",
"objeto": "string",
"formatoObjeto": "string"
}
]
}

Response samples

200

Content type


{"data": 
{"txGuid": "039a377e-0095-4534-8a09-5e3f43802ffb"
},
"code": 0,
"codeName": "string"
}

Frees the forensic transaction so can be see by another user

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

forenseGuid	string <uuid>
user	string Nullable

Responses

Request samples

Payload

Content type


{"forenseGuid": "9919a72b-64f3-4836-ad09-12c6f3c6e671",
"user": "string"
}

Response samples

200

Content type


{"data": true,
"code": 0,
"codeName": "string"
}

HealtCheck

Revisa el estado de las API's.

IdentityUser

API para CRUD de Usuarios.

Register

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

userName required	string [ 2 .. 50 ] characters Nullable
firstName required	string [ 2 .. 50 ] characters Nullable
lastName required	string [ 2 .. 50 ] characters Nullable
company required	string [ 2 .. 50 ] characters Nullable
email required	string <email> Nullable
password required	string <password> [ 6 .. 100 ] characters Nullable
confirmPassword	string <password> Nullable
role required	string [ 4 .. 100 ] characters Nullable

Responses

Request samples

Payload

Content type


{"userName": "string",
"firstName": "string",
"lastName": "string",
"company": "string",
"email": "user@example.com",
"password": "pa$$word",
"confirmPassword": "pa$$word",
"role": "string"
}

Get

Authorizations:

Bearer

query Parameters

id

string

header Parameters

x-api-version

string

Responses

Response samples

404
500

Content type


{"data": 
{"mesage": "string",
"inner": "string",
"trace": 
[
{"name": "string",
"errors": 
["string"
]
}
]
},
"code": 0,
"codeName": "string"
}

Delete

Authorizations:

Bearer

query Parameters

userId

string

header Parameters

x-api-version

string

Responses

Response samples

204
404
500

Content type


{"code": 0,
"codeName": "string"
}

UpdateUser

Authorizations:

Bearer

query Parameters

userId

string

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

userName	string Nullable
email	string Nullable
firstName	string Nullable
lastName	string Nullable
company	string Nullable

Responses

Request samples

Payload

Content type


{"userName": "string",
"email": "string",
"firstName": "string",
"lastName": "string",
"company": "string"
}

GetUsers

Authorizations:

Bearer

query Parameters

Name	string Default: ""
Role	string Default: ""
PageNumber	integer <int32> Default: 1
PageSize	integer <int32> Default: 10

header Parameters

x-api-version

string

Responses

GetRoles

Authorizations:

Bearer

header Parameters

x-api-version

string

Responses

SAS

API para guardar y consultar los datos biométricos de un ciudadano.

Guardar Datos biométricos de ciudadano

POST { "GuidConv": "BFA3AB5F-BAEB-42DE-986E-0DA98F45F90F", "CodigoCliente": "0000012", "InfCandidado": null, "TipoDoc": "CC", "NumDoc": "1031158460", "Email": "", "Celular": "+57 3100100100", "IdServicio": "4", "SubTipo": "Anverso", "Valor": "/9j/4AAQSkZ/WignmP/2Q==...", "Formato": "PNG_B64", "Actualizar": 0 }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

datos para crear un nuevo registro de Biometria ServicesAPI.DTOs.SAS.DatosBio

guidConv	string <uuid>
codigoCliente	string Nullable
infCandidato	string Nullable
tipoDoc	string Nullable
numDoc	string Nullable
email	string Nullable
celular	string Nullable
idServicio	integer <int32>
subTipo	string Nullable
valor	string Nullable
formato	string Nullable
actualizar	boolean
datosAni	boolean

Responses

Request samples

Payload

Content type


{"guidConv": "ea73044f-e022-4736-a8f0-b1a1b7c33e07",
"codigoCliente": "string",
"infCandidato": "string",
"tipoDoc": "string",
"numDoc": "string",
"email": "string",
"celular": "string",
"idServicio": 0,
"subTipo": "string",
"valor": "string",
"formato": "string",
"actualizar": true,
"datosAni": true
}

Validar Biometría

POST { "GuidProcesoGuid": "9F719B0D-DD8C-443B-95F1-D759CCBBCD41", "TipoDoc": "CC", "NumDoc": "1031158460", "IdServicio": "4", "SubTipo": "Anverso", "Formato": "PNG_B64", "Biometria": "/9j/4AAQSkZ/WignmP/2Q==..." }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

datos para validar Biometria ServicesAPI.DTOs.SAS.DatosVal

guidConv	string <uuid>
procesoConvenioGuid	string <uuid> Nullable
tipoDoc	string Nullable
numDoc	string Nullable
idServicio	integer <int32>
subTipo	string Nullable
formato	string Nullable
biometria	string Nullable

Responses

Request samples

Payload

Content type


{"guidConv": "ea73044f-e022-4736-a8f0-b1a1b7c33e07",
"procesoConvenioGuid": "b9eec147-4298-42bf-8da5-eb9f279ad74c",
"tipoDoc": "string",
"numDoc": "string",
"idServicio": 0,
"subTipo": "string",
"formato": "string",
"biometria": "string"
}

Consultar Validación de Biometría

POST { "GuidProcesoGuid": "9F719B0D-DD8C-443B-95F1-D759CCBBCD41", "IdServicio": "4", "SubTipo": "Anverso" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

datos para consultar validación Biometría ServicesAPI.DTOs.SAS.DatosConVal

procesoConvenioGuid	string <uuid>
idServicio	integer <int32>
subTipo	string Nullable

Responses

Request samples

Payload

Content type


{"procesoConvenioGuid": "b9eec147-4298-42bf-8da5-eb9f279ad74c",
"idServicio": 0,
"subTipo": "string"
}

Consultar Biometría

POST { "GuidProcesoGuid": "9F719B0D-DD8C-443B-95F1-D759CCBBCD41", "IdServicio": "4", "SubTipo": "Anverso" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

datos para consultar Biometría ServicesAPI.DTOs.SAS.DatosConVal

procesoConvenioGuid	string <uuid>
idServicio	integer <int32>
subTipo	string Nullable

Responses

Request samples

Payload

Content type


{"procesoConvenioGuid": "b9eec147-4298-42bf-8da5-eb9f279ad74c",
"idServicio": 0,
"subTipo": "string"
}

Usuario

Método para retornar un usuario específico.

Get specific user

User contains country, company etc..

Authorizations:

Bearer

query Parameters

userName	string
Email	string

header Parameters

x-api-version

string

Responses

Response samples

200

Content type


{"data": 
{"nombre": "string",
"telefono": "string",
"sede": "string",
"convenioGuid": "aff1cd16-a48a-483e-941b-114ddfefb777",
"activo": true,
"cliente": "string"
},
"code": 0,
"codeName": "string"
}

Validacion

API para SDK Web que permite generar y consultar validaciones a un ciudadano.

Genera o actualiza una solicitud de validación

POST { "guidConv": "44221A55-EFCD-4431-85BF-57017554A318", "tipoValidacion": "1", "asesor": "asesorT", "sede": "000100", "codigoCliente": "00000124", "tipoDoc": "CC", "numDoc": "1031158460", "email": "test@domain.com", "celular": "3112568978", "usuario": "username", "clave": "clave" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to create new DatosRespuestaValidacion ServicesAPI.DTOs.Validacion.DatosEntradaValidacion

guidConv	string <uuid>
tipoValidacion	integer <int32>
asesor	string Nullable
sede	string Nullable
codigoCliente	string Nullable
tipoDoc	string Nullable
numDoc	string Nullable
email	string Nullable
celular	string Nullable
usuario	string Nullable
clave	string Nullable
infCandidato	string Nullable

Responses

Request samples

Payload

Content type


{"guidConv": "ea73044f-e022-4736-a8f0-b1a1b7c33e07",
"tipoValidacion": 0,
"asesor": "string",
"sede": "string",
"codigoCliente": "string",
"tipoDoc": "string",
"numDoc": "string",
"email": "string",
"celular": "string",
"usuario": "string",
"clave": "string",
"infCandidato": "string"
}

Response samples

200

Content type


{"code": 0,
"data": 
{"procesoConvenioGuid": "string",
"url": "string"
},
"codeName": "string"
}

Genera o actualiza una solicitud de validación

POST { "guidConv": "44221A55-EFCD-4431-85BF-57017554A318", "tipoValidacion": "1", "asesor": "asesorT", "sede": "000100", "codigoCliente": "00000124", "tipoDoc": "CC", "numDoc": "1031158460", "email": "test@domain.com", "celular": "3112568978", "usuario": "username", "clave": "clave", "primerNombre": "Juan", "segundoNombre": "Andres", "primerApellido": "Sandoval", "segundoApellido": "Ramos" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to create new DatosRespuestaValidacion ServicesAPI.DTOs.Validacion.DatosEntradaValidacionZoom

primerNombre	string Nullable
segundoNombre	string Nullable
primerApellido	string Nullable
segundoApellido	string Nullable
guidConv	string <uuid>
tipoValidacion	integer <int32>
asesor	string Nullable
sede	string Nullable
codigoCliente	string Nullable
tipoDoc	string Nullable
numDoc	string Nullable
email	string Nullable
celular	string Nullable
usuario	string Nullable
clave	string Nullable
infCandidato	string Nullable

Responses

Request samples

Payload

Content type


{"primerNombre": "string",
"segundoNombre": "string",
"primerApellido": "string",
"segundoApellido": "string",
"guidConv": "ea73044f-e022-4736-a8f0-b1a1b7c33e07",
"tipoValidacion": 0,
"asesor": "string",
"sede": "string",
"codigoCliente": "string",
"tipoDoc": "string",
"numDoc": "string",
"email": "string",
"celular": "string",
"usuario": "string",
"clave": "string",
"infCandidato": "string"
}

Response samples

200

Content type


{"code": 0,
"data": 
{"procesoConvenioGuid": "string",
"url": "string"
},
"codeName": "string"
}

Consulta una solicitud de validación

POST { "guidConv": "dc5ada78-c694-40f3-a2b5-439d8db93247", "procesoConvenioGuid": "dc5ada78-c694-40f3-a2b5-439d8db93247", "codigoCliente": "000100", "usuario": "asesor1", "clave": "12345" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

filtro para la búsqueda de los datos

guidConv	string Nullable
procesoConvenioGuid	string <uuid> Nullable
codigoCliente	string Nullable
usuario	string Nullable
clave	string Nullable

Responses

Request samples

Payload

Content type


{"guidConv": "string",
"procesoConvenioGuid": "b9eec147-4298-42bf-8da5-eb9f279ad74c",
"codigoCliente": "string",
"usuario": "string",
"clave": "string"
}

Response samples

200

Content type


{"code": 0,
"data": 
{"guidConv": "string",
"procesoConvenioGuid": "string",
"primerNombre": "string",
"segundoNombre": "string",
"primerApellido": "string",
"segundoApellido": "string",
"tipoDoc": "string",
"numDoc": "string",
"email": "string",
"celular": "string",
"asesor": "string",
"sede": "string",
"nombreSede": "string",
"codigoCliente": "string",
"estadoProceso": 0,
"scoreProceso": 0,
"aprobado": true,
"cancelado": true,
"motivoCancelacion": "string",
"finalizado": true,
"encontradoEnFuente": true,
"fuentesAbiertas": { },
"fechaRegistro": "2019-08-24T14:15:22Z",
"fechaFinalizacion": "2019-08-24T14:15:22Z",
"servicios": 
[
{"servicio": "string",
"tipo": "string",
"subTipos": "string",
"score": 0,
"barcode": 
{"numDoc": "string",
"tipoDoc": "string",
"primerNombre": "string",
"segundoNombre": "string",
"primerApellido": "string",
"segundoApellido": "string",
"sexo": "string",
"rh": "string",
"fechaNacimiento": "2019-08-24T14:15:22Z",
"fechaExpedicion": "2019-08-24T14:15:22Z"
},
"fecha": "2019-08-24T14:15:22Z",
"terminado": true
}
]
},
"codeName": "string"
}

Ejecuta la comparación de dos rostros

POST CompararRostros { "rostro1": "/9j/4AAQSkZJRgABAQEBLAEsAAD/...", "formato1": "PNG_B64", "rostro2": "/9j/4AAQSkZJGFAFUEEMGAEsADFG...", "formato2": "PNG_B64" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

guidConvenio	string <uuid>
rostro1	string Nullable
formato1	string Nullable
rostro2	string Nullable
formato2	string Nullable

Responses

Request samples

Payload

Content type


{"guidConvenio": "b282af6b-1709-47c2-8987-84efbf5f7b72",
"rostro1": "string",
"formato1": "string",
"rostro2": "string",
"formato2": "string"
}

Response samples

200

Content type


{"data": 
{"esValido": true,
"resultado": "OK",
"score": 0,
"provider": 0
},
"code": 0,
"codeName": "string"
}

Manda una notificación mail si el proceso ha terminado

POST CompararRostros { "procesoGuid": "20124c19-a5e2-4057-b805-0c4a2eabed7e", }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

procesoGuid

string <uuid>

Responses

Request samples

Payload

Content type


{"procesoGuid": "673f4a0f-9502-43ec-a228-af600c590202"
}

Response samples

200

Content type


{"code": 0,
"data": 
{"enviado": true,
"mensajeError": "string"
},
"codeName": "string"
}

Respuesta del servicio de obtener todos los procesos de un ciudadano.

procesoGuid	string <uuid>
nombreConvenio	string Nullable
tipoDoc	string Nullable
numDoc	string Nullable
tipoProceso	integer <int32> Nullable
finalizado	boolean Nullable
cancelado	boolean Nullable
fechaCreado	string Nullable


{"procesoGuid": "673f4a0f-9502-43ec-a228-af600c590202",
"nombreConvenio": "string",
"tipoDoc": "string",
"numDoc": "string",
"tipoProceso": 0,
"finalizado": true,
"cancelado": true,
"fechaCreado": "string"
}

Respuesta paginada por procesos

	Array of objects (GetProcessesResponse) Nullable
totalPages	integer <int32>


{"processesList": 
[
{"procesoGuid": "673f4a0f-9502-43ec-a228-af600c590202",
"nombreConvenio": "string",
"tipoDoc": "string",
"numDoc": "string",
"tipoProceso": 0,
"finalizado": true,
"cancelado": true,
"fechaCreado": "string"
}
],
"totalPages": 0
}

Detalle de un proceso.

procesoGuid	string <uuid>
pais	string Nullable
estado	integer <int32> Nullable
tipoDocumento	string Nullable
tipo	string Nullable
numeroDocumento	string Nullable
nombreCompleto	string Nullable
fechaCreacion	string <date-time>


{"procesoGuid": "673f4a0f-9502-43ec-a228-af600c590202",
"pais": "string",
"estado": 0,
"tipoDocumento": "string",
"tipo": "string",
"numeroDocumento": "string",
"nombreCompleto": "string",
"fechaCreacion": "2019-08-24T14:15:22Z"
}

Modelo de central facial.

existe	boolean
match	boolean


{"existe": true,
"match": true
}

Modelo de proceso facial.

rostro	string Nullable
fechaDeCaptura	string <date-time>
score	string Nullable
reintentos	integer <int32> Nullable
datosAdi	string Nullable
formato	string Nullable
	object (CentralFacial)
esValido	boolean Nullable


{"rostro": "string",
"fechaDeCaptura": "2019-08-24T14:15:22Z",
"score": "string",
"reintentos": 0,
"datosAdi": "string",
"formato": "string",
"centralFacial": 
{"existe": true,
"match": true
},
"esValido": true
}

Modelo de proceso de un documento.

tipo	string Nullable
foto	string Nullable
fechaDeCaptura	string <date-time>
reintentos	integer <int32> Nullable
formato	string Nullable


{"tipo": "string",
"foto": "string",
"fechaDeCaptura": "2019-08-24T14:15:22Z",
"reintentos": 0,
"formato": "string"
}

Modelo de proceso de un otp.

tipo	string Nullable
codigo	string Nullable
validado	boolean
fechaValidado	string <date-time> Nullable
fechaCreado	string <date-time>


{"tipo": "string",
"codigo": "string",
"validado": true,
"fechaValidado": "2019-08-24T14:15:22Z",
"fechaCreado": "2019-08-24T14:15:22Z"
}

Modelo de proceso de las preguntas socio-demográficas.

resultado	string Nullable
score	string Nullable
questionario	string Nullable
fechaCreacion	string <date-time>


{"resultado": "string",
"score": "string",
"questionario": "string",
"fechaCreacion": "2019-08-24T14:15:22Z"
}

Modelo de fuente.

codigo	string Nullable
nombre	string Nullable
mensaje	string Nullable
riesgo	boolean
score	integer <int32>


{"codigo": "string",
"nombre": "string",
"mensaje": "string",
"riesgo": true,
"score": 0
}

Endpoint para consultar usuario en fuente

POST { "CodigoPais": "57", "NumDocumento": "1032473321", "TipoDocumento": "CC" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to search Domain.Models.Fuente.ConsultaFuenteEntry

tipoDocumento	string Nullable
numDocumento	string Nullable
codigoPais	string Nullable
guidConvenio	string <uuid>

Responses

Request samples

Payload

Content type


{"tipoDocumento": "string",
"numDocumento": "string",
"codigoPais": "string",
"guidConvenio": "b282af6b-1709-47c2-8987-84efbf5f7b72"
}

Response samples

200

Content type


{"code": 0,
"data": 
{"existe": true,
"listaImagenes": 
[
{"fecha": "string",
"fuente": "string"
}
]
},
"codeName": "string"
}

Endpoint para validar usuario en fuente

POST { "CodigoPais": "57", "NumDocumento": "1032473321", "TipoDocumento": "CC", "Imagen": "dsaddsadsdaf", "Formato": "PNG_B64" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to validate user Domain.Models.Fuente.ValidarFuenteEntry

guidConvenio	string <uuid>
tipoDocumento	string Nullable
numDocumento	string Nullable
codigoPais	string Nullable
imagen	string Nullable
formato	string Nullable

Responses

Request samples

Payload

Content type


{"guidConvenio": "b282af6b-1709-47c2-8987-84efbf5f7b72",
"tipoDocumento": "string",
"numDocumento": "string",
"codigoPais": "string",
"imagen": "string",
"formato": "string"
}

Response samples

200

Content type


{"data": { },
"code": 0,
"codeName": "string"
}

Endpoint para validar usuario en ANI y fuente

POST { "CodigoPais": "57", "NumDocumento": "1032473321", "TipoDocumento": "CC", "Imagen": "dsaddsadsdaf", "Formato": "PNG_B64" }

Authorizations:

Bearer

header Parameters

x-api-version

string

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

DTO with the attributes to validate user Domain.Models.Fuente.ValidarFuenteEntry

guidConvenio	string <uuid>
tipoDocumento	string Nullable
numDocumento	string Nullable
codigoPais	string Nullable
imagen	string Nullable
formato	string Nullable

Responses

Request samples

Payload

Content type


{"guidConvenio": "b282af6b-1709-47c2-8987-84efbf5f7b72",
"tipoDocumento": "string",
"numDocumento": "string",
"codigoPais": "string",
"imagen": "string",
"formato": "string"
}

Response samples

200

Content type


{"data": { },
"code": 0,
"codeName": "string"
}

Modelo de fuentes abiertas.

estado	string Nullable
	Array of objects (Fuente) Nullable


{"estado": "string",
"fuentes": 
[
{"codigo": "string",
"nombre": "string",
"mensaje": "string",
"riesgo": true,
"score": 0
}
]
}

Modelo general de procesos.

	object (ProcessDetail)
	object (ProcessFacial)
	Array of objects (ProcessDocument) Nullable
	Array of objects (ProcessOtp) Nullable
	object (ProcessPsd)
	object (ProcessFuentesAbiertas)
	object (CentralFacial)


{"detalle": 
{"procesoGuid": "673f4a0f-9502-43ec-a228-af600c590202",
"pais": "string",
"estado": 0,
"tipoDocumento": "string",
"tipo": "string",
"numeroDocumento": "string",
"nombreCompleto": "string",
"fechaCreacion": "2019-08-24T14:15:22Z"
},
"facial": 
{"rostro": "string",
"fechaDeCaptura": "2019-08-24T14:15:22Z",
"score": "string",
"reintentos": 0,
"datosAdi": "string",
"formato": "string",
"centralFacial": 
{"existe": true,
"match": true
},
"esValido": true
},
"documento": 
[
{"tipo": "string",
"foto": "string",
"fechaDeCaptura": "2019-08-24T14:15:22Z",
"reintentos": 0,
"formato": "string"
}
],
"otp": 
[
{"tipo": "string",
"codigo": "string",
"validado": true,
"fechaValidado": "2019-08-24T14:15:22Z",
"fechaCreado": "2019-08-24T14:15:22Z"
}
],
"psd": 
{"resultado": "string",
"score": "string",
"questionario": "string",
"fechaCreacion": "2019-08-24T14:15:22Z"
},
"fuentesAbiertas": 
{"estado": "string",
"fuentes": 
[
{"codigo": "string",
"nombre": "string",
"mensaje": "string",
"riesgo": true,
"score": 0
}
]
},
"centralFacial": 
{"existe": true,
"match": true
}
}

Respuesta de todos los tipos de documentos.

id	integer <int64>
pais	string Nullable
tipo	string Nullable
nombre	string Nullable


{"id": 0,
"pais": "string",
"tipo": "string",
"nombre": "string"
}

Respuesta de erros en una transacción.

codigo	string Nullable
descripcion	string Nullable


{"codigo": "string",
"descripcion": "string"
}

Modelo de respuesta de una transacción.

esExitosa	boolean
	Array of objects (ErrorEntransaccion) Nullable


{"esExitosa": true,
"errorEntransaccion": 
[
{"codigo": "string",
"descripcion": "string"
}
]
}

Modelo de respuesta del web service que consulta la ANI para un ciudadano Colombiano.

primerNombre	string Nullable
segundoNombre	string Nullable
primerApellido	string Nullable
segundoApellido	string Nullable
vivo	boolean
estadoDoc	string Nullable
particula	string Nullable
fechaExp	string <date-time>
departamentoExpedicion	string Nullable
localizacion	string Nullable
numeroResolucion	string Nullable
nuip	string Nullable
	object (RespuestaTransaccionModel)


{"primerNombre": "string",
"segundoNombre": "string",
"primerApellido": "string",
"segundoApellido": "string",
"vivo": true,
"estadoDoc": "string",
"particula": "string",
"fechaExp": "2019-08-24T14:15:22Z",
"departamentoExpedicion": "string",
"localizacion": "string",
"numeroResolucion": "string",
"nuip": "string",
"respuestaTransaccion": 
{"esExitosa": true,
"errorEntransaccion": 
[
{"codigo": "string",
"descripcion": "string"
}
]
}
}

Modelo de respuesta del web service que retorna la lectura del código de barras de cédulas Colombianas.

numDoc	string Nullable
tipoDoc	string Nullable
primerNombre	string Nullable
segundoNombre	string Nullable
primerApellido	string Nullable
segundoApellido	string Nullable
sexo	string Nullable
rh	string Nullable
fechaNacimiento	string <date-time>
fechaExpedicion	string <date-time> Nullable


{"numDoc": "string",
"tipoDoc": "string",
"primerNombre": "string",
"segundoNombre": "string",
"primerApellido": "string",
"segundoApellido": "string",
"sexo": "string",
"rh": "string",
"fechaNacimiento": "2019-08-24T14:15:22Z",
"fechaExpedicion": "2019-08-24T14:15:22Z"
}

Modelo de respuesta del web service que retorna la evaluación por parte del equipo forense de documentos.

id	integer <int64> Nullable
forenseGuid	string <uuid>
tipoDoc	string Nullable
numDoc	string Nullable
nombreCliente	string Nullable
aprobada	boolean Nullable
revisada	boolean Nullable
score	number <double> Nullable
motivoOpcionalId	integer <int64> Nullable
motivoPrincipalId	integer <int64> Nullable
descripcion	string Nullable
fechaRecepcion	string <date-time>
fechaRevision	string <date-time> Nullable
tiempoRevision	integer <int64> Nullable
	Array of objects (ForenseDetail) Nullable


{"id": 0,
"forenseGuid": "9919a72b-64f3-4836-ad09-12c6f3c6e671",
"tipoDoc": "string",
"numDoc": "string",
"nombreCliente": "string",
"aprobada": true,
"revisada": true,
"score": 0,
"motivoOpcionalId": 0,
"motivoPrincipalId": 0,
"descripcion": "string",
"fechaRecepcion": "2019-08-24T14:15:22Z",
"fechaRevision": "2019-08-24T14:15:22Z",
"tiempoRevision": 0,
"forenseDetail": 
[
{"objetoGuid": "67e9885f-d93d-4f0b-bbe0-5daecb2ddc2c",
"tipoObjeto": "string",
"objeto": "string",
"formatoObjeto": "string"
}
]
}

Modelo de respuesta del web service que retorna si un ciudadano se encuentra en nuestra base de datos.

existe	boolean
	Array of objects (ConsultarListaImagenes) Nullable


{"existe": true,
"listaImagenes": 
[
{"fecha": "string",
"fuente": "string"
}
]
}

Modelo de respuesta del web service que retorna la url para que un ciudadano pueda validarse o enrolarse.

procesoConvenioGuid	string Nullable
url	string Nullable


{"procesoConvenioGuid": "string",
"url": "string"
}

Modelo de respuesta del web service que retorna el score de similitud entre dos rostros.

esValido	boolean
resultado	string (ResultadoBiometriaEnum) Enum: "OK" "ZONA_GRIS" "FAIL"
score	number <double>
provider	integer <int32>


{"esValido": true,
"resultado": "OK",
"score": 0,
"provider": 0
}

Modelo de respuesta del web service que retorna la lectura del código de barras de cédulas Colombianas.

numDoc	string Nullable
tipoDoc	string Nullable
primerNombre	string Nullable
segundoNombre	string Nullable
primerApellido	string Nullable
segundoApellido	string Nullable
sexo	string Nullable
rh	string Nullable
fechaNacimiento	string <date-time>
fechaExpedicion	string <date-time> Nullable


{"numDoc": "string",
"tipoDoc": "string",
"primerNombre": "string",
"segundoNombre": "string",
"primerApellido": "string",
"segundoApellido": "string",
"sexo": "string",
"rh": "string",
"fechaNacimiento": "2019-08-24T14:15:22Z",
"fechaExpedicion": "2019-08-24T14:15:22Z"
}

SDK Web ReconoSER ID (1.0.0)

Introducción

Cross-Origin Uso Compartido entre Orígenes

Authorization

Bearer

Token

Traer JWT Token

Authorizations:

header Parameters

Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Responses

Request samples

Traer JWT Token de usuario con rol

Authorizations:

header Parameters

Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Responses

Request samples

Refresca el token de acceso mediante un Refresh Token

Authorizations:

query Parameters

header Parameters

Responses

Validacion

Genera o actualiza una solicitud de validación

Authorizations:

header Parameters

Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Responses

Request samples

Response samples

Genera o actualiza una solicitud de validación

Authorizations:

header Parameters

Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Responses

Request samples

Response samples

Consulta una solicitud de validación

Authorizations:

header Parameters

Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Responses

Request samples

Response samples

Ejecuta la comparación de dos rostros

Authorizations:

header Parameters

Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Responses

Request samples

Response samples

Manda una notificación mail si el proceso ha terminado

Authorizations:

header Parameters

Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Responses

Request samples

Response samples

ANI

Modelo de fuente.

Endpoint para consultar usuario en fuente

Authorizations:

header Parameters

Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Responses

Request samples

Response samples

Endpoint para validar usuario en fuente

Authorizations:

header Parameters

Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Responses

Request samples

Response samples

Endpoint para validar usuario en ANI y fuente

Authorizations:

header Parameters

Request Body schema: application/json-patch+jsonapplication/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Responses

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json

Request Body schema:
application/json-patch+json
application/json-patch+json
application/json
text/json
application/*+json