Validación civil
/civilValidation
Este servicio realiza la comparación facial y/o validación de datos entre las propiedades enviadas y los datos del Registro Civil.
Países soportados El servicio de validación civil (civilValidation) soporta los siguientes países, basados en el formato ISO 3166-1 alpha-3:
Ecuador (ECU)
Costa Rica (CRI)
Argentina (ARG)
Perú (PER)
Guatemala (GTM)
Panamá (PAN)
Honduras (HND)
Solicitud (Request):
bash
curl --location '{IDENTITY_API_BASE_URL}/services/civilValidation' \
--header 'x-api-key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
"operation": "FULL",
"platform": "WEB",
"documentNumber": "123456789",
"imageFrontDocument": "base64ImageString",
"imageBackDocument": "base64ImageString",
"countryCode": "ARG",
"tokenOcr": "base64TokenString",
"bestImage": "base64BestImageString",
"gender": "M",
"templateRaw": "base64TemplateString",
"documentCode": "12345",
"documentValidation": true,
"returnPII": true,
"tracking": {
"extraData": "BQABAQG2gBNjuHN...",
"operationId": "xxxxx-xxxxx-xxxxx-xxxxx-xxxxx"
}
}'Parámetros de la solicitud
Parámetro
Tipo (Contenido)
Obligatorio
Descripción
operation
String
Sí
Operación de validación a realizar, valores posibles:
FACIAL: Realiza comparación facial contra la imagen oficial del Registro Civil
DATA: Validación de datos contra los datos del Registro Civil
FULL: Validación de datos y comparación facial contra el Registro Civil
platform
String
Sí
Plataforma desde la que se realiza la solicitud, valores posibles:
WEB: Solicitud realizada con widgets web
MOBILE: Solicitud realizada con widgets móviles
documentNumber
String
No
Número de documento del usuario. Requerido si operation = FACIAL.
imageFrontDocument
String (Base64)
No
Captura del frente del documento, imagen en base64 sin la cabecera del tipo mime. Requerido si:
platform = WEB
operation = FACIAL y documentNumber está vacío
imageBackDocument
String (Base64)
No
Captura del dorso del documento, imagen en base64 sin la cabecera del tipo mime. Requerido si:
platform = WEB
operation = FACIAL y documentNumber está vacío
countryCode
String
No
Código de país en formato ISO 3166-1 alpha-3. Requerido si:
platform = WEB o
platform = MOBILE y operation = FACIAL y documentNumber no está vacío
tokenOcr
String (Base64)
No
Token generado por el widget nativo o híbrido de SelphID, cifrado con AES256 y tokenizado, enviado en formato Base64. Contiene el resultado OCR generado a partir de la captura del documento de identidad. Requerido si:
platform = MOBILE o
operation = FACIAL y documentNumber está vacío
bestImage
String (Base64)
No
Propiedad bestImage generada por el widget Selphi. Requerido si:
operation = FACIAL o FULL y countryCode = ARG o PAN
gender
String
No
Género de la persona a consultar, los valores posibles son “M” o “F”. Requerido si documentIssuer = ARG y documentNumber no está vacío.
templateRaw
String (Base64)
No
Plantilla biométrica, propiedad generada por el widget Selphi. Requerido si:
operation = FACIAL o FULL
documentCode
String
No
Código de documento (fingerprintCode), necesario para la validación del documento en Ecuador. También se recibe como idTramite (opcional) para Renaper (Argentina). Requerido si:
countryCode = ECU
documentValidation
Boolean
No
Indica si se debe iniciar la validación del documento, devolviendo scanReference y type. La documentación y exposición como recurso para la validación de documentos se encuentra por separado en la especificación FPhi.API documentValidation.
returnPII
Boolean
No
Indica si se deben recibir los datos personales generados tanto por el servicio OCR como por la respuesta del Registro Civil.
tracking
Objeto JSON
No
Objeto que representa la información de seguimiento necesaria.
extraData
String (Base64)
No
Token generado por el SDK Mobile/Web. Contiene información de seguimiento tokenizada con Platform.
operationId
String (Base64)
No
Identificador de operación generado por el SDK Mobile/Web.
Precaución
Dependiendo de la integración con el Registro Civil, el uso de templateRaw o bestImage puede variar.
Para algunos países y sus respectivas integraciones, es necesario enviar bestImage o templateRaw.
Por favor, consulte los requisitos específicos para cada país.
Adicionalmente, algunos países requieren documentNumber, documentCode y gender.
Por favor, consulte también estos requisitos específicos.
Ejemplo de respuesta (Response):
text
Campos de la respuesta:
Identificador
Tipo
Descripción
serviceResultCode
Integer
Código que indica el resultado general de la ejecución del servicio. Ver Tabla 1 - Código de Resultado del Servicio (Service Result Code).
serviceTime
String
Campo que indica el tiempo de procesamiento.
serviceResultLog
String
Campo descriptivo del resultado de la ejecución del servicio. Incluye detalles cuando hay un error o excepción en el módulo.
serviceTransactionId
String
Identificador de transacción asociado a la solicitud procesada por la API.
civilDataValidation
String
Objeto que representa las validaciones OCR contra los datos obtenidos del Registro Civil. La presencia de este objeto depende del Registro Civil consultado.
serviceFacialAuthenticationResult
Integer
Código que indica el resultado de la comparación facial. Ver Tabla 2 - Resultado de la Autenticación Facial del Servicio (Service Facial Authentication Result).
serviceFacialAuthenticationHash
String
Hash de integridad de la plantilla biométrica utilizada en una autenticación facial positiva o incierta.
serviceFacialSimilarityResult
Float
Valor que indica la similitud facial entre el rostro en la foto del documento de identidad y el selfie tomado por el usuario. 1.0 = 100%.
serviceDocument
JSON
Objeto que representa el documento capturado. Sus propiedades son todos los campos extraídos por el proceso de OCR.
civilServiceData
JSON
Objeto que representa los datos personales obtenidos del Registro Civil (devuelto solo si returnPII fue enviado como true en la solicitud).
Last updated