Skip to main content
POST
Verificar destinatario (Venezuela)

Autorizaciones

Authorization
string
header
requerido

Token de autenticación de API de usuario con formato cash_<64-char-hex>. Valor de ejemplo cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.

Cuerpo

application/json
accountId
string<uuid>
requerido
Ejemplo:

"YOUR_ACCOUNT_UUID"

email
string<email>
requerido
Ejemplo:

"payer@example.com"

documentoIdentidad
string
requerido

Solo dígitos. Se quita un prefijo coincidente V-, J-, P- o E-.

Ejemplo:

"00000000"

tipoDocumento
string
requerido

value del catálogo en country.documentTypes. V, J, P o E.

Ejemplo:

"V"

numeroCuenta
string
firstName
string
lastName
string
prefijoTelefono
string
Ejemplo:

"+58"

numeroTelefono
string
Ejemplo:

"0000000000"

direccion
string
ciudad
string

Respuesta

Resultado de la verificación. No crea una transacción.

status
enum<string>
requerido
Opciones disponibles:
ready,
kyc_approved_no_account,
kyc_in_progress,
kyc_not_started,
kyc_declined
empleado_id
integer

Se omite cuando el correo no está registrado. Se incluye para un destinatario existente, también en kyc_declined.

kyc_url
string<uri>

Para un destinatario existente, kyc_not_started incluye esto cuando se emitió una URL de sesión. kyc_in_progress lo incluye solo cuando el payload de estado lo trae, o cuando un payout de este accountId ya guardó uno. Nunca se toma de transacciones de otra cuenta. Se omite en kyc_not_started si el correo no está registrado.

code
enum<string>

Presente solo cuando status es kyc_declined.

Opciones disponibles:
KOLLAT_KYC_DECLINED