Schemas

CreateFlowRequest

type

string · enum · required

Tipo de flujo de verificación.

Enum values:

kyc

kyb

kyb_company

Example: kyc

name

string · minLength: 1 · maxLength: 100 · required

Nombre descriptivo del flujo.

Example: KYC Básico

FlowStepInput[] · minItems: 1 · maxItems: 20 · required

Lista de pasos del flujo. Los order deben ser consecutivos empezando en 1 y las key deben ser únicas.

object · required

Tiempo máximo que tiene el usuario para completar el flujo desde que recibe el link.

organizationId

string · uuid

UUID de la organización. Si se omite, se usa la del token.

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

code

string · minLength: 3 · maxLength: 50 · pattern: ^[A-Z0-9_]+$

Código único del flujo dentro de la organización. Solo letras mayúsculas, números y guiones bajos.

Example: KYC_EMPLEADOS_2024

description

string · maxLength: 500

Descripción opcional del propósito del flujo.

Example: Flujo de verificación para incorporación de empleados

tags

string[]

Etiquetas para organizar y filtrar flujos.

Example: ["onboarding","empleados"]

FlowStepInput

key

string · pattern: ^[a-z0-9_-]+$ · required

Identificador único del paso dentro del flujo.

Example: id-document

label

string · minLength: 1 · maxLength: 100 · required

Nombre legible del paso que se muestra al usuario.

Example: Verificación de documento de identidad

type

string · enum · required

Tipo de verificación que realiza el paso.

Enum values:

id_document

facial

liveness

proof_of_address

phone

ip_risk

ip_verification

Example: id_document

order

integer · min: 1 · required

Posición del paso en el flujo (único y consecutivo desde 1).

Example: 1

object · required

Microservicio o proveedor que ejecuta este paso.

required

boolean

Si el paso es obligatorio para completar el flujo.

Example: true

Default: true

object

Política de reintentos si el paso falla.

riskWeight

number · min: 0 · max: 10

Peso de este paso en el score de riesgo global del flujo.

Example: 2

Default: 1

FlowDefinition

uuid

string · uuid

Identificador público del flujo.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

organizationId

string · uuid

name

string

code

string

description

string

type

string · enum

Enum values:

kyc

kyb

kyb_company

Example: kyc

status

string · enum

Estado actual del flujo. Los flujos nuevos se crean y publican automáticamente en published.

Enum values:

draft

published

archived

deleted

Example: published

version

integer

FlowStepInput[]

tags

string[]

object

Estadísticas acumuladas del flujo.

createdByUserId

string

createdAt

string · date-time

updatedAt

string · date-time

Error

success

boolean

error

string

ValidationError

success

boolean

error

string

object[]

SendInvitationRequest

InvitationListItem/properties/recipient · required

Datos del destinatario. Se requiere al menos email o phone.

channels

DeliveryChannel[] · minItems: 1 · required

Canales por los cuales se enviará la invitación. Se permite más de uno simultáneamente.

Si incluye email → recipient.email es obligatorio.
Si incluye sms, whatsapp o telegram → recipient.phone es obligatorio.
link_only genera el enlace sin enviar notificación.

Enum values:

sms

link_only

Example: ["email","whatsapp"]

expirationHours

integer · min: 1 · max: 168

Horas hasta que expire la invitación (máximo 7 días).

Example: 48

Default: 72

object

Metadatos adicionales asociados a la invitación (referencia interna, campaña, etc.).

Example: {"campaignId":"camp_2024_q1","internalRef":"SOL-2024-00456"}

InvitationResponse

success

boolean

object

message

string

InvitationListItem

id

string · uuid

organizationId

string | null · uuid

type

string · enum

Enum values:

kyc

kyb

Example: kyc

flowId

string · uuid

object

Datos del destinatario. Se requiere al menos email o phone.

channels

DeliveryChannel[]

Enum values:

sms

link_only

Example: ["email"]

status

string · enum

Estado actual de la invitación.

Enum values:

created

sent

used

failed

expired

Example: sent

linkToken

string

sentAt

string | null · date-time

usedAt

string | null · date-time

expiresAt

string · date-time

createdAt

string · date-time

updatedAt

string · date-time

BulkInvitationResponse

success

boolean

object

DeliveryChannel

string · enum

Enum values:

sms

link_only

Canal de entrega para la invitación.

KycResultListItem

uuid

string · uuid

flowRunUuid

string · uuid

date

string · date-time

completedDate

string | null · date-time

name

string

email

string

documentId

string

documentType

string

object[]

totalSteps

integer

Total de pasos en el flujo

Example: 5

ipAddress

string

status

string · enum

Enum values:

in_progress

completed

abandoned

expired

saved_for_later

Example: completed

result

string · enum

Enum values:

approved

rejected

requires_review

pending

Example: approved

riskLevel

string · enum

Enum values:

low

medium

high

critical

Example: low

KybResultListItem

uuid

string · uuid

flowRunUuid

string · uuid

date

string · date-time

completedDate

string | null · date-time

companyName

string

taxId

string

documentType

string

KycResultListItem/properties/verifications/items[]

totalSteps

integer

Total de pasos en el flujo

Example: 8

status

string · enum

Enum values:

in_progress

completed

abandoned

expired

saved_for_later

Example: completed

result

string · enum

Enum values:

approved

rejected

requires_review

pending

Example: requires_review

riskLevel

string · enum

Enum values:

low

medium

high

critical

Example: medium

RejectResultRequest

rejectionReason

string · minLength: 10 · required

Razón del rechazo (mínimo 10 caracteres)

Example: Documento de identidad ilegible y no se puede verificar la autenticidad

rejectedBy

string · required

Usuario/revisor que rechaza

Example: Juan Pérez - Analista de Cumplimiento

comments

string

Comentarios adicionales opcionales

Example: Por favor, envíe una imagen más clara del documento

sendNotification

boolean

Enviar notificación por correo (default true)

Default: true

ApproveResultRequest

approvedBy

string · minLength: 2 · required

Usuario/revisor que aprueba (mínimo 2 caracteres)

Example: Juan Pérez - Oficial de Compliance

comments

string

Comentarios adicionales opcionales

Example: Documentación completa y verificada correctamente

riskLevel

string · enum

Nivel de riesgo asignado

Enum values:

low

medium

high

critical

Example: low

score

number · min: 0 · max: 100

Score de evaluación (0-100)

Example: 95

sendNotification

boolean

Enviar notificación por correo (default true)

Default: true

ResultDecisionResponse

success

boolean

message

string

object

EditFieldRequest

editedBy

string · required

Usuario que realiza la edición

Example: admin@example.com

stepKey

string · required

Clave del step donde está el campo

Example: step02

fieldPath

string · required

Ruta del campo a editar (notación de punto)

Example: formData.personalInfo.firstName

newValue

required

Nuevo valor del campo

Example: Andre

changeReason

string

Razón del cambio (para auditoría)

Example: Corrección de error tipográfico

AddCommentRequest

createdBy

string · required

Usuario que crea el comentario

Example: revisor@example.com

content

string · required

Contenido del comentario

Example: Esta persona ya es residente, evaluar muy atentamente los datos enviados

commentType

string · enum

Tipo de comentario

Enum values:

general

alert

review

approval

Example: alert

relatedStepKey

string

Step relacionado (opcional)

Example: step02

relatedFieldPath

string

Campo relacionado (opcional)

Example: formData.personalInfo.address

ResultHistoryResponse

success

boolean

object

Adamo ID API

Schemas

CreateFlowRequest

type

string · enum · required

Tipo de flujo de verificación.

Enum values:

kyc

kyb

kyb_company

Example: kyc

name

string · minLength: 1 · maxLength: 100 · required

Nombre descriptivo del flujo.

Example: KYC Básico

FlowStepInput[] · minItems: 1 · maxItems: 20 · required

Lista de pasos del flujo. Los order deben ser consecutivos empezando en 1 y las key deben ser únicas.

object · required

Tiempo máximo que tiene el usuario para completar el flujo desde que recibe el link.

organizationId

string · uuid

UUID de la organización. Si se omite, se usa la del token.

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

code

string · minLength: 3 · maxLength: 50 · pattern: ^[A-Z0-9_]+$

Código único del flujo dentro de la organización. Solo letras mayúsculas, números y guiones bajos.

Example: KYC_EMPLEADOS_2024

description

string · maxLength: 500

Descripción opcional del propósito del flujo.

Example: Flujo de verificación para incorporación de empleados

tags

string[]

Etiquetas para organizar y filtrar flujos.

Example: ["onboarding","empleados"]

FlowStepInput

key

string · pattern: ^[a-z0-9_-]+$ · required

Identificador único del paso dentro del flujo.

Example: id-document

label

string · minLength: 1 · maxLength: 100 · required

Nombre legible del paso que se muestra al usuario.

Example: Verificación de documento de identidad

type

string · enum · required

Tipo de verificación que realiza el paso.

Enum values:

id_document

facial

liveness

proof_of_address

phone

ip_risk

ip_verification

Example: id_document

order

integer · min: 1 · required

Posición del paso en el flujo (único y consecutivo desde 1).

Example: 1

object · required

Microservicio o proveedor que ejecuta este paso.

required

boolean

Si el paso es obligatorio para completar el flujo.

Example: true

Default: true

object

Política de reintentos si el paso falla.

riskWeight

number · min: 0 · max: 10

Peso de este paso en el score de riesgo global del flujo.

Example: 2

Default: 1

FlowDefinition

uuid

string · uuid

Identificador público del flujo.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

organizationId

string · uuid

name

string

code

string

description

string

type

string · enum

Enum values:

kyc

kyb

kyb_company

Example: kyc

status

string · enum

Estado actual del flujo. Los flujos nuevos se crean y publican automáticamente en published.

Enum values:

draft

published

archived

deleted

Example: published

version

integer

FlowStepInput[]

tags

string[]

object

Estadísticas acumuladas del flujo.

createdByUserId

string

createdAt

string · date-time

updatedAt

string · date-time

Error

success

boolean

error

string

ValidationError

success

boolean

error

string

object[]

SendInvitationRequest

InvitationListItem/properties/recipient · required

Datos del destinatario. Se requiere al menos email o phone.

channels

DeliveryChannel[] · minItems: 1 · required

Canales por los cuales se enviará la invitación. Se permite más de uno simultáneamente.

Si incluye email → recipient.email es obligatorio.
Si incluye sms, whatsapp o telegram → recipient.phone es obligatorio.
link_only genera el enlace sin enviar notificación.

Enum values:

sms

link_only

Example: ["email","whatsapp"]

expirationHours

integer · min: 1 · max: 168

Horas hasta que expire la invitación (máximo 7 días).

Example: 48

Default: 72

object

Metadatos adicionales asociados a la invitación (referencia interna, campaña, etc.).

Example: {"campaignId":"camp_2024_q1","internalRef":"SOL-2024-00456"}

InvitationResponse

success

boolean

object

message

string

InvitationListItem

id

string · uuid

organizationId

string | null · uuid

type

string · enum

Enum values:

kyc

kyb

Example: kyc

flowId

string · uuid

object

Datos del destinatario. Se requiere al menos email o phone.

channels

DeliveryChannel[]

Enum values:

sms

link_only

Example: ["email"]

status

string · enum

Estado actual de la invitación.

Enum values:

created

sent

used

failed

expired

Example: sent

linkToken

string

sentAt

string | null · date-time

usedAt

string | null · date-time

expiresAt

string · date-time

createdAt

string · date-time

updatedAt

string · date-time

BulkInvitationResponse

success

boolean

object

DeliveryChannel

string · enum

Enum values:

sms

link_only

Canal de entrega para la invitación.

KycResultListItem

uuid

string · uuid

flowRunUuid

string · uuid

date

string · date-time

completedDate

string | null · date-time

name

string

email

string

documentId

string

documentType

string

object[]

totalSteps

integer

Total de pasos en el flujo

Example: 5

ipAddress

string

status

string · enum

Enum values:

in_progress

completed

abandoned

expired

saved_for_later

Example: completed

result

string · enum

Enum values:

approved

rejected

requires_review

pending

Example: approved

riskLevel

string · enum

Enum values:

low

medium

high

critical

Example: low

KybResultListItem

uuid

string · uuid

flowRunUuid

string · uuid

date

string · date-time

completedDate

string | null · date-time

companyName

string

taxId

string

documentType

string

KycResultListItem/properties/verifications/items[]

totalSteps

integer

Total de pasos en el flujo

Example: 8

status

string · enum

Enum values:

in_progress

completed

abandoned

expired

saved_for_later

Example: completed

result

string · enum

Enum values:

approved

rejected

requires_review

pending

Example: requires_review

riskLevel

string · enum

Enum values:

low

medium

high

critical

Example: medium

RejectResultRequest

rejectionReason

string · minLength: 10 · required

Razón del rechazo (mínimo 10 caracteres)

Example: Documento de identidad ilegible y no se puede verificar la autenticidad

rejectedBy

string · required

Usuario/revisor que rechaza

Example: Juan Pérez - Analista de Cumplimiento

comments

string

Comentarios adicionales opcionales

Example: Por favor, envíe una imagen más clara del documento

sendNotification

boolean

Enviar notificación por correo (default true)

Default: true

ApproveResultRequest

approvedBy

string · minLength: 2 · required

Usuario/revisor que aprueba (mínimo 2 caracteres)

Example: Juan Pérez - Oficial de Compliance

comments

string

Comentarios adicionales opcionales

Example: Documentación completa y verificada correctamente

riskLevel

string · enum

Nivel de riesgo asignado

Enum values:

low

medium

high

critical

Example: low

score

number · min: 0 · max: 100

Score de evaluación (0-100)

Example: 95

sendNotification

boolean

Enviar notificación por correo (default true)

Default: true

ResultDecisionResponse

success

boolean

message

string

object

EditFieldRequest

editedBy

string · required

Usuario que realiza la edición

Example: admin@example.com

stepKey

string · required

Clave del step donde está el campo

Example: step02

fieldPath

string · required

Ruta del campo a editar (notación de punto)

Example: formData.personalInfo.firstName

newValue

required

Nuevo valor del campo

Example: Andre

changeReason

string

Razón del cambio (para auditoría)

Example: Corrección de error tipográfico

AddCommentRequest

createdBy

string · required

Usuario que crea el comentario

Example: revisor@example.com

content

string · required

Contenido del comentario

Example: Esta persona ya es residente, evaluar muy atentamente los datos enviados

commentType

string · enum

Tipo de comentario

Enum values:

general

alert

review

approval

Example: alert

relatedStepKey

string

Step relacionado (opcional)

Example: step02

relatedFieldPath

string

Campo relacionado (opcional)

Example: formData.personalInfo.address

ResultHistoryResponse

success

boolean

object