Guardar Documento Ambas Caras - ReconoSERID/SDK-ReconoSERID-Android GitHub Wiki
** Guardar Documento Ambas Caras **
Método para guardar la información del documento, donde se almacenan ambas caras del documento
#!java
public void onGetSaveDocumentSides(@NotNull SaveDocumentSidesIn saveDocumentSidesIn, @NotNull CallbackSaveDocumentSides listener)
#!Kotlin
fun onGetSaveDocumentSides(saveDocumentSidesIn : SaveDocumentSidesIn, listener: CallbackSaveDocumentSides)
Parametros de entrada
Parámetros
Parámetro
Tipo
Requerido
Descripción
saveDocumentSidesIn
SaveDocumentSidesIn
SI
Es una objeto que contiene los datos del almacenamiento del documento
CallbackSaveDocumentSides
Callback
SI
Retorna un SaveDocumentSidesOut y RespuestaTransaccion
Parámetros SaveDocumentSidesIn
Parámetro
Tipo
Requerido
Descripción
Anverso
Objeto
SI
Información asociada al anverso del documento
guidProcesoConvenio
String
SI
Identificador del proceso
datosAdi
String
SI
Tipo de documento a almacenar ( CC (en caso de la cédula amarilla y cédula digital), CE, TI, etc)
guidCiu
String
SI
Identificador del ciudadano creado
Reverso
Objeto
SI
Información asociada al reverso del documento
usuario
String
SI
Nombre del asesor que se entregó con las credenciales del convenio
trazabilidad
Objeto
Opcional
Trazabilidad del dispositivo que envía la información (se crea de forma automática)
LogsOcrbarcode
Objeto
SI
Logs asociados al anverso, reverso y barcode del documento
configuracionEspecial
List (String)
Opcional
Solo se debe usar cuando la lectura del anverso, reverso o ambos haya fallado, solo se debe crear un array como se muestra en los ejemplos
Parámetros Anverso
Parámetro
Tipo
Requerido
Descripción
formato
String
SI
Tipo de formato de la imagen a enviar (JPG_B64 ó PNG_B64)
valor
String
SI
String en BASE64 que contiene la imagen a enviar Datos biométricos Base64 (Puede apoyarse en la clase ImageUtils.getEncodedBase64FromFilePath(pathFront) para pasar la imagen a B64 )
Parámetros Reverso
Parámetro
Tipo
Requerido
Descripción
formato
String
SI
Tipo de formato de la imagen a enviar (JPG_B64 ó PNG_B64)
valor
String
SI
String en BASE64 que contiene la imagen a enviar Datos biométricos Base64 (Puede apoyarse en la clase ImageUtils.getEncodedBase64FromFilePath(pathBack) para pasar la imagen a B64 )
Parámetros Trazabilidad
Parámetro
Tipo
Requerido
Descripción
device
String
Opcional
Enviar la palabra "Android"
ip
String
Opcional
Dirección ip pública, de la cual proviene el la petición
navegador
String
Opcional
No aplica, enviar ""
resolucion
String
Opcional
Resolución de la pantalla del dispositivo móvil
tiempo
Integer
Opcional
No aplica, enviar en '0'
userAgent
String
Opcional
No aplica, enviar ""
versionNavegador
String
Opcional
No aplica, enviar ""
Parámetros LogsOcrbarcode
Parámetro
Tipo
Requerido
Descripción
LogOcrAnverso
String
Si
Los asociados al OCR anverso del documento
LogOcrReverso
String
Si
Los asociados al OCR reverso del documento
LogBarcodeReader
String
Si
Los asociados al OCR barcode del documento
Para poder implementar en esta clase los valores obtenidos al realizar un escaneo al documento (OCR & BARCODE) en las clases apropiadas para la implementación, se pueden encontrar en el siguiente enlace: Documentos
Parámetros LogOcrAnverso
Parámetro
Tipo
Requerido
Descripción
ciudadanoGuid
String
Opcional
Identificador del ciudadano
numeroDocumento
String
SI
Número del documento a almacenar
primerNombre
String
SI
Primer nombre del solicitante
segundoNombre
String
Opcional
Segundo nombre del solicitante
primerApellido
String
SI
Primer apellido del solicitante
segundoApellido
String
Opcional
Segundo apellido del solicitante
sexo
String
SI
Genero del solicitante
rh
String
Opcional
RH del solicitante
fechaNacimiento
String
Opcional
Fecha de nacimiento del solicitante
fechaExpedicionDoc
String
Opcional
Fecha de expedición del documento
Parámetros LogOcrReverso
Parámetro
Tipo
Requerido
Descripción
ciudadanoGuid
String
Opcional
Identificador del ciudadano
numeroDocumento
String
SI
Número del documento a almacenar
primerNombre
String
SI
Primer nombre del solicitante
segundoNombre
String
Opcional
Segundo nombre del solicitante
primerApellido
String
SI
Primer apellido del solicitante
segundoApellido
String
Opcional
Segundo apellido del solicitante
sexo
String
SI
Genero del solicitante
rh
String
Opcional
RH del solicitante
fechaNacimiento
String
Opcional
Fecha de nacimiento del solicitante
fechaExpedicionDoc
String
Opcional
Fecha de expedición del documento
Parámetros LogBarcodeReader
Parámetro
Tipo
Requerido
Descripción
numeroDocumento
String
SI
Número del documento a almacenar
primerNombre
String
SI
Primer nombre del solicitante
segundoNombre
String
Opcional
Segundo nombre del solicitante
primerApellido
String
SI
Primer apellido del solicitante
segundoApellido
String
Opcional
Segundo apellido del solicitante
sexo
String
Opcional
Genero del solicitante
rh
String
Opcional
RH del solicitante
fechaNacimiento
String
SI
Fecha de nacimiento del solicitante
fechaExpedicionDoc
String
SI
Fecha de expedición del documento
Los valores opcionales se les puede asignar más de una vez un valor de acuerdo al documento, por ejemplo hay fechas en documentos que solo están en el anverso o en el reverso, en ese caso se puede asignar el mismo valor (por ejemplo la fecha de expedición del documento) ya sea encontrado en el anverso, reverso o barcode a cada una de las respectivas clases (LogOcrAnverso, LogOcrReverso, LogBarcodeReader)
#!java
public SaveDocumentSidesIn( Anverso anverso, //Información asociada al anverso del documento
String guidProcesoConvenio //Identificador del proceso
String datosAdi //Tipo de documento a almacenar ( CC, CE, TI, etc)
String guidCiu, //Identificador del ciudadano creado
Reverso reverso, //Información asociada al reverso del documento
String usuario, //Nombre del asesor que se entregó con las credenciales del convenio
Trazabilidad trazabilidad, //Trazabilidad del dispositivo que envía la información (opcional)
LogsOcrbarcode logsOcrbarcode) //Logs asociados al anverso, reverso y barcode del documento
// List<String> configuracionEspecial) //Solo se usa cuando la lectura del documento ha fallado
#!Kotlin
fun RequestValidationIn( anverso : Anverso, //Información asociada al anverso del documento
guidProcesoConvenio : String, //Identificador del proceso
datosAdi : String, //Tipo de documento a almacenar ( CC, CE, TI, etc)
guidCiu : String, //Identificador del ciudadano creado
reverso : Reverso, //Información asociada al reverso del documento
usuario : String, //Nombre del asesor que se entregó con las credenciales del convenio
trazabilidad : Trazabilidad, //Trazabilidad del dispositivo que envía la información (opcional)
logsOcrbarcode : LogsOcrbarcode) //Logs asociados al anverso, reverso y barcode del documento
// configuracionEspecial : List<String>) //Solo se usa cuando la lectura del documento ha fallado
y devuelve:
Parámetro
Tipo
Descripción
SaveDocumentSidesOut
Object
Objeto que contiene la información de la consulta
RespuestaTransaccion
Object
Objeto que describe si el servicio fue o no consultado
Parámetros SaveDocumentSidesOut
Parámetro
Tipo
Descripción
Datos
Object
Objeto que contiene la información resumida del almacenamiento de los documentos
guidBioAnv
String
Identificador del documento Anverso
guidBioRev
String
Identificador del documento Reverso
anvExitoso
Boolean
Validación exitosa del Anverso
revExitoso
Boolean
Validación exitosa del Reverso
anvMensaje
String
Mensaje de la validación del Anverso
revMensaje
String
Mensaje de la validación del Reverso
RespuestaTransaccion
Object
Objeto que describe si el servicio fue o no consultado
Parámetros Datos
Parámetro
Tipo
Descripción
Data
Object
Objeto que contiene la solicitud del ciudadano
OcrList
List
Objeto que contiene una información listada del OCR del documento
BarcodeList
List
Objeto que contiene una información listada del Barcode del documento (si lo tiene)
MrzList
List
Objeto que contiene una información listada del MRZ del documento (si lo tiene)
Parámetros Data
Parámetro
Tipo
Descripción
documentTypeDesc
String
Descripción del tipo de documento
documentType
String
Tipo de documento almacenado ( CC, CE, TI, etc)
class
String
Clase de documento almacenado ( CC, CE, TI, etc)
subTipo
String
Subtipo de documento almacenado
numeroDocumento
String
Número de documento almacenado del ciudadano
primerNombre
String
Primer nombre del solicitante
segundoNombre
String
Segundo nombre del solicitante
primerApellido
String
Primer apellido del solicitante
segundoApellido
String
Segundo apellido del solicitante
nombreCompleto
String
Nombre completo del solicitante
sexo
String
Genero del solicitante
rh
String
RH del solicitante
lugarNacimiento
String
Lugar de nacimiento del solicitante
isoCode
String
Código ISO del documento (sí aplica)
mrzCode
String
Código MRZ del documento (sí aplica)
edad
Integer
País de referencia del número de teléfono del solicitante
país
String
Edad del solicitante
numeroPersonal
String
Número personal del solicitante
claveElector
String
Clave elector del solicitante (sí aplica)
ocrNumber
String
Número del OCR del documento del solicitante (sí aplica)
codigoCic
String
Código del cliente asociado del ciudadano creado
numeroEmision
String
Número de emisión del la solicitud
fechaDeRegistro
String
Fecha de registro de la emisión
fechaNacimiento
String
Fecha de nacimiento del solicitante
fechaExpedicionDoc
String
Fecha de expedición del documento
fechaExpiracionDoc
String
Fecha de expiración del documento (sí aplica)
Parámetros OcrList
Parámetro
Tipo
Descripción
idType
String
Tipo de documento almacenado ( CC, CE, TI, etc)
descripcion
String
Descripción del tipo de documento
valor
String
Valor del OCR
Parámetros BarcodeList
Parámetro
Tipo
Descripción
idType
String
Tipo de documento almacenado ( CC, CE, TI, etc)
descripcion
String
Descripción del tipo de documento
valor
String
Valor del BarcodeList
Parámetros MrzList
Parámetro
Tipo
Descripción
idType
String
Tipo de documento almacenado ( CC, CE, TI, etc)
descripcion
String
Descripción del tipo de documento
valor
String
Valor del MrzList
#!java
public RequestValidationOut( Datos datos, //Objeto que contiene la información resumida del almacenamiento de los documentos
String guidBioAnv, //Identificador del documento Anverso
String guidBioRev, //Identificador del documento Reverso
String anvExitoso, //Validación exitosa del Anverso
String revExitoso, //Validación exitosa del Reverso
String anvMensaje, //Mensaje de la validación del Anverso
String revMensaje, //Mensaje de la validación del Reverso
RespuestaTransaccion respuestaTransaccion) //Objeto que describe si el servicio fue o no consultado
#!Kotlin
fun RequestValidationOut(datos : Datos, //Objeto que contiene la información resumida del almacenamiento de los documentos
guidBioAnv : String, //Identificador del documento Anverso
guidBioRev : String, //Identificador del documento Reverso
anvExitoso : String //Validación exitosa del Anverso
revExitoso : String //Validación exitosa del Reverso
anvMensaje : String, //Mensaje de la validación del Anverso
revMensaje : String, //Mensaje de la validación del Reverso
respuestaTransaccion : RespuestaTransaccion) //Objeto que describe si el servicio fue o no consultado
Ej:
#!java
SaveDocumentSidesIn saveDocumentSidesIn = new SaveDocumentSidesIn();
saveDocumentSidesIn.setAnverso(Anverso()); //Información asociada al anverso del documento
saveDocumentSidesIn.setGuidProcesoConvenio("guidProcesoConvenio"); //Identificador del proceso
saveDocumentSidesIn.setDatosAdi("datosAdi"); //Tipo de documento a almacenar ( CC, CE, TI, etc)
saveDocumentSidesIn.setGuidCiu("guidCiu"); //Identificador del ciudadano creado
saveDocumentSidesIn.setReverso(Reverso()); //Información asociada al reverso del documento
saveDocumentSidesIn.setUsuario("usuario"); //Nombre del asesor que se entregó con las credenciales del convenio
saveDocumentSidesIn.setTrazabilidad(Trazabilidad()); //Trazabilidad del dispositivo que envía la información (opcional)
saveDocumentSidesIn.setLogsOcrbarcode(LogsOcrbarcode()); //Logs asociados al anverso, reverso y barcode del documento
// saveDocumentSidesIn.setConfiguracionEspecial(Arrays.asList("ForzarLecturaMovil")); //Solo se usa cuando la lectura del documento ha fallado
ServicesOlimpia.getInstance().getSaveDocumentSides(saveDocumentSidesIn, new OlimpiaInterface.CallbackSaveDocumentSides() {
@Override
public void onSuccess(SaveDocumentSidesOut saveDocumentSidesOut) {
//Implementación
}
@Override
public void onError(RespuestaTransaccion transactionResponse) {
//Implementación
}
});
#!Kotlin
val saveDocumentSidesIn = SaveDocumentSidesIn()
saveDocumentSidesIn.anverso(Anverso()) //Información asociada al anverso del documento
saveDocumentSidesIn.guidProcesoConvenio("guidProcesoConvenio") //Identificador del proceso
saveDocumentSidesIn.datosAdi("datosAdi") //Tipo de documento a almacenar ( CC, CE, TI, etc)
saveDocumentSidesIn.guidCiu("guidCiu") //Identificador del ciudadano creado
saveDocumentSidesIn.reverso(Reverso()) //Información asociada al reverso del documento
saveDocumentSidesIn.usuario("usuario") //Nombre del asesor que se entregó con las credenciales del convenio
saveDocumentSidesIn.trazabilidad(Trazabilidad()) //Trazabilidad del dispositivo que envía la información (opcional)
saveDocumentSidesIn.logsOcrbarcode(LogsOcrbarcode()) //Logs asociados al anverso, reverso y barcode del documento
// saveDocumentSidesIn.configuracionEspecial(listOf("ForzarLecturaMovil")) //Solo se usa cuando la lectura del documento ha fallado
ServicesOlimpia.getInstance()
.getSaveDocumentSides(saveDocumentSidesIn, object : OlimpiaInterface.CallbackSaveDocumentSides {
override fun onSuccess(saveDocumentSidesOut: SaveDocumentSidesOut) {
// Implementación
}
override fun onError(respuestaTransaccion: RespuestaTransaccion) {
// Implementación
}
})