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.
| Variable | Description | Possible values / Examples |
|---|---|---|
| Check type | Check type | person, vehicle, company or a custom type (example) |
| Country | Country | ColombiaPeruBrazilChileMexicoEcuadorInternational |
| National ID | National ID | A national ID number (example) |
| Check ID | Check ID | CHCK123 (example) |
Check started
When the check starts to be processed
| Variable | Description | Possible values / Examples |
|---|---|---|
| Check ID | Check ID | CHCK123 (example) |
| Check type | Check type | person, vehicle, company or a custom type (example) |
| Country | Country | ColombiaPeruBrazilChileMexicoEcuadorInternational |
| National ID | National ID | A national ID number (example) |
Check delayed
When a check is delayed and we are retrying the check
| Variable | Description | Possible values / Examples |
|---|---|---|
| Country | Country | ColombiaPeruBrazilChileMexicoEcuadorInternational |
| Check status | Check status | CompletedErrorDelayed |
| Gender | Gender | FemaleMale |
| Identity status | Identity status | FoundNot foundDead |
| Vehicle result | Vehicle result | FoundNot found |
| Check ID | Check ID | CHCK123 (example) |
| Company status | Company status | FoundNot found |
| Person result | Person result | FoundNot found |
| Company result | Company result | FoundNot found |
| Check score | Check score | value from 0.0 to 1.0 (example) |
| Check ID score | Check ID score | value from 0.0 to 1.0 (example) |
| Date of birth | Date of birth | 1992-08-02T00:00:00Z (example) |
| Vehicle status | Vehicle status | FoundNot found |
| Check type | Check type | person, vehicle, company or a custom type (example) |
| National ID | National ID | A national ID number (example) |
Check finished
When we have the final response of the check
| Variable | Description | Possible values / Examples |
|---|---|---|
| Social Security type | Social Security type | ContributorBeneficiary |
| Birthplace | Birthplace | CALI (example) |
| Person watchlist status | Person watchlist status | FoundNot found |
| Vehicle status | Vehicle status | FoundNot found |
| Gender | Gender | FemaleMale |
| Vehicle result | Vehicle result | FoundNot found |
| Date of birth | Date of birth | 1992-08-02T00:00:00Z (example) |
| Person watchlist | Person 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 name | Legal representative name | PEPITO PEREZ (example) |
| Date of birth | Date of birth | 1992-08-02T00:00:00Z (example) |
| Gender | Gender | FemaleMale |
| Nationality | Nationality | 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 status | Company watchlist status | FoundNot found |
| Company result | Company result | FoundNot found |
| Person result | Person result | FoundNot found |
| Credit score | Credit score | 457 (example) |
| Identity status | Identity status | FoundNot foundDead |
| Phone behavior | Phone behavior | value from 0.0 to 1.0 (example) |
| Social Security status | Social Security status | ActiveInactive |
| Company watchlist | Company 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 carrier | Phone carrier | claro (example) |
| Company name | Company name | MI COMPANY NAME (example) |
| Identity status | Identity status | FoundNot foundDead |
| Document status | Document status | ActiveInactiveIrregularNot found |
| Check score | Check score | value from 0.0 to 1.0 (example) |
| Check status | Check status | CompletedErrorDelayed |
| Check ID | Check ID | CHCK123 (example) |
| Country | Country | ColombiaPeruBrazilChileMexicoEcuadorInternational |
| Phone trust level | Phone trust level | Very lowLowMediumHigh |
| Phone activation date | Phone activation date | 2020-04-01T00:00:00Z (example) |
| Country | Country | ColombiaPeruBrazilChileMexicoEcuadorInternational |
| National ID | National ID | A national ID number (example) |
| Company address | Company address | CARRERA XX No.XX-XX, BOGOTÁ, D.C., BOGOTÁ, D. C. (example) |
| Is politically exposed | Is politically exposed | YesNo |
| Company status | Company status | FoundNot found |
| Company status | Company status | FoundNot found |
| Check ID score | Check ID score | value from 0.0 to 1.0 (example) |
| Full name | Full name | PEPITO PEREZ (example) |
| Check ID | Check ID | CHCK123 (example) |
| Check type | Check 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
| Variable | Description | Possible values / Examples |
|---|---|---|
| Date of birth | Date of birth | 1992-08-02T00:00:00Z (example) |
| Person watchlist status | Person watchlist status | FoundNot found |
| Phone carrier | Phone carrier | claro (example) |
| Phone behavior | Phone behavior | value from 0.0 to 1.0 (example) |
| Legal representative name | Legal representative name | PEPITO PEREZ (example) |
| Identity status | Identity status | FoundNot foundDead |
| Country | Country | ColombiaPeruBrazilChileMexicoEcuadorInternational |
| Nationality | Nationality | 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 status | Social Security status | ActiveInactive |
| Person watchlist | Person 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 exposed | Is politically exposed | YesNo |
| Social Security type | Social Security type | ContributorBeneficiary |
| Company watchlist | Company 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 ID | Check ID | CHCK123 (example) |
| Birthplace | Birthplace | CALI (example) |
| Company watchlist status | Company watchlist status | FoundNot found |
| Company name | Company name | MI COMPANY NAME (example) |
| Full name | Full name | PEPITO PEREZ (example) |
| Company status | Company status | FoundNot found |
| Phone activation date | Phone activation date | 2020-04-01T00:00:00Z (example) |
| Company address | Company address | CARRERA XX No.XX-XX, BOGOTÁ, D.C., BOGOTÁ, D. C. (example) |
| Document status | Document status | ActiveInactiveIrregularNot found |
| Gender | Gender | FemaleMale |
| Phone trust level | Phone trust level | Very lowLowMediumHigh |
| Credit score | Credit 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
| Variable | Description | Possible values / Examples |
|---|---|---|
| User ID | User ID | any user id of your account: user_test (example) |
| Creation date | Creation date | 2020-04-01T00:00:00Z (example) |
| Waba phone number | Waba phone number | +573132223333 (example) |
| Inbound message | Inbound message | message from user (example) |
| Session ID | Session ID | WDI1a2b2c3v (example) |
| Update Date | Update Date | 2020-04-01T00:00:00Z (example) |
| User phone number | User phone number | +573131221324 (example) |
| Session status | Session status | ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation |
| Billing hub | Billing hub | any billing hub name of your account (example) |
| Flow ID | Flow ID | IPFb1b2h3 (example) |
Inbound message sent (Outbound)
When a message is sent succesfully to start a Whatsapp conversation
| Variable | Description | Possible values / Examples |
|---|---|---|
| Session status | Session status | ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation |
| Billing hub | Billing hub | any billing hub name of your account (example) |
| Flow ID | Flow ID | IPF12345 (example) |
| Outbound ID | Outbound ID | OTBd123ed (example) |
| Outbound message | Outbound message | campaign message (example) |
| User phone number | User phone number | +573131221324 (example) |
| Session ID | Session ID | WDI1a2b2c3v (example) |
| Creation date | Creation date | 2020-04-01T00:00:00Z (example) |
| Update Date | Update Date | 2020-04-01T00:00:00Z (example) |
| Is notification | Is notification | YesNo |
| Waba phone number | Waba phone number | +573133453786 (example) |
| User ID | User 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
| Variable | Description | Possible values / Examples |
|---|---|---|
| User phone number | User phone number | +573131221324 (example) |
| Session status | Session status | ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation |
| Outbound ID | Outbound ID | OTBd123ed (example) |
| Is notification | Is notification | YesNo |
| Outbound message | Outbound message | campaign message (example) |
| User ID | User ID | any user id of your account: user_test (example) |
| Session ID | Session ID | WDI1a2b2c3v (example) |
| Billing hub | Billing hub | any billing hub name of your account (example) |
| Flow ID | Flow ID | IPF12345 (example) |
| Waba phone number | Waba phone number | +573133453786 (example) |
| Creation date | Creation date | 2020-04-01T00:00:00Z (example) |
| Update Date | Update 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
| Variable | Description | Possible values / Examples |
|---|---|---|
| Creation date | Creation date | 2020-04-01T00:00:00Z (example) |
| Update Date | Update Date | 2020-04-01T00:00:00Z (example) |
| User phone number | User phone number | +573131221324 (example) |
| Session status | Session status | ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation |
| Billing hub | Billing hub | any billing hub name of your account (example) |
| Flow ID | Flow ID | IPF12345 (example) |
| Outbound ID | Outbound ID | OTBd123ed (example) |
| User ID | User ID | any user id of your account: user_test (example) |
| Waba phone number | Waba phone number | +573133453786 (example) |
| Is notification | Is notification | YesNo |
| Outbound message | Outbound message | campaign message (example) |
| Session ID | Session ID | WDI1a2b2c3v (example) |
Truconnect notification sent
When a notification message is sent by WhatsApp
Truconnect process started
When the user initiates a WHATSAPP flow
| Variable | Description | Possible values / Examples |
|---|---|---|
| User ID | User ID | any user id of your account: user_test (example) |
| Session ID | Session ID | WDI1a2b2c3v (example) |
| Creation date | Creation date | 2020-04-01T00:00:00Z (example) |
| Update Date | Update Date | 2020-04-01T13:02:00Z (example) |
| User phone number | User phone number | +573131221324 (example) |
| Session status | Session status | ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation |
| Billing hub | Billing 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.
| Variable | Description | Possible values / Examples |
|---|---|---|
| User phone number | User phone number | +573131221324 (example) |
| Session status | Session status | ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation |
| Billing hub | Billing hub | any billing hub name of your account (example) |
| User ID | User ID | any user id of your account: user_test (example) |
| Session ID | Session ID | WDI1a2b2c3v (example) |
| Creation date | Creation date | 2020-04-01T00:00:00Z (example) |
| Update Date | Update Date | 2020-04-01T13:02:00Z (example) |
Truconnect process failed
When the WHATSAPP stream is not completed or fails according to the defined conditions
| Variable | Description | Possible values / Examples |
|---|---|---|
| Creation date | Creation date | 2020-04-01T00:00:00Z (example) |
| Update Date | Update Date | 2020-04-01T13:02:00Z (example) |
| User phone number | User phone number | +573131221324 (example) |
| Session status | Session status | ProcessingWaiting user responseFinishedWaiting for outbound responseWaiting for follow up responseWaiting for integration finishWaiting for integration creation |
| Billing hub | Billing hub | any billing hub name of your account (example) |
| User ID | User ID | any user id of your account: user_test (example) |
| Session ID | Session ID | WDI1a2b2c3v (example) |
Identity process created
When the user initiates a WEB flow
| Variable | Description | Possible values / Examples |
|---|---|---|
| Flow ID | Flow ID | IPF12345 (example) |
| Flow version | Flow version | 16 (example) |
| Country | Country | ColombiaPeruBrazilChileMexicoEcuadorInternational |
| Identity process ID | Identity process ID | IDP1a2d2g (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
Identity process succeeded
When the result of the WEB flow is approved
| Variable | Description | Possible values / Examples |
|---|---|---|
| Flow ID | Flow ID | IPF12345 (example) |
| Flow version | Flow version | 16 (example) |
| Country | Country | ColombiaPeruBrazilChileMexicoEcuadorInternational |
| Identity process ID | Identity process ID | IDP1a2d2g (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
Identity process failed
When the result of the WEB flow is failed
| Variable | Description | Possible values / Examples |
|---|---|---|
| Identity process ID | Identity process ID | IDP1a2d2g (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
| Flow ID | Flow ID | IPF12345 (example) |
| Flow version | Flow version | 16 (example) |
| Country | Country | ColombiaPeruBrazilChileMexicoEcuadorInternational |
| Validation failure status | Validation failure status | DeclinedSystem errorExpiredCanceled |
| Declined reason | Declined 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
| Variable | Description | Possible values / Examples |
|---|---|---|
| Validation ID | Validation ID | VLD123456 (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
| IP address | IP address | 192.238.183.167 (example) |
Face recognition succeeded
When the face validation result is successful
| Variable | Description | Possible values / Examples |
|---|---|---|
| Identity process ID | Identity process ID | IDP1a2d2g (example) |
| Username | Username | any user name of your account: user_test (example) |
| Confidence score | Confidence score | value from 0.0 to 1.0 (example) |
| Validation ID | Validation ID | VLD123456 (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
| Threshold | Threshold | value from 0.0 to 1.0 (example) |
Face recognition failed
When the face validation result is failed
| Variable | Description | Possible values / Examples |
|---|---|---|
| Validation ID | Validation ID | VLD123456 (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
| Threshold | Threshold | value from 0.0 to 1.0 (example) |
| Identity process ID | Identity process ID | IDP1a2d2g (example) |
| Validation failure status | Validation failure status | DeclinedSystem errorExpiredCanceled |
| Declined reason | Declined 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.
| Variable | Description | Possible values / Examples |
|---|---|---|
| Height | Height | 1.78 (example) |
| Name | Name | PEPITO (example) |
| Validation ID | Validation ID | VLD123456 (example) |
| Gender | Gender | FemaleMale |
| Issue date | Issue date | 1950-09-13T00:00:00Z (example) |
| Document type | Document type | National IDForeign IDPassportDriver licenseGeneral registrationCNHPEPPPTIdentity cardPicture IDInvoice |
| Date of birth | Date of birth | 1968-01-15T00:00:00Z (example) |
| Document number | Document number | a document number 123456789 (example) |
| RH | RH | O+O-A+A-B+B-AB+AB- |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
| Birthplace | Birthplace | BOGOTA D.C (CUNDINAMARCA) (example) |
| Country | Country | ColombiaPeruBrazilChileMexicoEcuadorInternational |
| Expedition place | Expedition place | CALI (example) |
| Last name | Last name | GIRALDO RIOS (example) |
| Check ID | Check ID | CHCK123 (example) |
Document validation failed
When the document validation result is failed
| Variable | Description | Possible values / Examples |
|---|---|---|
| Validation ID | Validation ID | VLD123456 (example) |
| Date of birth | Date of birth | 1968-01-15T00:00:00Z (example) |
| Document number | Document number | a document number 123456789 (example) |
| Expedition place | Expedition place | CALI (example) |
| Gender | Gender | FemaleMale |
| Last name | Last name | GIRALDO RIOS (example) |
| RH | RH | O+O-A+A-B+B-AB+AB- |
| Validation failure status | Validation failure status | DeclinedSystem errorExpiredCanceled |
| Country | Country | ColombiaPeruBrazilChileMexicoEcuadorInternational |
| Height | Height | 1.78 (example) |
| Issue date | Issue date | 1950-09-13T00:00:00Z (example) |
| Declined reason | Declined 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 |
| Birthplace | Birthplace | BOGOTA D.C (CUNDINAMARCA) (example) |
| Document type | Document type | National IDForeign IDPassportDriver licenseGeneral registrationCNHPEPPPTIdentity cardPicture IDInvoice |
| Name | Name | PEPITO (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
| Check ID | Check ID | CHCK123 (example) |
Document validation created
When the document validation has been created
| Variable | Description | Possible values / Examples |
|---|---|---|
| Validation ID | Validation ID | VLD123456 (example) |
| Account ID | Account 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
| Variable | Description | Possible values / Examples |
|---|---|---|
| Creation date | Creation date | 2020-04-01T00:00:00Z (example) |
| Update Date | Update Date | 2020-04-01T00:00:00Z (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
| Fraud reason | Fraud reason | Manipulated documentManipulated photoNon paymentCriminal company recordsFraudsterPolitically exposed personCriminal listUser registerOther |
| Status | Status | PendingSuccessFailure |
| Validation type | Validation type | Identity questionsFace recognitionVoice recognitionEmail verificationPhone verificationDocument validationEnterprise dataFace searchElectronic signature |
| Identity process ID | Identity process ID | IDP1a2d2g (example) |
| Enrollment ID | Enrollment ID | ENR1a2w3e (example) |
Face search created
When a face validation has been created to search for matches on a reported basis
| Variable | Description | Possible values / Examples |
|---|---|---|
| Validation ID | Validation ID | VLD123456 (example) |
| IP address | IP address | 192.238.183.167. (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
Face search succeeded
When there is NO face match against a reported database
| Variable | Description | Possible values / Examples |
|---|---|---|
| Validation ID | Validation ID | VLD123456 (example) |
| IP address | IP address | 192.238.183.167. (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
| Threshold | Threshold | value from 0.0 to 1.0 (example) |
Face search failed
When there IS a face match against a reported database
| Variable | Description | Possible values / Examples |
|---|---|---|
| IP address | IP address | 192.238.183.167. (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
| Validation failure status | Validation failure status | DeclinedSystem errorExpiredCanceled |
| Declined reason | Declined 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 |
| Threshold | Threshold | value from 0.0 to 1.0 (example) |
| Validation message | Validation message | validation message (example) |
| Fraudster enrollment ID | Fraudster enrollment ID | ENR1a2d3g (example) |
| Validation ID | Validation ID | VLD123456 (example) |
Face search enrollment deleted
When a reported face is deleted
| Variable | Description | Possible values / Examples |
|---|---|---|
| Creation date | Creation date | 2020-04-01T00:00:00Z (example) |
| Update Date | Update Date | 2020-04-01T00:00:00Z (example) |
| Account ID | Account ID | ACC1234 or a custom account ID (example) |
| Fraud reason | Fraud reason | Manipulated documentManipulated photoNon paymentCriminal company recordsFraudsterPolitically exposed personCriminal listUser registerOther |
| Status | Status | PendingSuccessFailure |
| Validation type | Validation type | Identity questionsFace recognitionVoice recognitionEmail verificationPhone verificationDocument validationEnterprise dataFace searchElectronic signature |
| Identity process ID | Identity process ID | IDP1a2d2g (example) |
| Enrollment ID | Enrollment ID | ENR1a2w3e (example) |
