Verifik
Verifik - ES
Verifik - ES
  • Documentación
  • Cuentas
    • Autenticación
      • Correo de autenticación
      • Teléfono de Autenticación
      • Renovar tu Token (JWT)
      • Crear un Nuevo Token y Revocar Tokens Anteriores
  • Services
    • SmartCheck
      • Ejemplo de consulta en la aplicación
    • SmartAccess
      • Panel de control
    • Access
      • Ejemplo de acceso por correo eletrónico
      • Ejemplo acceso telefónico
      • Ejemplo de acceso biométrico
    • SmartEnroll
    • Enroll
      • Tutorial
    • Smart Scan
  • Biometrics API's
    • Liveness
      • Liveness Detection (Detección de vida)
    • Comparar
      • Detección de vida y Comparar
      • Comparar 1:1
    • Busqueda
      • Buscar 1:N | Live (Vida)
      • Busqueda 1:N
      • Buscar 1:N | Crop (recortar)
      • Face Detect (Detección de rostro)
      • Face Verify (Verificacion de rostro)
  • Scan Docs API's
    • Scan Studio
      • Documentos permitidos
      • 🇨🇴[Example] Tarjeta de propiedad
    • Scan Prompt
      • Documentos soportados
    • Plantillas de ScanPrompt
  • Resources
    • Proyectos
      • Objeto del proyecto
      • Crear un proyecto
      • Actualizar un proyecto
      • Ver un proyecto
      • Listar todos los proyectos
    • Flujos de proyecto
      • The ProjectFlow object (Objetos de flujo de proyecto)
      • Create a project flow (Crear un flujo de proyecto)
        • Login settings (Configuración de inicio de sesión)
        • Onboarding settings (Configuración de incorporación)
        • Security settings (Configuración de seguridad)
      • Update a project flow (Subir un flujo de un proyecto)
      • Retrieve a project flow (Recuperar un flujo de un proyecto)
      • List all project flows (Listar todos los flujos de proyecto)
    • App Logins (Inicios de sesión de app)
      • The AppLogin object (Inicio de sesión en la app)
      • Create an app login (Crear inicio de sesión en la app)
      • Retrieve an app login (Recuperar inicio de sesión en la app)
      • List all app logins (Listar los inicios de sesión en la app)
    • App Registrations (Registros en la app)
      • The AppRegistration object (Registrar objetos en la app)
      • Create an app registration (Crear un registro en la app)
      • Sync app registration status (Sincronizar el estado de registro en la app)
      • Retrieve an app registration (Recuperar un registro en la app)
      • List all app registrations (Lista de todos los registros en la app)
    • Document Validations (Documentos de validación)
      • The Document Validation object (El objeto de Validación de Documentos)
      • Enroll - Create Document Validation (Crear documento de validación)
      • Retrieve a document validation (Recuperar una validación de documento)
      • List all document validations (Lista de documentos de validación)
      • Delete a document validation (Eliminar un documento de validación)
    • Email Validations (Validaciones de correo electrónico)
      • The Email Validation object (El objeto de Validación de Correo Electrónico)
      • Create Email Validation (Crear validación de correo electrónico)
      • Validate Email Validation (Validar la validación de correo electrónico)
      • Retrieve an Email Validation (Recuperar una validación de correo electrónico)
      • List of Email Validations (Lista de validaciones de correo electrónico)
    • Phone Validations (Validaciones de teléfono)
      • The Phone Validation object (El objeto de validaciones de teléfono)
      • Create Phone Validation (Crear Validación de Teléfono)
      • Validate Phone Validation (Validar la Validación de Teléfono)
      • Retrieve a Phone Validation (Recuperar una Validación de Teléfono)
      • List of Phone Validations (Lista de Validaciones de Teléfono)
    • Collections (Colecciones)
      • The Collection object (El objeto de Colección)
      • Create a Collection (Crear una Colección)
      • Retrieve a Collection (Recuperar una Colección)
      • List all Collection (Listar todas las Colecciones)
    • Persons (Personas)
      • The Person object (El objeto de Persona)
      • Create a Person (Crear una Persona)
      • Create a Person [With Liveness detection] (Crear una Persona [Con Detección de vida]
      • Update a Person (Actualizar una persona)
      • Delete a Person (Suprimir una persona)
      • Retrieve a Person (Recuperar una Persona)
      • List all Persons (Listar todas las Personas)
    • Webhooks
      • The Webhook object (El objeto de Webhook)
      • Create a Webhook (Crear un Webhook)
      • Update a Webhook (Actualizar un Webhook )
      • Delete a Webhook (Eliminar un Webhook)
      • Retrieve a Webhook (Recuperar un Webhook)
      • List all Webhooks (Listar todos los Webhooks)
      • Webhook integration (Integración de Webhook)
    • Biometric Validations (Validaciones Biométricas)
      • The Biometric Validation Object (El objeto de Validación Biométrica)
      • Create Biometric Validation (Crear Validación Biométrica)
      • Validate Biometric Validation (Validar la Validación Biométrica)
      • Retrieve a Biometric Validation (Recuperar una Validación Biométrica)
      • List all Biometric Validations (Listar todas las Validaciones Biométricas)
  • Plans & Pricings
    • Planes de Evaluación de Base de Datos
    • Planes de Smart Access
      • Plan Gratuito
      • Usuarios Activos
      • Sesiones
      • Cargos extras
      • Planes Empresariales
    • Planes de SmartEnroll
    • Enroll Plans (Planes de Registro)
    • SMS/WhatsApp Pricing (Precios de SMS/WhatsApp)
  • Identity validation
    • 🇦🇷Argentina
    • 🇧🇴Bolivia
    • 🇧🇷Brazil
    • 🇨🇦Canada
      • 🇨🇦Ontario Driver license
      • 🇨🇦Quebec Driver license
      • 🇨🇦British Columbia license
    • 🇨🇱Chile
      • 🇨🇱Chilean taxpayer information
    • 🇨🇴Colombia
      • 🇨🇴Colombian Citizen
      • 🇨🇴Colombian Citizen with Extra Data
      • 🇨🇴Colombian Politically Exposed Persons
      • 🇨🇴Special Stay Permit (PEP) ID
      • 🇨🇴Colombian Foreigner ID (CE)
    • 🇨🇷Costa Rica
    • 🇩🇴Dominican Republic
    • 🇪🇨Ecuador
    • 🇸🇻El Salvador
    • 🇬🇹Guatemala
    • 🇭🇳Honduras
    • 🇲🇽Mexican
    • 🇵🇦Panama
    • 🇵🇾Paraguay
    • 🇵🇪Peru
      • 🇵🇪Peruvian Citizen
      • 🇵🇪Peruvian Foreigner Resident
      • 🇵🇪Peruvian Citizen Information with Extra Data
    • 🇪🇸Spain Citizen
    • 🇺🇸United States
      • 🇺🇸SSN Verification (Social Security Number)
      • 🇺🇸Florida Driver License Validation
      • 🇺🇸Kansas Driver's License Verification
    • 🇺🇾Uruguay
    • 🇻🇪Venezuela
      • 🇻🇪Venezuelan Citizen Information
      • 🇻🇪Venezuelan Foreigner citizens
  • Vehicle Validation
    • 🇦🇷Argentina
    • 🇧🇴Bolivia
    • 🇧🇷Brazil
    • 🇨🇱Chile
      • 🇨🇱Vehicle Information
      • 🇨🇱Driver license
    • 🇨🇴Colombia
      • 🇨🇴Vehicle by Code - Fasecolda
      • 🇨🇴SIMIT Resolutions
      • 🇨🇴Complete vehicle with historical records by VIN - RUNT
      • 🇨🇴Information System for Drivers Transporting Dangerous Goods
      • 🇨🇴Vehicle's SOAT and RTM by Plate and Identification document
      • 🇨🇴General query of SIMIT by license plate
      • 🇨🇴Driver's License
      • 🇨🇴Vehicle by plate and identification card only
      • 🇨🇴Vehicle Values by Plate - Fasecolda
      • 🇨🇴Verifik Pico y Placa for Bogotá
      • 🇨🇴Complete vehicle with historical records by plate and identification document - RUNT
      • 🇨🇴SIMIT Agreements
      • 🇨🇴SIMIT Fines
      • 🇨🇴General query of SIMIT by Identification Document
      • 🇨🇴Sinister Verification - Fasecolda
      • 🇨🇴Vehicle Fines Check in Bogotá, Colombia
      • 🇨🇴Taxes in Bogota
      • 🇨🇴Vehicle accidentality in Bogota
    • 🇨🇷Costa Rica
    • 🇪🇨Ecuador
      • 🇪🇨Ecuador Vehicle Fines
      • 🇪🇨Vehicle Information Lookup
    • 🇲🇽Mexico
    • 🇵🇾Paraguay
    • 🇵🇪Peru
      • 🇵🇪Peruvian Vehicle
      • 🇵🇪Peruvian Vehicle Insurance
    • 🇺🇸United States
      • 🇺🇸Vehicle Information
      • 🇺🇸Vehicle Information by VIN
  • Business Validation
    • 🇦🇷Argentina
    • 🇧🇴Bolivia
    • 🇧🇷Brazil
    • 🇨🇦Canada
    • 🇨🇱Chilean
    • 🇨🇴Colombia
      • 🇨🇴Colombian Business Information - RUES
      • 🇨🇴Complete Business Registry - RUES
      • 🇨🇴Colombian Company DIAN Verification
      • 🇨🇴Verify Legal Invoicer in DIAN for Colombian Companies
    • 🇨🇷Costa Rica
    • 🇲🇽Mexico
    • 🇵🇦Panama
    • 🇵🇾Paraguay
    • 🇵🇪Peru
    • 🇪🇸Spain
    • 🇺🇸United States
  • Background Check
    • 🇧🇷Brazil
    • 🇨🇴Colombia
      • 🇨🇴Public Contracts
      • 🇨🇴Colombian Police Record Check
      • 🇨🇴Verify Police Compliance with Corrective Measures
      • 🇨🇴Comptroller Certificate
      • 🇨🇴Disciplinary Records in Colombia (attorney's office)
    • 🌎International
      • 🌎Interpol Background Check
      • 🌎OFAC Background Check
      • 🌎Europol Background Check
      • 🌎FBI Background Check
      • 🌎ONU Background Check
      • 🌎DEA Background Check
  • Military
    • 🇨🇴Colombia
  • Finance
    • 🇨🇴Delinquent debtors
  • Legal
    • 🇨🇴Lawyer Verification
    • 🇨🇴Colombian Legal Processes
    • 🇨🇴Retrieve Details of a Legal Process by Number
    • 🇨🇴Court Case Records Lookup
    • 🇨🇴Certificate of Validity for Legal Professionals
  • Certificates
    • 🇨🇴Registry Certificate
    • 🇨🇴High Altitude Job Eligibility
    • 🇨🇴SENA Certificates
  • Voting
    • 🇨🇴Retrieve Voting Information for Colombian Citizens
  • Health
    • 🇨🇴Colombian RETHUS Verification Data
    • 🇨🇴Verify Colombian Affiliations
  • Verifik LLC
    • Privacy Policy
    • Políticas de Privacidad
    • Términos y Condiciones
    • Terms and Conditions
    • Acuerdo de Niveles de Servicio
    • Service Level Agreement
    • Verifik for Enterprises HUB (Esp)
    • Verifik for Enterprises HUB (Eng)
    • SmartCheck Terms and Conditions of Use
Powered by GitBook
On this page
  • Obtener plantillas (GET)
  • Crear Plantilla (POST)
  • Actualizar Plantilla (PUT)
  1. Scan Docs API's

Plantillas de ScanPrompt

Servicios para consultar, crear y modificar modelos entrenados para el servicio Scan Prompt.

Obtener plantillas (GET)

GET - https://api.verifik.co/v2/ocr/scan-prompt/templates

La API Retrieve ScanPrompt Templates te permite recuperar información sobre las plantillas almacenadas en la base de datos de Verifik.

La respuesta contiene un array de objetos de plantillas, donde cada objeto representa una plantilla individual dentro del sistema. Puedes iterar a través de este array para acceder y utilizar la información de cada plantilla según las necesidades de tu aplicación.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Response

{
  "data": [
    {
      "__v": 2,
      "_id": "64cd7b5012b18c7901e3f451",
      "name": "Escaneo de licencias de conducir de Colombia",
      "active": true,
      "fields": [
        "firstName",
        "lastName",
        "fullName",
        "dateOfBirth",
        "documentNumber",
        "expeditionDate",
        "driverRestrictions",
        "bloodType"
      ],
      "prompt": "From the provided JSON input, extract the fields {{fields}}. The text can be in multiple languages and may contain minor distortions due to OCR. In Colombian culture, individuals may have two last names, both of which must be included. People also normally have 2 first names, like Juan Miguel or Jose Manuel, so when you see a 4 words name, extract it that way. For the driver restrictions, its usually like driver needs glasses or another detail about his/her negative observations  Please avoid translation, simply extract the information as provided. The output must be in a JSON format. Only consider fields with a confidence level of 0.5 or higher, disregard fields that do not have a confidence score.",
      "system": true,
      "deleted": false,
      "createdAt": "2023-08-03T15:54:41.178Z",
      "updatedAt": "2023-08-05T17:23:52.556Z",
      "description": "Prompt para extraer licencias de conducir de Colombia",
      "documentTypes": [
        "DLCO"
      ]
    },
    {
      "__v": 2,
      "_id": "64ce89a612b18c7901e3f453",
      "name": "Escaneo de cédulas de Colombia",
      "active": true,
      "fields": [
        "firstName",
        "lastName",
        "fullName",
        "documentNumber"
      ],
      "prompt": "From the provided JSON input, extract the fields {{fields}}. The text can be in multiple languages and may contain minor distortions due to OCR. In Colombian culture, individuals may have two last names, both of which must be included. People also normally have 2 first names, like Juan Miguel or Jose Manuel, so when you see a 4 words name, extract it that way. For the driver restrictions, its usually like driver needs glasses or another detail about his/her negative observations  Please avoid translation, simply extract the information as provided. The output must be in a JSON format. Only consider fields with a confidence level of 0.5 or higher, disregard fields that do not have a confidence score.",
      "system": true,
      "deleted": false,
      "createdAt": "2023-08-03T15:54:41.178Z",
      "updatedAt": "2023-08-05T17:23:52.556Z",
      "description": "Prompt para extraer cédulas de Colombia",
      "documentTypes": [
        "CC"
      ]
    },
    {
      "__v": 1,
      "_id": "64d12c1a12b18c7901e3f45c",
      "name": "Global Passport Scanning",
      "active": true,
      "fields": [
        "firstName",
        "lastName",
        "fullName",
        "documentNumber",
        "country",
        "dateOfBirth",
        "gender",
        "expirationDate",
        "personalNo"
      ],
      "prompt": "From the provided JSON input, extract the fields {{fields}}. The text may be in multiple languages and may contain special characters. Individuals might have one or two first names and one or two last names. The names must be extracted exactly as they appear, preserving special characters. In some cultures, individuals may have a middle name, which should also be considered. For any observations or special notes related to the passport holder, extract them as provided without translating. The output must be in JSON format. Only consider fields with a confidence level of 0.5 or higher, disregard fields that do not have a confidence score.",
      "system": true,
      "deleted": false,
      "createdAt": "2023-08-03T15:54:41.178Z",
      "updatedAt": "2023-08-05T17:23:52.556Z",
      "description": "Prompt to extract passport details from all countries",
      "documentTypes": [
        "PA"
      ]
    },
    {
      "__v": 1,
      "_id": "64d1329312b18c7901e3f45f",
      "name": "Escaneo de tarjetas INE de México",
      "active": true,
      "fields": [
        "firstName",
        "lastName",
        "fullName",
        "documentNumber",
        "CURP",
        "voterKey",
        "state",
        "municipality",
        "address",
        "gender",
        "birthDate",
        "expirationDate"
      ],
      "prompt": "From the provided JSON input, extract the following fields: {{fields}}. The JSON input may contain OCR data from documents in Spanish, such as a Mexican Voter ID card (Credencial para Votar), and may include special characters.\n\nIn extracting the full name, consider that individuals may have one or two first names and normally two last names. You must ensure proper extraction by identifying these components accurately. Specifically, you MUST find the first two letters of each part of the name (first name, middle name if applicable, and last names) inside the first 6-8 characters of the documentNumber before the numbers start (CLAVE DE ELECTOR). This means that the first two letters of the first name, followed by the first two letters of each part of the last name, must appear in the same sequence as they are in the documentNumber. If any part of the name does not have corresponding letters in the documentNumber, the extraction is considered incorrect.\n\nThe output must be in JSON format without any additional explanation, as it will be processed with JSON.parse(resultStringContent). Only consider data with a confidence level of 0.5 or higher, and disregard any fields that do not have a specified confidence score.\n",
      "system": true,
      "deleted": false,
      "createdAt": "2023-08-03T15:54:41.178Z",
      "updatedAt": "2023-08-05T17:23:52.556Z",
      "description": "Prompt to extract details from Mexican INE (Instituto Nacional Electoral) cards",
      "documentTypes": [
        "INE"
      ]
    },
    {
      "__v": 1,
      "_id": "64d1540e12b18c7901e3f461",
      "name": "Chilean ID Card Scanning",
      "active": true,
      "fields": [
        "firstName",
        "lastName",
        "fullName",
        "documentNumber",
        "nationality",
        "dateOfBirth",
        "gender",
        "expirationDate",
        "emissionDate",
        "RUT",
        "RUN"
      ],
      "prompt": "From the provided JSON input, extract the fields {{fields}}. The text can be in multiple languages and may contain minor distortions due to OCR. In Chilean culture, individuals may have two last names, both of which must be included. People also normally have 2 first names, like Juan Miguel or Jose Manuel, so when you see a 4 words name, extract it that way. For the driver restrictions, its usually like driver needs glasses or another detail about his/her negative observations  Please avoid translation, simply extract the information as provided. The output must be in a JSON format. Only consider fields with a confidence level of 0.5 or higher, disregard fields that do not have a confidence score.",
      "system": true,
      "deleted": false,
      "createdAt": "2023-08-03T15:54:41.178Z",
      "updatedAt": "2023-08-05T17:23:52.556Z",
      "description": "Prompt to extract Chilean ID card details",
      "documentTypes": [
        "RUT"
      ]
    },
    {
      "__v": 1,
      "_id": "653942aa27953fa62c752c83",
      "name": "CUI Peruvian ID Card Scanning",
      "active": true,
      "fields": [
        "firstName",
        "lastName",
        "secondLastName",
        "fullName",
        "documentNumber",
        "nationality",
        "dateOfBirth",
        "placeOfBirth",
        "dateOfIssue",
        "gender",
        "expirationDate",
        "maritalStatus"
      ],
      "format": "JSON",
      "prompt": "From the provided JSON input, extract the fields {{fields}}. The text can be in multiple languages and may contain minor distortions due to OCR. In Peruvian culture, individuals have up to 5 names in their ID, both of which must be included. Citizens also normally have 2 to 3 names, so when you see a 4 to 5 words name, extract it that way. Please avoid translation, simply extract the information as provided. The output must be in a JSON format. Only consider fields with a confidence level of 0.5 or higher, disregard fields that do not have a confidence score. Dates should be in format YYYY/MM/DD",
      "system": true,
      "deleted": false,
      "createdAt": "2023-08-03T15:54:41.178Z",
      "updatedAt": "2023-08-05T17:23:52.556Z",
      "description": "Prompt to extract the new Peruvian card details",
      "documentTypes": [
        "CUI"
      ]
    },
    {
      "__v": 1,
      "_id": "6539430227953fa62c752c87",
      "name": "Peruvian ID Card Scanning",
      "active": true,
      "fields": [
        "name1",
        "name2",
        "name3",
        "lastName",
        "secondLastName",
        "fullName",
        "documentNumber",
        "nationality",
        "dateOfBirth",
        "placeOfBirth",
        "dateOfIssue",
        "gender",
        "expirationDate",
        "maritalStatus"
      ],
      "format": "JSON",
      "prompt": "From the provided JSON input, extract the fields {{fields}}. The text can be in multiple languages and may contain minor distortions due to OCR. In Peruvian culture, recognize the division of names properly. Please avoid translation, simply extract the information as provided. The output must be in a JSON format. Only consider fields with a confidence level of 0.5 or higher, disregard fields that do not have a confidence score. Dates should be in format YYYY/MM/DD",
      "system": true,
      "deleted": false,
      "createdAt": "2023-08-03T15:54:41.178Z",
      "updatedAt": "2023-08-05T17:23:52.556Z",
      "description": "Prompt to extract Peruvian ID card details",
      "documentTypes": [
        "DNI"
      ]
    }
  ]
}

Crear Plantilla (POST)

POST - https://api.verifik.co/v2/ocr/scan-prompt/template

Este endpoint de API te permite crear nuevas plantillas de extracción de información para tipos de documentos específicos. Las plantillas ayudan a estructurar la extracción de campos de datos clave, permitiendo capturar la información requerida con precisión. Al crear una nueva plantilla, es fundamental enfatizar el parámetro prompt, ya que juega un papel crucial en la instrucción del sistema sobre cómo extraer los datos de los documentos proporcionados.

Mediante la creación de plantillas personalizadas con prompts detallados, puedes garantizar que la API extraiga con precisión la información necesaria, incluso cuando se trate de texto multilingüe, distorsionado o culturalmente específico.

Nota: Es esencial adaptar el prompt a las características únicas de los documentos que estás procesando para obtener los mejores resultados.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Prompt

Echa un vistazo a este ejemplo de prompt:

{
  "prompt": "From the provided JSON input , extract the fields {{fields}}. The text can be in multiple languages and may contain minor distortions due to OCR. In Colombian culture, individuals may have two last names, both of which must be included. People also normally have 2 first names, like Juan Miguel or Jose Manuel, so when you see a 4 words name, extract it that way. For the driver restrictions, its usually like driver needs glasses or another detail about his/her negative observations  Please avoid translation, simply extract the information as provided. The output must be in a {{format}}. Only consider fields with a confidence level of 0.5 or higher, disregard fields that do not have a confidence score.",
}

Básicamente, el prompt es una serie de instrucciones y consideraciones sobre el documento. Debes definir los aspectos más importantes del mismo. En los detalles del cuerpo de la solicitud, encontrarás más información sobre cómo crear correctamente el prompt.

Es importante que dentro del prompt incluyas {{fields}} y {{format}}, ya que estos indican a la IA qué datos extraer y en qué formato devolverlos.

Body

Name
Type
Description

documentType

string

Image in Base64 encoded format or a URL where the image is hosted.

fields

string

name

string

format

string

prompt

string

description

string

Ejemplo de Body

{
  "system": false,
  "documentTypes": [
    "CCVE"
  ],
  "fields": [
    "nombres (can be 1 or more Name)",
    "apellidos (can be 1 or more last Name)",
    "Numero de cedula (ID number always comes after this 'V.')",
    "fecha de nacimiento",
    "fecha de expedicion",
    "fecha de expiracion",
    "nacionalidad (the nationality is until the end of the text)",
    "age(fecha actual - fecha de nacimiento)"
  ],
  "name": "CCVE Verifik",
  "format": "json",
  "prompt": "This text was extracted from a Venezuelan ID card, it's in Spanish. I need you to provide me with the following data in {{format}}: {{fields}}. all fields are in uppercase, the order is document number, apellidos, nombres, sign (the sign sometimes can be letters) and Ignore the directors name this is located near to the right corner . This is the desired JSON format: firstName: Nombres, lastName: Apellidos, documentNumber: numero de cedula, dateOfBirth: fecha de nacimiento,civilStatus: estado civil, expeditionDate: fecha de expedicion, expireDate: fecha de expiracion,  nationality: nacionalidad ",
  "description": "Prompt for Venezuelan IDs for Verifik"
}

Response

{
  "data": {
    "__v": 0,
    "_id": "653bdcc2ff7de0cee3b0760a",
    "code": "unique_identifier",
    "name": "Escaneo de cédulas de Colombia",
    "active": true,
    "client": "623b6317fe5fd1774be9f566",
    "fields": [
      "firstName",
      "lastName",
      "fullName",
      "documentNumber"
    ],
    "format": "json",
    "prompt": "From the provided JSON input , extract the fields {{fields}}. The text can be in multiple languages and may contain minor distortions due to OCR. In Colombian culture, individuals may have two last names, both of which must be included. People also normally have 2 first names, like Juan Miguel or Jose Manuel, so when you see a 4 words name, extract it that way. For the driver restrictions, its usually like driver needs glasses or another detail about his/her negative observations  Please avoid translation, simply extract the information as provided. The output must be in a {{format}}. Only consider fields with a confidence level of 0.5 or higher, disregard fields that do not have a confidence score.",
    "system": false,
    "deleted": false,
    "createdAt": "2023-10-27T15:52:34.058Z",
    "updatedAt": "2023-10-27T15:52:34.058Z",
    "description": "Prompt para extraer cédulas de Colombia",
    "documentTypes": [
      "CC"
    ]
  }
}

Actualizar Plantilla (PUT)

PUT- https://api.verifik.co/v2/ocr/scan-prompt/template

Este endpoint de API te permite actualizar una plantilla OCR específica. Las plantillas OCR se utilizan para extraer datos estructurados de documentos. Al actualizar una plantilla, puedes modificar sus configuraciones, como los campos a extraer y los tipos de documentos a los que se aplica.

Este endpoint está diseñado para la gestión de plantillas OCR, permitiéndote adaptar la extracción de datos según los tipos de documentos y requisitos específicos. Al actualizar las plantillas, puedes ajustarlas a necesidades cambiantes, asegurando una extracción precisa de datos desde los documentos.

Nota: Al actualizar plantillas, asegúrate de que los cambios se alineen con tus requisitos de extracción de datos OCR y prueba la plantilla actualizada con documentos de muestra para confirmar su efectividad.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

Body

Name
Type
Description

image

string

Image in Base64 encoded format or a URL where the image is hosted.

Response

{
  "data": {
    "__v": 0,
    "_id": "653bdcc2ff7de0cee3b0760a",
    "code": "unique_identifier",
    "name": "Escaneo de cédulas de Colombia",
    "active": true,
    "client": "623b6317fe5fd1774be9f566",
    "fields": [
      "firstName",
      "lastName",
      "fullName",
      "documentNumber"
    ],
    "format": "json",
    "prompt": "From the provided JSON input , extract the fields {{fields}}. The text can be in multiple languages and may contain minor distortions due to OCR. In Colombian culture, individuals may have two last names, both of which must be included. People also normally have 2 first names, like Juan Miguel or Jose Manuel, so when you see a 4 words name, extract it that way. For the driver restrictions, its usually like driver needs glasses or another detail about his/her negative observations  Please avoid translation, simply extract the information as provided. The output must be in a {{format}}. Only consider fields with a confidence level of 0.5 or higher, disregard fields that do not have a confidence score.",
    "system": false,
    "deleted": false,
    "createdAt": "2023-10-27T15:52:34.058Z",
    "updatedAt": "2023-10-27T15:52:34.058Z",
    "description": "Prompt para extraer cédulas de Colombia",
    "documentTypes": [
      "CC"
    ]
  }
}
PreviousDocumentos soportadosNextProyectos

Last updated 1 month ago