API reference, Government validation

Process government validation

POSThttps://demo-api.incodesmile.com/omni/process/government-validation

This endpoint reads the country code from the interview which can be set at the moment of calling the start endpoint or is updated based on the processed id. Request body can optionally contain data from id in JSON. If omitted, data from scanned ID is read.

Country codes:

MEX: Mexico - INE Validation. When government face validation is enabled this method compares the user's selfie against the image in the INE database. The method should be called after add-face is over and one of (process-id or document-id) is over.

Request parameters:

  • fallbackEnabled: Boolean, optional. If it is not sent, it will default to false.
  • scrapingMethod: Boolean, optional. If it is not sent, it will default to false.

If parameter fallbackEnabled is true and there's some connection or infrastructure error with the INE service, validation by scraping will start. If parameter scrapingMethod is true, then direct connection to INE service won't be attempted and the scraping approach will be used instead.

Request Body is optional - if not sent, data will be taken from the session:

  • ocr: String, mandatory for INE and IFE.
  • cic: String, mandatory for INE.
  • nombre: String, optional.
  • apellidoPaterno: String, optional.
  • apellidoMaterno: String, optional.
  • anioRegistro: String, optional.
  • anioEmision: String, optional.
  • numeroEmisionCredencial: String, mandatory for ife.
  • claveElector: String, mandatory for ife.
  • curp: String, optional.

COL: Colombia - Registraduría Validation. Currently there's no option for face validation. Can validate registraduría or extranjería (foreign citizens living in colombia). Note: Government Validations for Colombia acquired via TusDatos

Request Body is optional - if not sent data will be taken from the session:

  • idNumber: String, mandatory.
  • fechaEmision: String, mandatory when Nationality is not Columbia. Format dd/mm/yyyy
  • nombre: String, optional.
  • apellidoPaterno: String, optional.
  • apellidoMaterno: String, optional.

ARG: Argentina - Renaper Validation. Currently there's no option for face validation.

Request Body:

  • idNumber: String, mandatory.

PER: Peru - Reniec Validation. Currently there's no option for face validation. Can validate Reniec. Note: Government Validations for Peru obtained by checking against TOC, a risk database. ID must include DNI in order to validate. Request Body is optional - if not sent data will be taken from the session.

  • idNumber: String, mandatory (corresponds to DNI number)
  • nombre: String, optional - if not provided ocrValidation for FistName will be UNKNOWN
  • apellidoPaterno: String, optional - if not provided ocrValidation for PaternalLastName will be UNKNOWN
  • apellidoMaterno: String, optional - if not provided ocrValidation for MaternalLastName will be UNKNOWN
  • birthDate: String, optional - if not provided ocrValidation for BirthDate will be UNKNOWN
  • gender: String, optional - if not provided ocrValidation for Gender will be UNKNOWN

CHL: Chile - Sinacofi Validation. Currently there's no option for face validation. Can validate Sinacofi. Note: Government Validations for Chile obtained by checking against TOC, a risk database. ID must include DNI in order to validate. Request Body is optional - if not sent data will be taken from the session:

  • idNumber: String, mandatory (corresponds Serie)
  • personalNumber: String, mandatory (corresponds RUT/RUN)

AUS: Australia - Government Validation for Passport and Driver License. Request Body is optional - if not sent data will be taken from the OCR.

For Passport validation:

  • firstName: String, mandatory.
  • middleName: String, optional.
  • paternalLastName: String, mandatory.
  • cic: String, mandatory (corresponds to Passport number).
  • documentType: String, mandatory ("Passport").
  • birthDate: String, mandatory. Format yyyy/MM/dd.
  • address: String, optional.

For Driver License validation:

  • firstName: String, mandatory.
  • middleName: String, optional.
  • paternalLastName: String, mandatory.
  • documentType: String, mandatory ( com"DriversLicense").
  • birthDate: String, mandatory. Format yyyy/MM/dd.
  • refNumber: String, mandatory (corresponds to Card number).
  • cic: String, mandatory (corresponds to License number).
  • issuerState: String, mandatory (e.g., "NSW").
  • address: String, optional.

Query parameters

fallbackEnabledbooleanDefaults to false
scrapingMethodbooleanDefaults to false
scrapingV2booleanDefaults to false
scrapingV3booleanDefaults to false
telcelbooleanDefaults to false
interviewIdstring
countryCodestring

Headers

api-versionstringrequiredDefaults to 1.0

Request body

application/json

ocrstring
cicstring
nombrestring
apellidoPaternostring
apellidoMaternostring
anioRegistrostring
anioEmisionstring
numeroEmisionCredencialstring
claveElectorstring
curpstring
base64Imagestring
idNumberstring
fechaEmisionstring
personalNumberstring
birthDatestring
genderstring
birthPlacestring
addressstring
addressLine2string
latitudestring
longitudestring
macAddressstring
ipstring
osVersionstring
applicationNamestring
sufixstring
firstNamestring
givenNamestring
middleNamestring
maternalLastNamestring
paternalLastNamestring
documentTypestring
enumUnknownPassportVisaDriversLicenseIdentificationCardPermitCurrencyResidenceDocumentTravelDocumentBirthCertificateVehicleRegistrationOtherWeaponLicenseTribalIdentificationVoterIdentificationMilitaryTaxIdentificationFederalIDMedicalCard
refNumberstring
issuerStatestring
aamvaMessageDestinationstring
realIdConformantCodestring
driverLicenseNonCommercialStatusCodestring
documentTypeIdinteger (int32)
issuedAtstring
documentNumberstring
expireAtstring
eyeColorstring
heightstring
weightstring
citystring
postalCodestring
emailstring
fullNamestring
nationalitystring
dateFormatstring

Responses