BRE events and variables

Events

Each product at Truora has events that your system might find useful to monitor in order to trigger an action. Some examples of these events are: a check completion, a validation failure, and the delivery of a WhatsApp conversation, among others. In this guide, you will learn about each one of them.

Variables

Each event is accompanied by an object; this object is related to the by-product and will have more or less information depending on the trigger; for example, the information about a validation process at the beginning and at the end of the validation is not the same. From these objects come the different variables available to create conditions or for use in emails or https requests actions.

Disclaimer: For objects such as a check, the same variables will not always be available for all checks, as they often depend on the dataset configuration and whether it is possible to calculate the variable in the country of the check or not.

List of events and their variables

Check created

It happens once the check has been successfully created and is ready to start processing, at which point it enters the queue for further processing.

VariableDescriptionPossible values / Examples
Check typeCheck type
person, vehicle, company or a custom type (example)
CountryCountry
ColombiaPeruBrazilChileMexicoEcuadorInternational
National IDNational ID
A national ID number (example)
Check IDCheck ID
CHCK123 (example)
Check started

When the check starts to be processed

VariableDescriptionPossible values / Examples
Check IDCheck ID
CHCK123 (example)
Check typeCheck type
person, vehicle, company or a custom type (example)
CountryCountry
ColombiaPeruBrazilChileMexicoEcuadorInternational
National IDNational ID
A national ID number (example)
Check delayed

When a check is delayed and we are retrying the check

VariableDescriptionPossible values / Examples
CountryCountry
ColombiaPeruBrazilChileMexicoEcuadorInternational
Check statusCheck status
CompletedErrorDelayed
GenderGender
FemaleMale
Identity statusIdentity status
FoundNot foundDead
Vehicle resultVehicle result
FoundNot found
Check IDCheck ID
CHCK123 (example)
Company statusCompany status
FoundNot found
Person resultPerson result
FoundNot found
Company resultCompany result
FoundNot found
Check scoreCheck score
value from 0.0 to 1.0 (example)
Check ID scoreCheck ID score
value from 0.0 to 1.0 (example)
Date of birthDate of birth
1992-08-02T00:00:00Z (example)
Vehicle statusVehicle status
FoundNot found
Check typeCheck type
person, vehicle, company or a custom type (example)
National IDNational ID
A national ID number (example)
Check finished

When we have the final response of the check

VariableDescriptionPossible values / Examples
Social Security typeSocial Security type
ContributorBeneficiary
BirthplaceBirthplace
CALI (example)
Person watchlist statusPerson watchlist status
FoundNot found
Vehicle statusVehicle status
FoundNot found
GenderGender
FemaleMale
Vehicle resultVehicle result
FoundNot found
Date of birthDate of birth
1992-08-02T00:00:00Z (example)
Person watchlistPerson watchlist
Búsqueda en medios GOOGLE RSSInter-American Development BankCia World LeadersCommon Position Terrorist EUConsolidated Screening ListsMost Wanted Fugitives by the DEADSS Most Wanted - Bureau of Diplomatic SecurityFBIReported in the EU financial systemGoogleOffice of Inspector General - ExclusionsOffshore Leaks Database - IntermediaresOffshore Leaks Database - OfficersOffshore Leaks Database - Offshore entitiesInterpol list of the most wantedEU list of the most wantedOffice of Foreign Assets Control - OFACOFSI Consolidated List Search (HMT Treasury List)U.S. Security and Exchange Commission (SEC)Most Wanted Secret ServiceUnited Nations Security Council Consolidate ListLista de terroristas de USAWorld Bank Debarred Firms
Legal representative nameLegal representative name
PEPITO PEREZ (example)
Date of birthDate of birth
1992-08-02T00:00:00Z (example)
GenderGender
FemaleMale
NationalityNationality
AustraliaAustriaAzerbaijanAlbaniaAlgeriaAmerican SamoaAnguillaAngolaAndorraAntarcticaAntigua and BarbudaNetherlands AntillesUnited Arab EmiratesArgentinaArmeniaArubaAfghanistanBahamasBangladeshBarbadosBahrainBelarusBelizeBelgiumBeninBermudaBulgariaBoliviaBosnia and HerzegovinaBotswanaBrazilBritish Indian Ocean TerritoryBrunei DarussalamBurkina FasoBurundiBhutanVanuatuHoly See (Vatican City State)United KingdomHungaryVenezuelaVirgin Islands BritishVirgin Islands USTimor-Leste (East Timor)VietnamGabonHaitiGuyanaGambiaGhanaGuadeloupeGuatemalaGuineaGuinea-BissauGermanyGibraltarHondurasHong Kong (Special Administrative Region of China)GrenadaGreenlandGreeceGeorgiaGuamDenmarkDemocratic Republic of the CongoDjiboutiDominicaDominican RepublicEgyptZambiaWestern SaharaZimbabweIsraelIndiaIndonesiaJordanIraqIran (Islamic Republic of)IrelandIcelandSpainItalyYemenKazakhstanCayman IslandsCambodiaCameroonCanadaQatarKenyaCyprusKiribatiChinaCocos (Keeling) IslandsColombiaComorosCongoDemocratic People`s Republic of KoreaRepublic of KoreaCosta RicaCote d`IvoireCubaKuwaitKyrgyzstanLao People`s Democratic RepublicLatviaLesothoLiberiaLebanonLibyan Arab JamahiriyaLithuaniaLiechtensteinLuxembourgMauritiusMauritaniaMadagascarMayotteMacau (Special Administrative Region of China)North Macedonia (Republic of North Macedonia)MalawiMalaysiaMaliMaldivesMaltaNorthern Mariana IslandsMoroccoMartiniqueMarshall IslandsMexicoMicronesia (Federated States of)MozambiqueMoldova (Republic of)MonacoMongoliaMontserratMyanmarNamibiaNauruNepalNigerNigeriaNetherlandsNicaraguaNiueNew ZealandNew CaledoniaNorwayOmanBouvet IslandIsle Of ManNorfolk IslandPitcairnChristmas IslandSaint HelenaWallis and Futuna IslandsHeard Island and McDonald IslandsCape VerdeCook IslandsSamoaSvalbard and Jan Mayen IslandsTurks and Caicos IslandsUnited States Minor Outlying IslandsPakistanPalauPalestinian Territory (Occupied)PanamaPapua New GuineaParaguayPeruPolandPortugalPuerto RicoReunionRussian FederationRwandaRomaniaEl SalvadorSan MarinoSao Tome and PrincipeSaudi ArabiaSwazilandSeychellesSenegalSaint Pierre and MiquelonSaint Vincent and the GrenadinesSaint Kitts and NevisSaint LuciaSingaporeSyrian Arab RepublicSlovakiaSloveniaUnited StatesSolomon IslandsSomaliaSudanSurinameSierra LeoneTajikistanTaiwan (Province of China)ThailandTanzania (United Republic of)TogoTokelauTongaTrinidad and TobagoTuvaluTunisiaTurkmenistanTurkeyUgandaUzbekistanUkraineUruguayFaroe IslandsFijiPhilippinesFinlandFalkland Islands (Malvinas)FranceFrench GuianaFrench PolynesiaFrench Southern TerritoriesCroatiaCentral African RepublicChadCzech RepublicChileSwitzerlandSwedenSri LankaEcuadorEquatorial GuineaEritreaEstoniaEthiopiaSouth AfricaYugoslaviaSouth Georgia and The South Sandwich IslandsJamaicaMontenegroSaint BarthelemySint Maarten DutchSerbiaAland IslandsBonaire, Sint Eustatius And SabaGuernseyJerseyCuracaoSaint Martin FrenchSouth SudanJapanKosovo
Company watchlist statusCompany watchlist status
FoundNot found
Company resultCompany result
FoundNot found
Person resultPerson result
FoundNot found
Credit scoreCredit score
457 (example)
Identity statusIdentity status
FoundNot foundDead
Phone behaviorPhone behavior
value from 0.0 to 1.0 (example)
Social Security statusSocial Security status
ActiveInactive
Company watchlistCompany watchlist
Búsqueda en medios GOOGLE RSSInter-American Development BankCia World LeadersCommon Position Terrorist EUConsolidated Screening ListsMost Wanted Fugitives by the DEADSS Most Wanted - Bureau of Diplomatic SecurityFBIReported in the EU financial systemGoogleOffice of Inspector General - ExclusionsOffshore Leaks Database - IntermediaresOffshore Leaks Database - OfficersOffshore Leaks Database - Offshore entitiesInterpol list of the most wantedEU list of the most wantedOffice of Foreign Assets Control - OFACOFSI Consolidated List Search (HMT Treasury List)U.S. Security and Exchange Commission (SEC)Most Wanted Secret ServiceUnited Nations Security Council Consolidate ListLista de terroristas de USAWorld Bank Debarred Firms
Phone carrierPhone carrier
claro (example)
Company nameCompany name
MI COMPANY NAME (example)
Identity statusIdentity status
FoundNot foundDead
Document statusDocument status
ActiveInactiveIrregularNot found
Check scoreCheck score
value from 0.0 to 1.0 (example)
Check statusCheck status
CompletedErrorDelayed
Check IDCheck ID
CHCK123 (example)
CountryCountry
ColombiaPeruBrazilChileMexicoEcuadorInternational
Phone trust levelPhone trust level
Very lowLowMediumHigh
Phone activation datePhone activation date
2020-04-01T00:00:00Z (example)
CountryCountry
ColombiaPeruBrazilChileMexicoEcuadorInternational
National IDNational ID
A national ID number (example)
Company addressCompany address
CARRERA XX No.XX-XX, BOGOTÁ, D.C., BOGOTÁ, D. C. (example)
Is politically exposedIs politically exposed
YesNo
Company statusCompany status
FoundNot found
Company statusCompany status
FoundNot found
Check ID scoreCheck ID score
value from 0.0 to 1.0 (example)
Full nameFull name
PEPITO PEREZ (example)
Check IDCheck ID
CHCK123 (example)
Check typeCheck type
person, vehicle, company or a custom type (example)
Check decision variables finished

When the variables of a check are ready and can be queried

VariableDescriptionPossible values / Examples
Date of birthDate of birth
1992-08-02T00:00:00Z (example)
Person watchlist statusPerson watchlist status
FoundNot found
Phone carrierPhone carrier
claro (example)
Phone behaviorPhone behavior
value from 0.0 to 1.0 (example)
Legal representative nameLegal representative name
PEPITO PEREZ (example)
Identity statusIdentity status
FoundNot foundDead
CountryCountry
ColombiaPeruBrazilChileMexicoEcuadorInternational
NationalityNationality
AustraliaAustriaAzerbaijanAlbaniaAlgeriaAmerican SamoaAnguillaAngolaAndorraAntarcticaAntigua and BarbudaNetherlands AntillesUnited Arab EmiratesArgentinaArmeniaArubaAfghanistanBahamasBangladeshBarbadosBahrainBelarusBelizeBelgiumBeninBermudaBulgariaBoliviaBosnia and HerzegovinaBotswanaBrazilBritish Indian Ocean TerritoryBrunei DarussalamBurkina FasoBurundiBhutanVanuatuHoly See (Vatican City State)United KingdomHungaryVenezuelaVirgin Islands BritishVirgin Islands USTimor-Leste (East Timor)VietnamGabonHaitiGuyanaGambiaGhanaGuadeloupeGuatemalaGuineaGuinea-BissauGermanyGibraltarHondurasHong Kong (Special Administrative Region of China)GrenadaGreenlandGreeceGeorgiaGuamDenmarkDemocratic Republic of the CongoDjiboutiDominicaDominican RepublicEgyptZambiaWestern SaharaZimbabweIsraelIndiaIndonesiaJordanIraqIran (Islamic Republic of)IrelandIcelandSpainItalyYemenKazakhstanCayman IslandsCambodiaCameroonCanadaQatarKenyaCyprusKiribatiChinaCocos (Keeling) IslandsColombiaComorosCongoDemocratic People`s Republic of KoreaRepublic of KoreaCosta RicaCote d`IvoireCubaKuwaitKyrgyzstanLao People`s Democratic RepublicLatviaLesothoLiberiaLebanonLibyan Arab JamahiriyaLithuaniaLiechtensteinLuxembourgMauritiusMauritaniaMadagascarMayotteMacau (Special Administrative Region of China)North Macedonia (Republic of North Macedonia)MalawiMalaysiaMaliMaldivesMaltaNorthern Mariana IslandsMoroccoMartiniqueMarshall IslandsMexicoMicronesia (Federated States of)MozambiqueMoldova (Republic of)MonacoMongoliaMontserratMyanmarNamibiaNauruNepalNigerNigeriaNetherlandsNicaraguaNiueNew ZealandNew CaledoniaNorwayOmanBouvet IslandIsle Of ManNorfolk IslandPitcairnChristmas IslandSaint HelenaWallis and Futuna IslandsHeard Island and McDonald IslandsCape VerdeCook IslandsSamoaSvalbard and Jan Mayen IslandsTurks and Caicos IslandsUnited States Minor Outlying IslandsPakistanPalauPalestinian Territory (Occupied)PanamaPapua New GuineaParaguayPeruPolandPortugalPuerto RicoReunionRussian FederationRwandaRomaniaEl SalvadorSan MarinoSao Tome and PrincipeSaudi ArabiaSwazilandSeychellesSenegalSaint Pierre and MiquelonSaint Vincent and the GrenadinesSaint Kitts and NevisSaint LuciaSingaporeSyrian Arab RepublicSlovakiaSloveniaUnited StatesSolomon IslandsSomaliaSudanSurinameSierra LeoneTajikistanTaiwan (Province of China)ThailandTanzania (United Republic of)TogoTokelauTongaTrinidad and TobagoTuvaluTunisiaTurkmenistanTurkeyUgandaUzbekistanUkraineUruguayFaroe IslandsFijiPhilippinesFinlandFalkland Islands (Malvinas)FranceFrench GuianaFrench PolynesiaFrench Southern TerritoriesCroatiaCentral African RepublicChadCzech RepublicChileSwitzerlandSwedenSri LankaEcuadorEquatorial GuineaEritreaEstoniaEthiopiaSouth AfricaYugoslaviaSouth Georgia and The South Sandwich IslandsJamaicaMontenegroSaint BarthelemySint Maarten DutchSerbiaAland IslandsBonaire, Sint Eustatius And SabaGuernseyJerseyCuracaoSaint Martin FrenchSouth SudanJapanKosovo
Social Security statusSocial Security status
ActiveInactive
Person watchlistPerson watchlist
Búsqueda en medios GOOGLE RSSInter-American Development BankCia World LeadersCommon Position Terrorist EUConsolidated Screening ListsMost Wanted Fugitives by the DEADSS Most Wanted - Bureau of Diplomatic SecurityFBIReported in the EU financial systemGoogleOffice of Inspector General - ExclusionsOffshore Leaks Database - IntermediaresOffshore Leaks Database - OfficersOffshore Leaks Database - Offshore entitiesInterpol list of the most wantedEU list of the most wantedOffice of Foreign Assets Control - OFACOFSI Consolidated List Search (HMT Treasury List)U.S. Security and Exchange Commission (SEC)Most Wanted Secret ServiceUnited Nations Security Council Consolidate ListLista de terroristas de USAWorld Bank Debarred Firms
Is politically exposedIs politically exposed
YesNo
Social Security typeSocial Security type
ContributorBeneficiary
Company watchlistCompany watchlist
Búsqueda en medios GOOGLE RSSInter-American Development BankCia World LeadersCommon Position Terrorist EUConsolidated Screening ListsMost Wanted Fugitives by the DEADSS Most Wanted - Bureau of Diplomatic SecurityFBIReported in the EU financial systemGoogleOffice of Inspector General - ExclusionsOffshore Leaks Database - IntermediaresOffshore Leaks Database - OfficersOffshore Leaks Database - Offshore entitiesInterpol list of the most wantedEU list of the most wantedOffice of Foreign Assets Control - OFACOFSI Consolidated List Search (HMT Treasury List)U.S. Security and Exchange Commission (SEC)Most Wanted Secret ServiceUnited Nations Security Council Consolidate ListLista de terroristas de USAWorld Bank Debarred Firms
Check IDCheck ID
CHCK123 (example)
BirthplaceBirthplace
CALI (example)
Company watchlist statusCompany watchlist status
FoundNot found
Company nameCompany name
MI COMPANY NAME (example)
Full nameFull name
PEPITO PEREZ (example)
Company statusCompany status
FoundNot found
Phone activation datePhone activation date
2020-04-01T00:00:00Z (example)
Company addressCompany address
CARRERA XX No.XX-XX, BOGOTÁ, D.C., BOGOTÁ, D. C. (example)
Document statusDocument status
ActiveInactiveIrregularNot found
GenderGender
FemaleMale
Phone trust levelPhone trust level
Very lowLowMediumHigh
Credit scoreCredit score
457 (example)
Continuous check changed

When you have the continuous check of a check active and there is a difference between the current check and the previous one.

User initiated conversation (inbound)

When a user sends a message to the bot to start a WhatsApp conversation

VariableDescriptionPossible values / Examples
User IDUser ID
any user id of your account: user_test (example)
Creation dateCreation date
2020-04-01T00:00:00Z (example)
Waba phone numberWaba phone number
+573132223333 (example)
Inbound messageInbound message
message from user (example)
Session IDSession ID
WDI1a2b2c3v (example)
Update DateUpdate Date
2020-04-01T00:00:00Z (example)
User phone numberUser phone number
+573131221324 (example)
Session statusSession status
ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation
Billing hubBilling hub
any billing hub name of your account (example)
Flow IDFlow ID
IPFb1b2h3 (example)
Inbound message sent (Outbound)

When a message is sent succesfully to start a Whatsapp conversation

VariableDescriptionPossible values / Examples
Session statusSession status
ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation
Billing hubBilling hub
any billing hub name of your account (example)
Flow IDFlow ID
IPF12345 (example)
Outbound IDOutbound ID
OTBd123ed (example)
Outbound messageOutbound message
campaign message (example)
User phone numberUser phone number
+573131221324 (example)
Session IDSession ID
WDI1a2b2c3v (example)
Creation dateCreation date
2020-04-01T00:00:00Z (example)
Update DateUpdate Date
2020-04-01T00:00:00Z (example)
Is notificationIs notification
YesNo
Waba phone numberWaba phone number
+573133453786 (example)
User IDUser ID
any user id of your account: user_test (example)
Inbound message accepted (Outbound)

When the user accepts the initial message and starts the conversation

VariableDescriptionPossible values / Examples
User phone numberUser phone number
+573131221324 (example)
Session statusSession status
ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation
Outbound IDOutbound ID
OTBd123ed (example)
Is notificationIs notification
YesNo
Outbound messageOutbound message
campaign message (example)
User IDUser ID
any user id of your account: user_test (example)
Session IDSession ID
WDI1a2b2c3v (example)
Billing hubBilling hub
any billing hub name of your account (example)
Flow IDFlow ID
IPF12345 (example)
Waba phone numberWaba phone number
+573133453786 (example)
Creation dateCreation date
2020-04-01T00:00:00Z (example)
Update DateUpdate Date
2020-04-01T00:00:00Z (example)
Inbound message cancelled (Outbound)

When the user does not accept the initial message and the conversation does not continue

VariableDescriptionPossible values / Examples
Creation dateCreation date
2020-04-01T00:00:00Z (example)
Update DateUpdate Date
2020-04-01T00:00:00Z (example)
User phone numberUser phone number
+573131221324 (example)
Session statusSession status
ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation
Billing hubBilling hub
any billing hub name of your account (example)
Flow IDFlow ID
IPF12345 (example)
Outbound IDOutbound ID
OTBd123ed (example)
User IDUser ID
any user id of your account: user_test (example)
Waba phone numberWaba phone number
+573133453786 (example)
Is notificationIs notification
YesNo
Outbound messageOutbound message
campaign message (example)
Session IDSession ID
WDI1a2b2c3v (example)
Truconnect notification sent

When a notification message is sent by WhatsApp

Truconnect process started

When the user initiates a WHATSAPP flow

VariableDescriptionPossible values / Examples
User IDUser ID
any user id of your account: user_test (example)
Session IDSession ID
WDI1a2b2c3v (example)
Creation dateCreation date
2020-04-01T00:00:00Z (example)
Update DateUpdate Date
2020-04-01T13:02:00Z (example)
User phone numberUser phone number
+573131221324 (example)
Session statusSession status
ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation
Billing hubBilling hub
any billing hub name of your account (example)
Truconnect process succeeded

When the WHATSAPP flow is completed or is successful according to the defined conditions.

VariableDescriptionPossible values / Examples
User phone numberUser phone number
+573131221324 (example)
Session statusSession status
ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation
Billing hubBilling hub
any billing hub name of your account (example)
User IDUser ID
any user id of your account: user_test (example)
Session IDSession ID
WDI1a2b2c3v (example)
Creation dateCreation date
2020-04-01T00:00:00Z (example)
Update DateUpdate Date
2020-04-01T13:02:00Z (example)
Truconnect process failed

When the WHATSAPP stream is not completed or fails according to the defined conditions

VariableDescriptionPossible values / Examples
Creation dateCreation date
2020-04-01T00:00:00Z (example)
Update DateUpdate Date
2020-04-01T13:02:00Z (example)
User phone numberUser phone number
+573131221324 (example)
Session statusSession status
ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation
Billing hubBilling hub
any billing hub name of your account (example)
User IDUser ID
any user id of your account: user_test (example)
Session IDSession ID
WDI1a2b2c3v (example)
Identity process created

When the user initiates a WEB flow

VariableDescriptionPossible values / Examples
Flow IDFlow ID
IPF12345 (example)
Flow versionFlow version
16 (example)
CountryCountry
ColombiaPeruBrazilChileMexicoEcuadorInternational
Identity process IDIdentity process ID
IDP1a2d2g (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
Identity process succeeded

When the result of the WEB flow is approved

VariableDescriptionPossible values / Examples
Flow IDFlow ID
IPF12345 (example)
Flow versionFlow version
16 (example)
CountryCountry
ColombiaPeruBrazilChileMexicoEcuadorInternational
Identity process IDIdentity process ID
IDP1a2d2g (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
Identity process failed

When the result of the WEB flow is failed

VariableDescriptionPossible values / Examples
Identity process IDIdentity process ID
IDP1a2d2g (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
Flow IDFlow ID
IPF12345 (example)
Flow versionFlow version
16 (example)
CountryCountry
ColombiaPeruBrazilChileMexicoEcuadorInternational
Validation failure statusValidation failure status
DeclinedSystem errorExpiredCanceled
Declined reasonDeclined reason
Wrong verification codeBad light conditionFile format not supportedActions not in expected orderNo face detectedPhoto of photoVideo too largeLiveness verification not passedPassive liveness verification not passedSimilarity threshold not passedFaces are too similarToo many incorrect answersInvalid ministryInvalid format for naturally fieldMissing legal institute perforationTraces of tamperingIrregular fontsMissing security elementsPortrait photo is fakeIncomplete documentIrregular alignmentsMissing accentsInconsistent delegate signatureDate of birth does not match with photoMissing origin documentMissing CPFInconsistent parent namesMissing registration numberMissing coat of armsDocument has different versionsInvalid image formatAge above thresholdInvalid inputs to create checkFront side document is a photocopyDocument has expiredDocument is a photocopyDocument is a photo of photoDocument not recognizedReverse side document is a photocopyFace not detectedFront document not foundData not match with government databaseDocument unregisteredGovernment database unavailableIdentity belongs to dead personImage face validation not passedImage text validation not passedInvalid curpInvalid postal codeInvalid issue dateInvalid mrzInvalid mrz formatInvalid document numberManual review failedMissing date of birthMissing document numberMissing expiration dateMissing genderMissing inputs to create checkMissing issue dateMissing issue numberMissing mrzMissing namesMissing streetMissing state nameMissing municipality nameMissin neighborhoodMissin pay limit dateMissin postal codeMissing nationalityMissing national registrarMissing production dataMissing textNational registrar inconsistencyOCR failureProduction data inconsistencyProduction data invalid formatReverse document not foundUnderageValidations failedPortrait photo illegiblePerforations illegibleMissing issue stateMissing issue agencyMissing issue deparmentItem not foundItem status disabledAudio already usedAudio exceeds maximum lengthIncomplete enrollmentInvalid file formatNo voice detectedPhrase does not matchSpeaker too loudSpeaker too quietVoice does not matchEmpty fileOCR no text detectedMax retries reachedFace not clearFraudster match client collectionFraudster match global collectionUser match client collectionCanceledRejected answer
Phone verification created

When phone validation has been created

Phone verification succeeded

When phone validation result is successful

Phone verification failed

When the phone validation result is unsuccessful

Face recognition created

When the face validation has been created

VariableDescriptionPossible values / Examples
Validation IDValidation ID
VLD123456 (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
IP addressIP address
192.238.183.167 (example)
Face recognition succeeded

When the face validation result is successful

VariableDescriptionPossible values / Examples
Identity process IDIdentity process ID
IDP1a2d2g (example)
UsernameUsername
any user name of your account: user_test (example)
Confidence scoreConfidence score
value from 0.0 to 1.0 (example)
Validation IDValidation ID
VLD123456 (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
ThresholdThreshold
value from 0.0 to 1.0 (example)
Face recognition failed

When the face validation result is failed

VariableDescriptionPossible values / Examples
Validation IDValidation ID
VLD123456 (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
ThresholdThreshold
value from 0.0 to 1.0 (example)
Identity process IDIdentity process ID
IDP1a2d2g (example)
Validation failure statusValidation failure status
DeclinedSystem errorExpiredCanceled
Declined reasonDeclined reason
Wrong verification codeBad light conditionFile format not supportedActions not in expected orderNo face detectedPhoto of photoVideo too largeLiveness verification not passedPassive liveness verification not passedSimilarity threshold not passedFaces are too similarToo many incorrect answersInvalid ministryInvalid format for naturally fieldMissing legal institute perforationTraces of tamperingIrregular fontsMissing security elementsPortrait photo is fakeIncomplete documentIrregular alignmentsMissing accentsInconsistent delegate signatureDate of birth does not match with photoMissing origin documentMissing CPFInconsistent parent namesMissing registration numberMissing coat of armsDocument has different versionsInvalid image formatAge above thresholdInvalid inputs to create checkFront side document is a photocopyDocument has expiredDocument is a photocopyDocument is a photo of photoDocument not recognizedReverse side document is a photocopyFace not detectedFront document not foundData not match with government databaseDocument unregisteredGovernment database unavailableIdentity belongs to dead personImage face validation not passedImage text validation not passedInvalid curpInvalid postal codeInvalid issue dateInvalid mrzInvalid mrz formatInvalid document numberManual review failedMissing date of birthMissing document numberMissing expiration dateMissing genderMissing inputs to create checkMissing issue dateMissing issue numberMissing mrzMissing namesMissing streetMissing state nameMissing municipality nameMissin neighborhoodMissin pay limit dateMissin postal codeMissing nationalityMissing national registrarMissing production dataMissing textNational registrar inconsistencyOCR failureProduction data inconsistencyProduction data invalid formatReverse document not foundUnderageValidations failedPortrait photo illegiblePerforations illegibleMissing issue stateMissing issue agencyMissing issue deparmentItem not foundItem status disabledAudio already usedAudio exceeds maximum lengthIncomplete enrollmentInvalid file formatNo voice detectedPhrase does not matchSpeaker too loudSpeaker too quietVoice does not matchEmpty fileOCR no text detectedMax retries reachedFace not clearFraudster match client collectionFraudster match global collectionUser match client collectionCanceledRejected answer
Email verification created

When email validation has been created

Email verification succeeded

When email validation results in success

Email verification failed

When email validation result is failed

Document validation succeeded

When the result of the document validation is successful.

VariableDescriptionPossible values / Examples
HeightHeight
1.78 (example)
NameName
PEPITO (example)
Validation IDValidation ID
VLD123456 (example)
GenderGender
FemaleMale
Issue dateIssue date
1950-09-13T00:00:00Z (example)
Document typeDocument type
National IDForeign IDPassportDriver licenseGeneral registrationCNHPEPPPTIdentity cardPicture IDInvoice
Date of birthDate of birth
1968-01-15T00:00:00Z (example)
Document numberDocument number
a document number 123456789 (example)
RHRH
O+O-A+A-B+B-AB+AB-
Account IDAccount ID
ACC1234 or a custom account ID (example)
BirthplaceBirthplace
BOGOTA D.C (CUNDINAMARCA) (example)
CountryCountry
ColombiaPeruBrazilChileMexicoEcuadorInternational
Expedition placeExpedition place
CALI (example)
Last nameLast name
GIRALDO RIOS (example)
Check IDCheck ID
CHCK123 (example)
Document validation failed

When the document validation result is failed

VariableDescriptionPossible values / Examples
Validation IDValidation ID
VLD123456 (example)
Date of birthDate of birth
1968-01-15T00:00:00Z (example)
Document numberDocument number
a document number 123456789 (example)
Expedition placeExpedition place
CALI (example)
GenderGender
FemaleMale
Last nameLast name
GIRALDO RIOS (example)
RHRH
O+O-A+A-B+B-AB+AB-
Validation failure statusValidation failure status
DeclinedSystem errorExpiredCanceled
CountryCountry
ColombiaPeruBrazilChileMexicoEcuadorInternational
HeightHeight
1.78 (example)
Issue dateIssue date
1950-09-13T00:00:00Z (example)
Declined reasonDeclined reason
Wrong verification codeBad light conditionFile format not supportedActions not in expected orderNo face detectedPhoto of photoVideo too largeLiveness verification not passedPassive liveness verification not passedSimilarity threshold not passedFaces are too similarToo many incorrect answersInvalid ministryInvalid format for naturally fieldMissing legal institute perforationTraces of tamperingIrregular fontsMissing security elementsPortrait photo is fakeIncomplete documentIrregular alignmentsMissing accentsInconsistent delegate signatureDate of birth does not match with photoMissing origin documentMissing CPFInconsistent parent namesMissing registration numberMissing coat of armsDocument has different versionsInvalid image formatAge above thresholdInvalid inputs to create checkFront side document is a photocopyDocument has expiredDocument is a photocopyDocument is a photo of photoDocument not recognizedReverse side document is a photocopyFace not detectedFront document not foundData not match with government databaseDocument unregisteredGovernment database unavailableIdentity belongs to dead personImage face validation not passedImage text validation not passedInvalid curpInvalid postal codeInvalid issue dateInvalid mrzInvalid mrz formatInvalid document numberManual review failedMissing date of birthMissing document numberMissing expiration dateMissing genderMissing inputs to create checkMissing issue dateMissing issue numberMissing mrzMissing namesMissing streetMissing state nameMissing municipality nameMissin neighborhoodMissin pay limit dateMissin postal codeMissing nationalityMissing national registrarMissing production dataMissing textNational registrar inconsistencyOCR failureProduction data inconsistencyProduction data invalid formatReverse document not foundUnderageValidations failedPortrait photo illegiblePerforations illegibleMissing issue stateMissing issue agencyMissing issue deparmentItem not foundItem status disabledAudio already usedAudio exceeds maximum lengthIncomplete enrollmentInvalid file formatNo voice detectedPhrase does not matchSpeaker too loudSpeaker too quietVoice does not matchEmpty fileOCR no text detectedMax retries reachedFace not clearFraudster match client collectionFraudster match global collectionUser match client collectionCanceledRejected answer
BirthplaceBirthplace
BOGOTA D.C (CUNDINAMARCA) (example)
Document typeDocument type
National IDForeign IDPassportDriver licenseGeneral registrationCNHPEPPPTIdentity cardPicture IDInvoice
NameName
PEPITO (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
Check IDCheck ID
CHCK123 (example)
Document validation created

When the document validation has been created

VariableDescriptionPossible values / Examples
Validation IDValidation ID
VLD123456 (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
Electronic signature created

When the electronic signature process has been created

Electronic signature succeeded

When the electronic signature was made within the time specified

Electronic signature failed

When the electronic signature was NOT made within the time specified

Face search enrolled

When report a face

VariableDescriptionPossible values / Examples
Creation dateCreation date
2020-04-01T00:00:00Z (example)
Update DateUpdate Date
2020-04-01T00:00:00Z (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
Fraud reasonFraud reason
Manipulated documentManipulated photoNon paymentCriminal company recordsFraudsterPolitically exposed personCriminal listUser registerOther
StatusStatus
PendingSuccessFailure
Validation typeValidation type
Identity questionsFace recognitionVoice recognitionEmail verificationPhone verificationDocument validationEnterprise dataFace searchElectronic signature
Identity process IDIdentity process ID
IDP1a2d2g (example)
Enrollment IDEnrollment ID
ENR1a2w3e (example)
Face search created

When a face validation has been created to search for matches on a reported basis

VariableDescriptionPossible values / Examples
Validation IDValidation ID
VLD123456 (example)
IP addressIP address
192.238.183.167. (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
Face search succeeded

When there is NO face match against a reported database

VariableDescriptionPossible values / Examples
Validation IDValidation ID
VLD123456 (example)
IP addressIP address
192.238.183.167. (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
ThresholdThreshold
value from 0.0 to 1.0 (example)
Face search failed

When there IS a face match against a reported database

VariableDescriptionPossible values / Examples
IP addressIP address
192.238.183.167. (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
Validation failure statusValidation failure status
DeclinedSystem errorExpiredCanceled
Declined reasonDeclined reason
Wrong verification codeBad light conditionFile format not supportedActions not in expected orderNo face detectedPhoto of photoVideo too largeLiveness verification not passedPassive liveness verification not passedSimilarity threshold not passedFaces are too similarToo many incorrect answersInvalid ministryInvalid format for naturally fieldMissing legal institute perforationTraces of tamperingIrregular fontsMissing security elementsPortrait photo is fakeIncomplete documentIrregular alignmentsMissing accentsInconsistent delegate signatureDate of birth does not match with photoMissing origin documentMissing CPFInconsistent parent namesMissing registration numberMissing coat of armsDocument has different versionsInvalid image formatAge above thresholdInvalid inputs to create checkFront side document is a photocopyDocument has expiredDocument is a photocopyDocument is a photo of photoDocument not recognizedReverse side document is a photocopyFace not detectedFront document not foundData not match with government databaseDocument unregisteredGovernment database unavailableIdentity belongs to dead personImage face validation not passedImage text validation not passedInvalid curpInvalid postal codeInvalid issue dateInvalid mrzInvalid mrz formatInvalid document numberManual review failedMissing date of birthMissing document numberMissing expiration dateMissing genderMissing inputs to create checkMissing issue dateMissing issue numberMissing mrzMissing namesMissing streetMissing state nameMissing municipality nameMissin neighborhoodMissin pay limit dateMissin postal codeMissing nationalityMissing national registrarMissing production dataMissing textNational registrar inconsistencyOCR failureProduction data inconsistencyProduction data invalid formatReverse document not foundUnderageValidations failedPortrait photo illegiblePerforations illegibleMissing issue stateMissing issue agencyMissing issue deparmentItem not foundItem status disabledAudio already usedAudio exceeds maximum lengthIncomplete enrollmentInvalid file formatNo voice detectedPhrase does not matchSpeaker too loudSpeaker too quietVoice does not matchEmpty fileOCR no text detectedMax retries reachedFace not clearFraudster match client collectionFraudster match global collectionUser match client collectionCanceledRejected answer
ThresholdThreshold
value from 0.0 to 1.0 (example)
Validation messageValidation message
validation message (example)
Fraudster enrollment IDFraudster enrollment ID
ENR1a2d3g (example)
Validation IDValidation ID
VLD123456 (example)
Face search enrollment deleted

When a reported face is deleted

VariableDescriptionPossible values / Examples
Creation dateCreation date
2020-04-01T00:00:00Z (example)
Update DateUpdate Date
2020-04-01T00:00:00Z (example)
Account IDAccount ID
ACC1234 or a custom account ID (example)
Fraud reasonFraud reason
Manipulated documentManipulated photoNon paymentCriminal company recordsFraudsterPolitically exposed personCriminal listUser registerOther
StatusStatus
PendingSuccessFailure
Validation typeValidation type
Identity questionsFace recognitionVoice recognitionEmail verificationPhone verificationDocument validationEnterprise dataFace searchElectronic signature
Identity process IDIdentity process ID
IDP1a2d2g (example)
Enrollment IDEnrollment ID
ENR1a2w3e (example)