KYC Transaction Flow Before transaction starts Before starting each transaction, it is necessary to consume the FindByNumberIdSuccess service to verify the enrollment of a document number. This service is crucial because it allows us to define the flow to follow in order to verify the person's identity. In this process, the FindByNumberIdSuccess service searches for information related to a specific document number, confirming whether the person associated with that document is properly enrolled or not. /api/{projectName}/FindByNumberIdSuccess Parameters projectName : The assigned project name apiKey : The key assigned to the project identification : The client's identification number docType : Type of document to be queried returnImages : Determine if the images from the transaction will be returned enrol : Default value : false Authorization : OAuth validation token Responses 200 - Successful query { "Uid": "string", "StartingDate": "2024-10-08T19:17:13.860Z", "CreationDate": "2024-10-08T19:17:13.860Z", "CreationIP": "string", "DocumentType": 0, "IdNumber": "string", "FirstName": "string", "SecondName": "string", "FirstSurname": "string", "SecondSurname": "string", "Gender": "string", "BirthDate": "2024-10-08T19:17:13.860Z", "Street": "string", "CedulateCondition": "string", "Spouse": "string", "Home": "string", "MaritalStatus": "string", "DateOfIdentification": "2024-10-08T19:17:13.860Z", "DateOfDeath": "2024-10-08T19:17:13.860Z", "MarriageDate": "2024-10-08T19:17:13.860Z", "Instruction": "string", "PlaceBirth": "string", "Nationality": "string", "MotherName": "string", "FatherName": "string", "HouseNumber": "string", "Profession": "string", "ExpeditionCity": "string", "ExpeditionDepartment": "string", "BirthCity": "string", "BirthDepartment": "string", "TransactionType": 0, "TransactionTypeName": "string", "IssueDate": "string", "BarcodeText": "string", "OcrTextSideOne": "string", "OcrTextSideTwo": "string", "SideOneWrongAttempts": 0, "SideTwoWrongAttempts": 0, "FoundOnAdoAlert": true, "AdoProjectId": "string", "TransactionId": "string", "ProductId": "string", "ComparationFacesSuccesful": true, "FaceFound": true, "FaceDocumentFrontFound": true, "BarcodeFound": true, "ResultComparationFaces": 0, "ResultCompareDocumentFaces": 0, "ComparationFacesAproved": true, "ThresholdCompareDocumentFaces": 0, "CompareFacesDocumentResult": "string", "Extras": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "NumberPhone": "string", "CodFingerprint": "string", "ResultQRCode": "string", "DactilarCode": "string", "ReponseControlList": "string", "Latitude": "string", "Longitude": "string", "Images": [ { "Id": 0, "ImageTypeId": 0, "ImageTypeName": "string", "Image": "string", "DownloadCode": "string" } ], "SignedDocuments": [ "string" ], "Scores": [ { "Id": 0, "UserName": "string", "StateName": "string", "CausalRejectionName": "string", "StartingDate": "2024-10-08T19:17:13.860Z", "Observation": "string" } ], "Response_ANI": { "Niup": "string", "FirstSurname": "string", "Particle": "string", "SecondSurname": "string", "FirstName": "string", "SecondName": "string", "ExpeditionMunicipality": "string", "ExpeditionDepartment": "string", "ExpeditionDate": "string", "CedulaState": "string" }, "Parameters": "string", "StateSignatureDocument": true, "SessionId": "string", "CustomerIdFromClient": "string", "ProcessId": "string", "DocumentTypeFromClient": 0, "IdNumberFromClient": "string", "NotEnrolledForComparisonWithClientData": true } Unenrolled client /api/{projectName}/GetConfig Parameters projectName : The assigned project name apiKey : The key assigned to the project productId Message : Information for event logging Responses 200 - Configuration results { "TryLiveness": 0, "Token_KYC": "string", "UrlServiceOCR": "string", "UrlServiceLiveness": "string", "UrlNewServiceLiveness": "string", "UrlServiceLivenessV3": "string", "UrlUiLivenessV3": "string", "CodeTransactionLivenessV3": "string", "ConfigFileLiveness": "string", "ConfigGeneralFileLiveness": "string", "LivenessThreshold": "string", "TypeLiveness": 0, "ProjectName": "string", "ApiKey": "string", "Base_Uri": "string", "TryOcr": 0, "GetGeoreference": 0, "GetToken": "string", "SecondCamera": true, "Web": true, "Android": true, "IOS": true, "Web_Component": true, "Android_Component": true, "IOS_Component": true, "MethodOfCaptureFingers": 0, "UseCardCaptureOnline": true, "UrlCardCapture": "string", "AttepmtsCardCapture": 0, "GetFacialFeatures": true, "CardCaptureType": 0, "UrlCardCaptureV2": "string", "TraceUrl": "string", "RequireCameraPermission": true, "RequireLocationPermission": true, "ConfigurationUI": { "LivenessUI": { "Id": 0, "LookLeftText": "string", "LookRightText": "string", "LookAtCenterText": "string", "InitialAlignFaceText": "string", "OngoingAlignFaceText": "string", "MultipleFacesFoundText": "string", "GetFurtherText": "string", "ComeCloserText": "string", "ProcessingDataText": "string", "SessionEndedSuccessfullyText": "string", "FaceIlluminationTooBrightText": "string", "FaceIlluminationTooDarkText": "string", "BadFaceFocusText": "string", "FacePositionNotStableText": "string", "UnderlineColorResource": "string", "LoaderColorResource": "string", "BackArrowColorResource": "string", "DirectingArrowsColor": "string", "SuccessSignColor": "string", "SuccessSignBackgroundColor": "string", "InstructionsPosition": 0, "DirectionSignShape": 0, "BackButtonShape": 0, "BackButtonSide": 0 }, "CardCaptureUI": { "Id": 0, "CaptureFrontInstructionsText": "string", "CaptureBackInstructionsText": "string", "MainColor": "string", "BackArrowColor": "string", "InstructionsColor": "string", "InstructionsBackgroundColor": "string", "BackArrowShape": 0, "InstructionsPosition": 0, "BackArrowSide": 0 } } } /api/Integration/{projectName}/Validation/New Parameters transactionInfo (body) : The data of the new transaction apiKey (header) : The key assigned to the project projectName (path) : The assigned project name Authorization (header) : OAuth validation token Body example { "ProductId": 0, "CustomerPhoto": "string", "DocumentType": "string", "longitude": "string", "Latitude": "string", "IdAssociated": "string", "ClientRole": "string", "KeyProcessLiveness": "string", "UIdDevice": "string", "IdUser": 0, "SourceDevice": 0, "SdkVersion": "string", "OS": "string", "BrowserVersion": "string", "IMEI": "string", "RiskId": "string", "OriginTransactionId": "string", "Score": "string", "UserName": "string", "ProjectName": "string", "SessionId": "string", "CustomerIdFromClient": "string", "ProcessId": "string", "DocumentTypeFromClient": 0, "IdNumberFromClient": "string", "Uid": "string" } Responses 200 - The transaction has been successfully initiated. An object with associated information is returned 201 - Facial recognition has been successful. An object is returned with information about the created transaction, including the unique transaction number { "Uid": "string", "StartingDate": "2024-10-08T19:48:17.558Z", "CreationDate": "2024-10-08T19:48:17.558Z", "CreationIP": "string", "DocumentType": 0, "IdNumber": "string", "FirstName": "string", "SecondName": "string", "FirstSurname": "string", "SecondSurname": "string", "Gender": "string", "BirthDate": "2024-10-08T19:48:17.558Z", "Street": "string", "CedulateCondition": "string", "Spouse": "string", "Home": "string", "MaritalStatus": "string", "DateOfIdentification": "2024-10-08T19:48:17.558Z", "DateOfDeath": "2024-10-08T19:48:17.558Z", "MarriageDate": "2024-10-08T19:48:17.558Z", "Instruction": "string", "PlaceBirth": "string", "Nationality": "string", "MotherName": "string", "FatherName": "string", "HouseNumber": "string", "Profession": "string", "ExpeditionCity": "string", "ExpeditionDepartment": "string", "BirthCity": "string", "BirthDepartment": "string", "TransactionType": 0, "TransactionTypeName": "string", "IssueDate": "string", "BarcodeText": "string", "OcrTextSideOne": "string", "OcrTextSideTwo": "string", "SideOneWrongAttempts": 0, "SideTwoWrongAttempts": 0, "FoundOnAdoAlert": true, "AdoProjectId": "string", "TransactionId": "string", "ProductId": "string", "ComparationFacesSuccesful": true, "FaceFound": true, "FaceDocumentFrontFound": true, "BarcodeFound": true, "ResultComparationFaces": 0, "ResultCompareDocumentFaces": 0, "ComparationFacesAproved": true, "ThresholdCompareDocumentFaces": 0, "CompareFacesDocumentResult": "string", "Extras": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "NumberPhone": "string", "CodFingerprint": "string", "ResultQRCode": "string", "DactilarCode": "string", "ReponseControlList": "string", "Latitude": "string", "Longitude": "string", "Images": [ { "Id": 0, "ImageTypeId": 0, "ImageTypeName": "string", "Image": "string", "DownloadCode": "string" } ], "SignedDocuments": [ "string" ], "Scores": [ { "Id": 0, "UserName": "string", "StateName": "string", "CausalRejectionName": "string", "StartingDate": "2024-10-08T19:48:17.558Z", "Observation": "string" } ], "Response_ANI": { "Niup": "string", "FirstSurname": "string", "Particle": "string", "SecondSurname": "string", "FirstName": "string", "SecondName": "string", "ExpeditionMunicipality": "string", "ExpeditionDepartment": "string", "ExpeditionDate": "string", "CedulaState": "string" }, "Parameters": "string", "StateSignatureDocument": true, "SessionId": "string", "CustomerIdFromClient": "string", "ProcessId": "string", "DocumentTypeFromClient": 0, "IdNumberFromClient": "string", "NotEnrolledForComparisonWithClientData": true } /api/Integration/{projectName}/Validation/Images/DocumentFrontSide Parameters sideOneInfo (body) : The image encoded in base64 apiKey (header) : The key assigned to the project projectName (path) : The assigned project name Authorization (header) : OAuth validation token Body example { "Image": "string", "DocumentType": "string", "UIdDevice": "string", "IdUser": 0, "SourceDevice": 0, "SdkVersion": "string", "OS": "string", "BrowserVersion": "string", "TransactionType": 0, "ProductId": "string", "Uid": "string", "RiskId": "string" } Responses 200 - The document has been successfully uploaded, and the transaction information has been updated 201 - The previously registered client was found. An object is returned with information about the created transaction, including the unique transaction number { "Uid": "string", "StartingDate": "2024-10-08T19:59:17.674Z", "CreationDate": "2024-10-08T19:59:17.674Z", "CreationIP": "string", "DocumentType": 0, "IdNumber": "string", "FirstName": "string", "SecondName": "string", "FirstSurname": "string", "SecondSurname": "string", "Gender": "string", "BirthDate": "2024-10-08T19:59:17.674Z", "Street": "string", "CedulateCondition": "string", "Spouse": "string", "Home": "string", "MaritalStatus": "string", "DateOfIdentification": "2024-10-08T19:59:17.674Z", "DateOfDeath": "2024-10-08T19:59:17.674Z", "MarriageDate": "2024-10-08T19:59:17.674Z", "Instruction": "string", "PlaceBirth": "string", "Nationality": "string", "MotherName": "string", "FatherName": "string", "HouseNumber": "string", "Profession": "string", "ExpeditionCity": "string", "ExpeditionDepartment": "string", "BirthCity": "string", "BirthDepartment": "string", "TransactionType": 0, "TransactionTypeName": "string", "IssueDate": "string", "BarcodeText": "string", "OcrTextSideOne": "string", "OcrTextSideTwo": "string", "SideOneWrongAttempts": 0, "SideTwoWrongAttempts": 0, "FoundOnAdoAlert": true, "AdoProjectId": "string", "TransactionId": "string", "ProductId": "string", "ComparationFacesSuccesful": true, "FaceFound": true, "FaceDocumentFrontFound": true, "BarcodeFound": true, "ResultComparationFaces": 0, "ResultCompareDocumentFaces": 0, "ComparationFacesAproved": true, "ThresholdCompareDocumentFaces": 0, "CompareFacesDocumentResult": "string", "Extras": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "NumberPhone": "string", "CodFingerprint": "string", "ResultQRCode": "string", "DactilarCode": "string", "ReponseControlList": "string", "Latitude": "string", "Longitude": "string", "Images": [ { "Id": 0, "ImageTypeId": 0, "ImageTypeName": "string", "Image": "string", "DownloadCode": "string" } ], "SignedDocuments": [ "string" ], "Scores": [ { "Id": 0, "UserName": "string", "StateName": "string", "CausalRejectionName": "string", "StartingDate": "2024-10-08T19:59:17.674Z", "Observation": "string" } ], "Response_ANI": { "Niup": "string", "FirstSurname": "string", "Particle": "string", "SecondSurname": "string", "FirstName": "string", "SecondName": "string", "ExpeditionMunicipality": "string", "ExpeditionDepartment": "string", "ExpeditionDate": "string", "CedulaState": "string" }, "Parameters": "string", "StateSignatureDocument": true, "SessionId": "string", "CustomerIdFromClient": "string", "ProcessId": "string", "DocumentTypeFromClient": 0, "IdNumberFromClient": "string", "NotEnrolledForComparisonWithClientData": true } /api/Integration/{projectName}/Validation/Images/DocumentBackSide Parameters sideOneInfo (body) : The image encoded in base64 apiKey (header) : The key assigned to the project projectName (path) : The assigned project name Authorization (header) : OAuth validation token Body example { "Image": "string", "DocumentType": "string", "UIdDevice": "string", "IdUser": 0, "SourceDevice": 0, "SdkVersion": "string", "OS": "string", "BrowserVersion": "string", "TransactionType": 0, "ProductId": "string", "Uid": "string", "RiskId": "string" } Responses 200 - The document has been successfully uploaded, and the transaction information has been updated 201 - The previously registered client was found. An object is returned with information about the created transaction, including the unique transaction number { "Uid": "string", "StartingDate": "2024-10-08T19:48:17.494Z", "CreationDate": "2024-10-08T19:48:17.494Z", "CreationIP": "string", "DocumentType": 0, "IdNumber": "string", "FirstName": "string", "SecondName": "string", "FirstSurname": "string", "SecondSurname": "string", "Gender": "string", "BirthDate": "2024-10-08T19:48:17.494Z", "Street": "string", "CedulateCondition": "string", "Spouse": "string", "Home": "string", "MaritalStatus": "string", "DateOfIdentification": "2024-10-08T19:48:17.494Z", "DateOfDeath": "2024-10-08T19:48:17.494Z", "MarriageDate": "2024-10-08T19:48:17.494Z", "Instruction": "string", "PlaceBirth": "string", "Nationality": "string", "MotherName": "string", "FatherName": "string", "HouseNumber": "string", "Profession": "string", "ExpeditionCity": "string", "ExpeditionDepartment": "string", "BirthCity": "string", "BirthDepartment": "string", "TransactionType": 0, "TransactionTypeName": "string", "IssueDate": "string", "BarcodeText": "string", "OcrTextSideOne": "string", "OcrTextSideTwo": "string", "SideOneWrongAttempts": 0, "SideTwoWrongAttempts": 0, "FoundOnAdoAlert": true, "AdoProjectId": "string", "TransactionId": "string", "ProductId": "string", "ComparationFacesSuccesful": true, "FaceFound": true, "FaceDocumentFrontFound": true, "BarcodeFound": true, "ResultComparationFaces": 0, "ResultCompareDocumentFaces": 0, "ComparationFacesAproved": true, "ThresholdCompareDocumentFaces": 0, "CompareFacesDocumentResult": "string", "Extras": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "NumberPhone": "string", "CodFingerprint": "string", "ResultQRCode": "string", "DactilarCode": "string", "ReponseControlList": "string", "Latitude": "string", "Longitude": "string", "Images": [ { "Id": 0, "ImageTypeId": 0, "ImageTypeName": "string", "Image": "string", "DownloadCode": "string" } ], "SignedDocuments": [ "string" ], "Scores": [ { "Id": 0, "UserName": "string", "StateName": "string", "CausalRejectionName": "string", "StartingDate": "2024-10-08T19:48:17.494Z", "Observation": "string" } ], "Response_ANI": { "Niup": "string", "FirstSurname": "string", "Particle": "string", "SecondSurname": "string", "FirstName": "string", "SecondName": "string", "ExpeditionMunicipality": "string", "ExpeditionDepartment": "string", "ExpeditionDate": "string", "CedulaState": "string" }, "Parameters": "string", "StateSignatureDocument": true, "SessionId": "string", "CustomerIdFromClient": "string", "ProcessId": "string", "DocumentTypeFromClient": 0, "IdNumberFromClient": "string", "NotEnrolledForComparisonWithClientData": true } /api/Integration/{projectName}/Validation/Close Parameters info (body) : The image encoded in base64 apiKey (header) : The key assigned to the project projectName (path) : The assigned project name Authorization (header) : OAuth validation token Body example { "Uid": "string", "RiskId": "string" } Response 200 -The transaction has been successfully created