Ejecución de flujos

Procesamiento asíncrono de documentos de identidad

Extraer datos del documento de identidad

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/identity/analyze-and-extract-document-data

Inicia de forma asíncrona el proceso de extracción de datos (OCR) y análisis del documento de identidad. La respuesta es inmediata ({ success: true }); el resultado real llega por Socket.io al cliente una vez que el procesamiento finaliza.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo llamarlo

Después de subir la imagen del frente con POST /upload-id-still. Las URLs del body se construyen concatenando la base URL del servicio GPU con los paths devueltos por ese endpoint.

Origen de cada campo del body

Campo	Origen
`imageSrc`	`https://w7hghxo7gyc3do-3005.proxy.runpod.net` + `used_id_path`
`rawImageSrc`	`https://w7hghxo7gyc3do-3005.proxy.runpod.net` + `used_id_raw_path`
`croppedFaceImageSrc`	`https://w7hghxo7gyc3do-3005.proxy.runpod.net` + `cropped_face`
`croppedDocumentImageSrc`	`https://w7hghxo7gyc3do-3005.proxy.runpod.net` + `id_crop_url`

Resultado por Socket.io

El servidor emite el evento con los datos extraídos del documento (nombre, número de identificación, fecha de nacimiento, etc.) y el resultado del análisis de calidad de imagen. El cliente debe estar suscrito al canal correspondiente al invitationId antes de llamar a este endpoint.

Extraer datos del documento de identidad › Request Body

imageSrc

string · required

URL completa de la imagen del frente procesada por GPU (https://w7hghxo7gyc3do-3005.proxy.runpod.net + used_id_path)

Example: https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front.jpg

rawImageSrc

string · required

URL completa de la imagen original sin procesar (https://w7hghxo7gyc3do-3005.proxy.runpod.net + used_id_raw_path)

Example: https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front_raw.jpg

croppedFaceImageSrc

string · required

URL completa del recorte del rostro detectado (https://w7hghxo7gyc3do-3005.proxy.runpod.net + cropped_face)

Example: https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/face_crop.jpg

croppedDocumentImageSrc

string · required

URL completa del recorte del documento (https://w7hghxo7gyc3do-3005.proxy.runpod.net + id_crop_url)

Example: https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_crop.jpg

selectedCountry

string · required

Código ISO 3166-1 alpha-2 del país emisor del documento

Example: CO

selectedDocument

string · enum · required

Tipo de documento seleccionado por el usuario

Enum values:

passport

driver_license

ppt

Example: id

invitationId

string · uuid · required

UUID de la invitación, usado para enrutar el resultado por Socket.io al canal correcto

Example: 550e8400-e29b-41d4-a716-446655440000

Extraer datos del documento de identidad › Responses

Solicitud de extracción encolada correctamente. El resultado se entrega por Socket.io.

success

boolean

POST/identity/analyze-and-extract-document-data

curl https://kyc-journey-queue-manager-dev.adamoservices.co/identity/analyze-and-extract-document-data \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "imageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front.jpg",
  "rawImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front_raw.jpg",
  "croppedFaceImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/face_crop.jpg",
  "croppedDocumentImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_crop.jpg",
  "selectedCountry": "CO",
  "selectedDocument": "id",
  "invitationId": "550e8400-e29b-41d4-a716-446655440000"
}'

Example Request Body

{
  "imageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front.jpg",
  "rawImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front_raw.jpg",
  "croppedFaceImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/face_crop.jpg",
  "croppedDocumentImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_crop.jpg",
  "selectedCountry": "CO",
  "selectedDocument": "id",
  "invitationId": "550e8400-e29b-41d4-a716-446655440000"
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Verificar autenticidad del documento

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/identity/analyze-document-authenticity

Inicia de forma asíncrona la verificación de autenticidad del documento de identidad a partir de la imagen del dorso. Solo aplica para documentos con reverso (cédulas, licencias, permisos). Los pasaportes no requieren este paso.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo llamarlo

Después de subir el dorso con POST /upload-id-back-still. La URL de la imagen se construye concatenando la base URL del servicio GPU con el path devuelto por ese endpoint:

Code
imageSrc = https://w7hghxo7gyc3do-3005.proxy.runpod.net{used_id_back_path}

Resultado

El proceso es asíncrono. Una vez finalizado, el servicio guarda internamente el resultado de autenticidad (score) asociado al invitationId. Este score queda disponible para el orquestador cuando procesa el paso de identidad.

Verificar autenticidad del documento › Request Body

imageSrc

string · required

URL completa de la imagen del dorso procesada por GPU (https://w7hghxo7gyc3do-3005.proxy.runpod.net + used_id_back_path)

Example: https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_back.jpg

selectedCountry

string · required

Código ISO 3166-1 alpha-2 del país emisor del documento

Example: CO

selectedDocument

string · enum · required

Tipo de documento. No aplica para passport.

Enum values:

driver_license

ppt

Example: id

invitationId

string · uuid · required

UUID de la invitación, usado para asociar el resultado de autenticidad

Example: 550e8400-e29b-41d4-a716-446655440000

Verificar autenticidad del documento › Responses

Solicitud de verificación de autenticidad encolada correctamente

success

boolean

POST/identity/analyze-document-authenticity

curl https://kyc-journey-queue-manager-dev.adamoservices.co/identity/analyze-document-authenticity \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "imageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_back.jpg",
  "selectedCountry": "CO",
  "selectedDocument": "id",
  "invitationId": "550e8400-e29b-41d4-a716-446655440000"
}'

Example Request Body

{
  "imageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_back.jpg",
  "selectedCountry": "CO",
  "selectedDocument": "id",
  "invitationId": "550e8400-e29b-41d4-a716-446655440000"
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Analizar sesión de prueba de vida

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/liveness/analyze-liveness-session

Inicia el análisis completo de la sesión de prueba de vida de forma asíncrona. La respuesta es inmediata ({ success: true }); el procesamiento continúa en background.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo llamarlo

Después de subir el video con POST /upload-live-clip. El req_id debe ser el mismo usado durante toda la sesión GPU.

Resultado

El integrador no necesita esperar el resultado del análisis. El flujo de verificación puede avanzar al siguiente paso inmediatamente después de recibir { success: true }. El resultado queda registrado internamente.

Analizar sesión de prueba de vida › Request Body

publicId

string · required

Identificador del flujo de verificación (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

flowRunId

string · uuid · required

UUID de la ejecución del flujo (devuelto por POST /flow-runs/start como runUuid)

Example: 550e8400-e29b-41d4-a716-446655440000

authToken

string · required

Token de autorización obtenido en POST /flow-runs/start

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

reqId

string · required

Identificador de la sesión GPU usado durante toda la captura

Example: 906ab27fd0f04e9db9e1c0b7378b51ad

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Analizar sesión de prueba de vida › Responses

Análisis encolado correctamente. El procesamiento continúa en background.

success

boolean

POST/liveness/analyze-liveness-session

curl https://kyc-journey-queue-manager-dev.adamoservices.co/liveness/analyze-liveness-session \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "reqId": "906ab27fd0f04e9db9e1c0b7378b51ad",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}'

Example Request Body

{
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "reqId": "906ab27fd0f04e9db9e1c0b7378b51ad",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Registrar resultado de verificación de IP

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/ip/verify-ip

Registra el resultado de la verificación de IP en el sistema. La respuesta es inmediata ({ success: true }).

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo llamarlo

Inmediatamente después de recibir la respuesta de POST /verifications/ip-verification. El campo formData.ipVerificationData debe contener exactamente la respuesta completa de ese endpoint.

Registrar resultado de verificación de IP › Request Body

publicId

string · required

Identificador del flujo (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

flowRunId

string · uuid · required

UUID de la ejecución del flujo (devuelto por POST /flow-runs/start como runUuid)

Example: 550e8400-e29b-41d4-a716-446655440000

authToken

string · required

Token de autorización obtenido en POST /flow-runs/start

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

object · required

Registrar resultado de verificación de IP › Responses

Resultado registrado correctamente

success

boolean

POST/ip/verify-ip

curl https://kyc-journey-queue-manager-dev.adamoservices.co/ip/verify-ip \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "formData": {
    "ipVerificationData": {
      "message": "IP verificada correctamente",
      "data": {
        "ip": "190.85.42.100",
        "security": {
          "vpn": false,
          "proxy": false,
          "tor": false,
          "relay": false
        },
        "location": {
          "city": "Medellín",
          "region": "Antioquia",
          "country": "Colombia",
          "country_code": "CO",
          "latitude": "6.2476",
          "longitude": "-75.5679",
          "time_zone": "America/Bogota"
        },
        "network": {
          "network": "190.85.0.0/16",
          "autonomous_system_number": "AS27943",
          "autonomous_system_organization": "Claro Colombia"
        }
      },
      "pagination": null,
      "timestamp": "2026-06-04T10:30:00Z"
    }
  }
}'

Example Request Body

{
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "formData": {
    "ipVerificationData": {
      "message": "IP verificada correctamente",
      "data": {
        "ip": "190.85.42.100",
        "security": {
          "vpn": false,
          "proxy": false,
          "tor": false,
          "relay": false
        },
        "location": {
          "city": "Medellín",
          "region": "Antioquia",
          "country": "Colombia",
          "country_code": "CO",
          "latitude": "6.2476",
          "longitude": "-75.5679",
          "time_zone": "America/Bogota"
        },
        "network": {
          "network": "190.85.0.0/16",
          "autonomous_system_number": "AS27943",
          "autonomous_system_organization": "Claro Colombia"
        }
      },
      "pagination": null,
      "timestamp": "2026-06-04T10:30:00Z"
    }
  }
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Registrar verificación de correo con OTP

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/email/verify-code

Valida el OTP ingresado por el usuario y registra el resultado en el sistema.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Errores de OTP

Si el código es incorrecto, la respuesta incluye los detalles del error (intentos restantes, expiración, etc.).

Registrar verificación de correo con OTP › Request Body

email

string · email · required

Correo electrónico del usuario

Example: usuario@ejemplo.com

code

string · required

OTP de 6 caracteres alfanuméricos recibido por correo

Example: A1B2C3

publicId

string · required

Identificador del flujo (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

flowRunId

string · uuid · required

UUID de la ejecución del flujo (devuelto por POST /flow-runs/start como runUuid)

Example: 550e8400-e29b-41d4-a716-446655440000

authToken

string · required

Token de autorización obtenido en POST /flow-runs/start

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Registrar verificación de correo con OTP › Responses

Verificación registrada correctamente

success

boolean

POST/email/verify-code

curl https://kyc-journey-queue-manager-dev.adamoservices.co/email/verify-code \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "email": "usuario@ejemplo.com",
  "code": "A1B2C3",
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}'

Example Request Body

{
  "email": "usuario@ejemplo.com",
  "code": "A1B2C3",
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Registrar verificación de teléfono con OTP

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/phone/verify-code

Valida el código ingresado por el usuario y registra el resultado en el sistema.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Variante SMS (`callMade: false`)

Valida el OTP enviado via SMS por POST /verifications/phone-verification.

Variante llamada (`callMade: true`)

Valida el código recibido por llamada telefónica, usando el SID de Twilio generado en POST /phone/send-code-to-verify-by-call.

Errores

Si el código es incorrecto, la respuesta incluye los detalles del error (intentos restantes, expiración, etc.).

Registrar verificación de teléfono con OTP › Request Body

phone

string · required

Número de teléfono en formato E.164

Example: +573001234567

code

string · required

Código OTP de 6 caracteres alfanuméricos

Example: A1B2C3

publicId

string · required

Identificador del flujo (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

flowRunId

string · uuid · required

UUID de la ejecución del flujo (devuelto por POST /flow-runs/start como runUuid)

Example: 550e8400-e29b-41d4-a716-446655440000

authToken

string · required

Token de autorización obtenido en POST /flow-runs/start

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

language

string · required

Idioma. Valores posibles: es, en

Example: es

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

callMade

boolean · required

true si el código fue recibido por llamada telefónica, false si fue por SMS

Example: false

Registrar verificación de teléfono con OTP › Responses

Verificación registrada correctamente

success

boolean

POST/phone/verify-code

curl https://kyc-journey-queue-manager-dev.adamoservices.co/phone/verify-code \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "phone": "+573001234567",
  "code": "A1B2C3",
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "language": "es",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "callMade": false
}'

Example Request Body

{
  "phone": "+573001234567",
  "code": "A1B2C3",
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "language": "es",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "callMade": false
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Solicitar código de verificación por llamada telefónica

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/phone/send-code-to-verify-by-call

Realiza una llamada telefónica al número indicado y dicta un código OTP. Alternativa al envío por SMS.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo usarlo

Cuando el usuario no recibe el SMS o prefiere verificar por llamada. Tras llamar a este endpoint, usar POST /phone/verify-code con callMade: true para validar el código recibido.

Solicitar código de verificación por llamada telefónica › Request Body

phone

string · required

Número de teléfono en formato E.164

Example: +573001234567

language

string · required

Idioma de la llamada. Valores posibles: es, en

Example: es

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Solicitar código de verificación por llamada telefónica › Responses

Llamada iniciada correctamente

success

boolean

Validar comprobante de domicilio

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/address/validate-document

Verifica que el comprobante subido contiene datos de dirección extraíbles mediante OCR. El proceso puede tardar hasta 10 minutos.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo llamarlo

Inmediatamente después de obtener la URL del archivo en POST /flow/progress/upload-file. Si la validación devuelve isValid: false, se debe pedir al usuario que suba un documento diferente antes de continuar.

Validar comprobante de domicilio › Request Body

fileUrl

string · uri · required

URL del archivo devuelta por POST /flow/progress/upload-file

Example: https://s3.amazonaws.com/bucket/comprobante.pdf

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

publicId

string · required

Identificador del flujo (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

Validar comprobante de domicilio › Responses

Resultado de la validación del documento

success

boolean

isValid

boolean

true si el documento contiene datos de dirección extraíbles, false si no

Example: true

reason

string | null

Motivo del fallo si isValid es false. Valores posibles: timeout, no_data, error

Example: null

Registrar verificación de domicilio

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/address/address-verification

Envía los datos de dirección del usuario e inicia el procesamiento en background. La respuesta es inmediata — el análisis continúa de forma asíncrona.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Procesamiento en background

El sistema realiza los siguientes pasos de forma asíncrona:

Geocodificación inversa: convierte las coordenadas del dispositivo en dirección legible
Geocodificación directa: convierte la dirección declarada en coordenadas
Cálculo de distancia: compara la ubicación del dispositivo con la dirección declarada (fórmula de Haversine)
OCR del comprobante (solo si se incluye ocrAddress): extrae la dirección del documento y calcula la distancia respecto a la ubicación del dispositivo

Variantes del campo `addressData`

Con comprobante (askForEvidence: true): incluir el objeto ocrAddress con fileId y fileUrl
Sin comprobante (askForEvidence: false): omitir el objeto ocrAddress

Registrar verificación de domicilio › Request Body

publicId

string · required

Identificador del flujo (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

flowRunId

string · uuid · required

UUID de la ejecución del flujo (devuelto por POST /flow-runs/start como runUuid)

Example: 550e8400-e29b-41d4-a716-446655440000

authToken

string · required

Token de autorización obtenido en POST /flow-runs/start

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

object · required

Registrar verificación de domicilio › Responses

Verificación iniciada correctamente

success

boolean

POST/address/address-verification

curl https://kyc-journey-queue-manager-dev.adamoservices.co/address/address-verification \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "publicId": "a1b2c3d4-flow-def",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "addressData": {
    "zipCode": "110111",
    "address": "Calle Principal 123",
    "department": "Cundinamarca",
    "municipality": "Bogotá",
    "country": "CO",
    "deviceGeolocation": {
      "latitude": 4.711,
      "longitude": -74.0721
    },
    "ocrAddress": {
      "fileId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "fileUrl": "https://s3.amazonaws.com/bucket/comprobante.pdf"
    }
  }
}'

Example Request Body

{
  "publicId": "a1b2c3d4-flow-def",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "addressData": {
    "zipCode": "110111",
    "address": "Calle Principal 123",
    "department": "Cundinamarca",
    "municipality": "Bogotá",
    "country": "CO",
    "deviceGeolocation": {
      "latitude": 4.711,
      "longitude": -74.0721
    },
    "ocrAddress": {
      "fileId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "fileUrl": "https://s3.amazonaws.com/bucket/comprobante.pdf"
    }
  }
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Adamo ID — Queue Service

Ejecución de flujos

Procesamiento asíncrono de documentos de identidad

Extraer datos del documento de identidad

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/identity/analyze-and-extract-document-data

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo llamarlo

Después de subir la imagen del frente con POST /upload-id-still. Las URLs del body se construyen concatenando la base URL del servicio GPU con los paths devueltos por ese endpoint.

Origen de cada campo del body

Campo	Origen
`imageSrc`	`https://w7hghxo7gyc3do-3005.proxy.runpod.net` + `used_id_path`
`rawImageSrc`	`https://w7hghxo7gyc3do-3005.proxy.runpod.net` + `used_id_raw_path`
`croppedFaceImageSrc`	`https://w7hghxo7gyc3do-3005.proxy.runpod.net` + `cropped_face`
`croppedDocumentImageSrc`	`https://w7hghxo7gyc3do-3005.proxy.runpod.net` + `id_crop_url`

Resultado por Socket.io

Extraer datos del documento de identidad › Request Body

imageSrc

string · required

URL completa de la imagen del frente procesada por GPU (https://w7hghxo7gyc3do-3005.proxy.runpod.net + used_id_path)

Example: https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front.jpg

rawImageSrc

string · required

URL completa de la imagen original sin procesar (https://w7hghxo7gyc3do-3005.proxy.runpod.net + used_id_raw_path)

Example: https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front_raw.jpg

croppedFaceImageSrc

string · required

URL completa del recorte del rostro detectado (https://w7hghxo7gyc3do-3005.proxy.runpod.net + cropped_face)

Example: https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/face_crop.jpg

croppedDocumentImageSrc

string · required

URL completa del recorte del documento (https://w7hghxo7gyc3do-3005.proxy.runpod.net + id_crop_url)

Example: https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_crop.jpg

selectedCountry

string · required

Código ISO 3166-1 alpha-2 del país emisor del documento

Example: CO

selectedDocument

string · enum · required

Tipo de documento seleccionado por el usuario

Enum values:

passport

driver_license

ppt

Example: id

invitationId

string · uuid · required

UUID de la invitación, usado para enrutar el resultado por Socket.io al canal correcto

Example: 550e8400-e29b-41d4-a716-446655440000

Extraer datos del documento de identidad › Responses

Solicitud de extracción encolada correctamente. El resultado se entrega por Socket.io.

success

boolean

POST/identity/analyze-and-extract-document-data

curl https://kyc-journey-queue-manager-dev.adamoservices.co/identity/analyze-and-extract-document-data \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "imageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front.jpg",
  "rawImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front_raw.jpg",
  "croppedFaceImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/face_crop.jpg",
  "croppedDocumentImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_crop.jpg",
  "selectedCountry": "CO",
  "selectedDocument": "id",
  "invitationId": "550e8400-e29b-41d4-a716-446655440000"
}'

Example Request Body

{
  "imageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front.jpg",
  "rawImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_front_raw.jpg",
  "croppedFaceImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/face_crop.jpg",
  "croppedDocumentImageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_crop.jpg",
  "selectedCountry": "CO",
  "selectedDocument": "id",
  "invitationId": "550e8400-e29b-41d4-a716-446655440000"
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Verificar autenticidad del documento

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/identity/analyze-document-authenticity

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo llamarlo

Después de subir el dorso con POST /upload-id-back-still. La URL de la imagen se construye concatenando la base URL del servicio GPU con el path devuelto por ese endpoint:

Code
imageSrc = https://w7hghxo7gyc3do-3005.proxy.runpod.net{used_id_back_path}

Resultado

Verificar autenticidad del documento › Request Body

imageSrc

string · required

URL completa de la imagen del dorso procesada por GPU (https://w7hghxo7gyc3do-3005.proxy.runpod.net + used_id_back_path)

Example: https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_back.jpg

selectedCountry

string · required

Código ISO 3166-1 alpha-2 del país emisor del documento

Example: CO

selectedDocument

string · enum · required

Tipo de documento. No aplica para passport.

Enum values:

driver_license

ppt

Example: id

invitationId

string · uuid · required

UUID de la invitación, usado para asociar el resultado de autenticidad

Example: 550e8400-e29b-41d4-a716-446655440000

Verificar autenticidad del documento › Responses

Solicitud de verificación de autenticidad encolada correctamente

success

boolean

POST/identity/analyze-document-authenticity

curl https://kyc-journey-queue-manager-dev.adamoservices.co/identity/analyze-document-authenticity \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "imageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_back.jpg",
  "selectedCountry": "CO",
  "selectedDocument": "id",
  "invitationId": "550e8400-e29b-41d4-a716-446655440000"
}'

Example Request Body

{
  "imageSrc": "https://gpu.example.com/uploads/906ab27fd0f04e9db9e1c0b7378b51ad/id_back.jpg",
  "selectedCountry": "CO",
  "selectedDocument": "id",
  "invitationId": "550e8400-e29b-41d4-a716-446655440000"
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Analizar sesión de prueba de vida

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/liveness/analyze-liveness-session

Inicia el análisis completo de la sesión de prueba de vida de forma asíncrona. La respuesta es inmediata ({ success: true }); el procesamiento continúa en background.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo llamarlo

Después de subir el video con POST /upload-live-clip. El req_id debe ser el mismo usado durante toda la sesión GPU.

Resultado

Analizar sesión de prueba de vida › Request Body

publicId

string · required

Identificador del flujo de verificación (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

flowRunId

string · uuid · required

UUID de la ejecución del flujo (devuelto por POST /flow-runs/start como runUuid)

Example: 550e8400-e29b-41d4-a716-446655440000

authToken

string · required

Token de autorización obtenido en POST /flow-runs/start

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

reqId

string · required

Identificador de la sesión GPU usado durante toda la captura

Example: 906ab27fd0f04e9db9e1c0b7378b51ad

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Analizar sesión de prueba de vida › Responses

Análisis encolado correctamente. El procesamiento continúa en background.

success

boolean

POST/liveness/analyze-liveness-session

curl https://kyc-journey-queue-manager-dev.adamoservices.co/liveness/analyze-liveness-session \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "reqId": "906ab27fd0f04e9db9e1c0b7378b51ad",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}'

Example Request Body

{
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "reqId": "906ab27fd0f04e9db9e1c0b7378b51ad",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Registrar resultado de verificación de IP

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/ip/verify-ip

Registra el resultado de la verificación de IP en el sistema. La respuesta es inmediata ({ success: true }).

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo llamarlo

Inmediatamente después de recibir la respuesta de POST /verifications/ip-verification. El campo formData.ipVerificationData debe contener exactamente la respuesta completa de ese endpoint.

Registrar resultado de verificación de IP › Request Body

publicId

string · required

Identificador del flujo (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

flowRunId

string · uuid · required

UUID de la ejecución del flujo (devuelto por POST /flow-runs/start como runUuid)

Example: 550e8400-e29b-41d4-a716-446655440000

authToken

string · required

Token de autorización obtenido en POST /flow-runs/start

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

object · required

Registrar resultado de verificación de IP › Responses

Resultado registrado correctamente

success

boolean

POST/ip/verify-ip

curl https://kyc-journey-queue-manager-dev.adamoservices.co/ip/verify-ip \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "formData": {
    "ipVerificationData": {
      "message": "IP verificada correctamente",
      "data": {
        "ip": "190.85.42.100",
        "security": {
          "vpn": false,
          "proxy": false,
          "tor": false,
          "relay": false
        },
        "location": {
          "city": "Medellín",
          "region": "Antioquia",
          "country": "Colombia",
          "country_code": "CO",
          "latitude": "6.2476",
          "longitude": "-75.5679",
          "time_zone": "America/Bogota"
        },
        "network": {
          "network": "190.85.0.0/16",
          "autonomous_system_number": "AS27943",
          "autonomous_system_organization": "Claro Colombia"
        }
      },
      "pagination": null,
      "timestamp": "2026-06-04T10:30:00Z"
    }
  }
}'

Example Request Body

{
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "formData": {
    "ipVerificationData": {
      "message": "IP verificada correctamente",
      "data": {
        "ip": "190.85.42.100",
        "security": {
          "vpn": false,
          "proxy": false,
          "tor": false,
          "relay": false
        },
        "location": {
          "city": "Medellín",
          "region": "Antioquia",
          "country": "Colombia",
          "country_code": "CO",
          "latitude": "6.2476",
          "longitude": "-75.5679",
          "time_zone": "America/Bogota"
        },
        "network": {
          "network": "190.85.0.0/16",
          "autonomous_system_number": "AS27943",
          "autonomous_system_organization": "Claro Colombia"
        }
      },
      "pagination": null,
      "timestamp": "2026-06-04T10:30:00Z"
    }
  }
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Registrar verificación de correo con OTP

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/email/verify-code

Valida el OTP ingresado por el usuario y registra el resultado en el sistema.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Errores de OTP

Si el código es incorrecto, la respuesta incluye los detalles del error (intentos restantes, expiración, etc.).

Registrar verificación de correo con OTP › Request Body

email

string · email · required

Correo electrónico del usuario

Example: usuario@ejemplo.com

code

string · required

OTP de 6 caracteres alfanuméricos recibido por correo

Example: A1B2C3

publicId

string · required

Identificador del flujo (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

flowRunId

string · uuid · required

UUID de la ejecución del flujo (devuelto por POST /flow-runs/start como runUuid)

Example: 550e8400-e29b-41d4-a716-446655440000

authToken

string · required

Token de autorización obtenido en POST /flow-runs/start

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Registrar verificación de correo con OTP › Responses

Verificación registrada correctamente

success

boolean

POST/email/verify-code

curl https://kyc-journey-queue-manager-dev.adamoservices.co/email/verify-code \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "email": "usuario@ejemplo.com",
  "code": "A1B2C3",
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}'

Example Request Body

{
  "email": "usuario@ejemplo.com",
  "code": "A1B2C3",
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Registrar verificación de teléfono con OTP

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/phone/verify-code

Valida el código ingresado por el usuario y registra el resultado en el sistema.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Variante SMS (`callMade: false`)

Valida el OTP enviado via SMS por POST /verifications/phone-verification.

Variante llamada (`callMade: true`)

Valida el código recibido por llamada telefónica, usando el SID de Twilio generado en POST /phone/send-code-to-verify-by-call.

Errores

Si el código es incorrecto, la respuesta incluye los detalles del error (intentos restantes, expiración, etc.).

Registrar verificación de teléfono con OTP › Request Body

phone

string · required

Número de teléfono en formato E.164

Example: +573001234567

code

string · required

Código OTP de 6 caracteres alfanuméricos

Example: A1B2C3

publicId

string · required

Identificador del flujo (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

flowRunId

string · uuid · required

UUID de la ejecución del flujo (devuelto por POST /flow-runs/start como runUuid)

Example: 550e8400-e29b-41d4-a716-446655440000

authToken

string · required

Token de autorización obtenido en POST /flow-runs/start

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

language

string · required

Idioma. Valores posibles: es, en

Example: es

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

callMade

boolean · required

true si el código fue recibido por llamada telefónica, false si fue por SMS

Example: false

Registrar verificación de teléfono con OTP › Responses

Verificación registrada correctamente

success

boolean

POST/phone/verify-code

curl https://kyc-journey-queue-manager-dev.adamoservices.co/phone/verify-code \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "phone": "+573001234567",
  "code": "A1B2C3",
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "language": "es",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "callMade": false
}'

Example Request Body

{
  "phone": "+573001234567",
  "code": "A1B2C3",
  "publicId": "a1b2c3d4-flow-def",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "language": "es",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "callMade": false
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Solicitar código de verificación por llamada telefónica

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/phone/send-code-to-verify-by-call

Realiza una llamada telefónica al número indicado y dicta un código OTP. Alternativa al envío por SMS.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo usarlo

Cuando el usuario no recibe el SMS o prefiere verificar por llamada. Tras llamar a este endpoint, usar POST /phone/verify-code con callMade: true para validar el código recibido.

Solicitar código de verificación por llamada telefónica › Request Body

phone

string · required

Número de teléfono en formato E.164

Example: +573001234567

language

string · required

Idioma de la llamada. Valores posibles: es, en

Example: es

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Solicitar código de verificación por llamada telefónica › Responses

Llamada iniciada correctamente

success

boolean

Validar comprobante de domicilio

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/address/validate-document

Verifica que el comprobante subido contiene datos de dirección extraíbles mediante OCR. El proceso puede tardar hasta 10 minutos.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Cuándo llamarlo

Validar comprobante de domicilio › Request Body

fileUrl

string · uri · required

URL del archivo devuelta por POST /flow/progress/upload-file

Example: https://s3.amazonaws.com/bucket/comprobante.pdf

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

publicId

string · required

Identificador del flujo (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

Validar comprobante de domicilio › Responses

Resultado de la validación del documento

success

boolean

isValid

boolean

true si el documento contiene datos de dirección extraíbles, false si no

Example: true

reason

string | null

Motivo del fallo si isValid es false. Valores posibles: timeout, no_data, error

Example: null

Registrar verificación de domicilio

POST

https://kyc-journey-queue-manager-dev.adamoservices.co

/address/address-verification

Envía los datos de dirección del usuario e inicia el procesamiento en background. La respuesta es inmediata — el análisis continúa de forma asíncrona.

Requiere autenticación con el token obtenido en POST /flow-runs/start.

Procesamiento en background

El sistema realiza los siguientes pasos de forma asíncrona:

Geocodificación inversa: convierte las coordenadas del dispositivo en dirección legible
Geocodificación directa: convierte la dirección declarada en coordenadas
Cálculo de distancia: compara la ubicación del dispositivo con la dirección declarada (fórmula de Haversine)
OCR del comprobante (solo si se incluye ocrAddress): extrae la dirección del documento y calcula la distancia respecto a la ubicación del dispositivo

Variantes del campo `addressData`

Con comprobante (askForEvidence: true): incluir el objeto ocrAddress con fileId y fileUrl
Sin comprobante (askForEvidence: false): omitir el objeto ocrAddress

Registrar verificación de domicilio › Request Body

publicId

string · required

Identificador del flujo (devuelto por GET /flow-runs/verify/{invitationToken} como flowId)

Example: a1b2c3d4-flow-def

invitationId

string · uuid · required

UUID de la invitación

Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

flowRunId

string · uuid · required

UUID de la ejecución del flujo (devuelto por POST /flow-runs/start como runUuid)

Example: 550e8400-e29b-41d4-a716-446655440000

authToken

string · required

Token de autorización obtenido en POST /flow-runs/start

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

object · required

Registrar verificación de domicilio › Responses

Verificación iniciada correctamente

success

boolean

POST/address/address-verification

curl https://kyc-journey-queue-manager-dev.adamoservices.co/address/address-verification \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "publicId": "a1b2c3d4-flow-def",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "addressData": {
    "zipCode": "110111",
    "address": "Calle Principal 123",
    "department": "Cundinamarca",
    "municipality": "Bogotá",
    "country": "CO",
    "deviceGeolocation": {
      "latitude": 4.711,
      "longitude": -74.0721
    },
    "ocrAddress": {
      "fileId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "fileUrl": "https://s3.amazonaws.com/bucket/comprobante.pdf"
    }
  }
}'

Example Request Body

{
  "publicId": "a1b2c3d4-flow-def",
  "invitationId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "flowRunId": "550e8400-e29b-41d4-a716-446655440000",
  "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "addressData": {
    "zipCode": "110111",
    "address": "Calle Principal 123",
    "department": "Cundinamarca",
    "municipality": "Bogotá",
    "country": "CO",
    "deviceGeolocation": {
      "latitude": 4.711,
      "longitude": -74.0721
    },
    "ocrAddress": {
      "fileId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "fileUrl": "https://s3.amazonaws.com/bucket/comprobante.pdf"
    }
  }
}

json

application/json

Example Responses

{
  "success": true
}

json

application/json

Ejecución de flujos

Extraer datos del documento de identidad

Cuándo llamarlo

Origen de cada campo del body

Resultado por Socket.io

Extraer datos del documento de identidad › Request Body

Extraer datos del documento de identidad › Responses

Verificar autenticidad del documento

Cuándo llamarlo

Resultado

Verificar autenticidad del documento › Request Body

Verificar autenticidad del documento › Responses

Analizar sesión de prueba de vida

Cuándo llamarlo

Resultado

Analizar sesión de prueba de vida › Request Body

Analizar sesión de prueba de vida › Responses

Registrar resultado de verificación de IP

Cuándo llamarlo

Registrar resultado de verificación de IP › Request Body

Registrar resultado de verificación de IP › Responses

Registrar verificación de correo con OTP

Errores de OTP

Registrar verificación de correo con OTP › Request Body

Registrar verificación de correo con OTP › Responses

Registrar verificación de teléfono con OTP

Variante SMS (callMade: false)

Variante llamada (callMade: true)

Errores

Registrar verificación de teléfono con OTP › Request Body

Registrar verificación de teléfono con OTP › Responses

Solicitar código de verificación por llamada telefónica

Cuándo usarlo

Solicitar código de verificación por llamada telefónica › Request Body

Solicitar código de verificación por llamada telefónica › Responses

Validar comprobante de domicilio

Cuándo llamarlo

Validar comprobante de domicilio › Request Body

Validar comprobante de domicilio › Responses

Registrar verificación de domicilio

Procesamiento en background

Variantes del campo addressData

Registrar verificación de domicilio › Request Body

Registrar verificación de domicilio › Responses

Ejecución de flujos

Extraer datos del documento de identidad

Cuándo llamarlo

Origen de cada campo del body

Resultado por Socket.io

Extraer datos del documento de identidad › Request Body

Extraer datos del documento de identidad › Responses

Verificar autenticidad del documento

Cuándo llamarlo

Resultado

Verificar autenticidad del documento › Request Body

Verificar autenticidad del documento › Responses

Analizar sesión de prueba de vida

Cuándo llamarlo

Resultado

Analizar sesión de prueba de vida › Request Body

Analizar sesión de prueba de vida › Responses

Registrar resultado de verificación de IP

Cuándo llamarlo

Registrar resultado de verificación de IP › Request Body

Registrar resultado de verificación de IP › Responses

Registrar verificación de correo con OTP

Errores de OTP

Registrar verificación de correo con OTP › Request Body

Registrar verificación de correo con OTP › Responses

Registrar verificación de teléfono con OTP

Variante SMS (callMade: false)

Variante llamada (callMade: true)

Errores

Registrar verificación de teléfono con OTP › Request Body

Registrar verificación de teléfono con OTP › Responses

Solicitar código de verificación por llamada telefónica

Cuándo usarlo

Solicitar código de verificación por llamada telefónica › Request Body

Solicitar código de verificación por llamada telefónica › Responses

Validar comprobante de domicilio

Variante SMS (`callMade: false`)

Variante llamada (`callMade: true`)

Variantes del campo `addressData`

Variante SMS (`callMade: false`)

Variante llamada (`callMade: true`)

Variantes del campo `addressData`