curl --request POST \
--url https://hg.cash/api/v1/ve/recipients/kyc \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accountId": "YOUR_ACCOUNT_UUID",
"email": "payer@example.com",
"documentoIdentidad": "00000000",
"tipoDocumento": "V"
}
'import requests
url = "https://hg.cash/api/v1/ve/recipients/kyc"
payload = {
"accountId": "YOUR_ACCOUNT_UUID",
"email": "payer@example.com",
"documentoIdentidad": "00000000",
"tipoDocumento": "V"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accountId: 'YOUR_ACCOUNT_UUID',
email: 'payer@example.com',
documentoIdentidad: '00000000',
tipoDocumento: 'V'
})
};
fetch('https://hg.cash/api/v1/ve/recipients/kyc', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hg.cash/api/v1/ve/recipients/kyc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'accountId' => 'YOUR_ACCOUNT_UUID',
'email' => 'payer@example.com',
'documentoIdentidad' => '00000000',
'tipoDocumento' => 'V'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hg.cash/api/v1/ve/recipients/kyc"
payload := strings.NewReader("{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://hg.cash/api/v1/ve/recipients/kyc")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hg.cash/api/v1/ve/recipients/kyc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\"\n}"
response = http.request(request)
puts response.read_body{
"status": "ready",
"empleado_id": 1000
}Verificar destinatario (Venezuela)
Consulta un destinatario antes de un payout. No crea una transacción, no reserva USDT y no guarda una cuenta bancaria.
Obligatorios: accountId (cuenta USDT operativa desde la que el llamador puede pagar), email, documentoIdentidad, tipoDocumento.
Opcional: numeroCuenta. Si se envía, ready significa que la verificación de identidad está aprobada y esa cuenta ya está registrada.
Si se omite, ready significa aprobado y que ya hay una cuenta bancaria registrada.
documentoIdentidad es solo dígitos. La letra va en tipoDocumento (V, J, P o E de GET /ve/banks).
Se acepta y se quita un prefijo coincidente V-, J-, P- o E-.
Una cuenta inexistente devuelve 404. Quien no puede pagar desde esa cuenta, o una cuenta que no es USDT de Venezuela, devuelve 403.
Una cuenta no operativa devuelve 403 con code: ACCOUNT_NOT_OPERATIVE.
firstName, lastName, prefijoTelefono, numeroTelefono, direccion y ciudad son obligatorios solo cuando el correo aún no está registrado
(400, code: KOLLAT_RECIPIENT_DETAILS_REQUIRED). Si esos campos están presentes y el correo sigue sin estar registrado, la respuesta es
kyc_not_started sin empleado_id y sin kyc_url.
Un documento que no coincide con un correo existente devuelve 400 con code: KOLLAT_IDENTITY_UNCONFIRMED y no inicia la verificación de identidad.
El status de éxito es ready, kyc_approved_no_account, kyc_in_progress, kyc_not_started o kyc_declined.
kyc_declined incluye code: KOLLAT_KYC_DECLINED y empleado_id.
Para un destinatario existente, kyc_not_started devuelve kyc_url cuando se emitió una URL de sesión.
kyc_in_progress incluye kyc_url solo cuando el payload de estado la trae, o cuando un payout de este accountId ya guardó una.
No lea esa URL desde transacciones de otra cuenta.
curl --request POST \
--url https://hg.cash/api/v1/ve/recipients/kyc \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"accountId": "YOUR_ACCOUNT_UUID",
"email": "payer@example.com",
"documentoIdentidad": "00000000",
"tipoDocumento": "V"
}
'import requests
url = "https://hg.cash/api/v1/ve/recipients/kyc"
payload = {
"accountId": "YOUR_ACCOUNT_UUID",
"email": "payer@example.com",
"documentoIdentidad": "00000000",
"tipoDocumento": "V"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
accountId: 'YOUR_ACCOUNT_UUID',
email: 'payer@example.com',
documentoIdentidad: '00000000',
tipoDocumento: 'V'
})
};
fetch('https://hg.cash/api/v1/ve/recipients/kyc', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hg.cash/api/v1/ve/recipients/kyc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'accountId' => 'YOUR_ACCOUNT_UUID',
'email' => 'payer@example.com',
'documentoIdentidad' => '00000000',
'tipoDocumento' => 'V'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hg.cash/api/v1/ve/recipients/kyc"
payload := strings.NewReader("{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://hg.cash/api/v1/ve/recipients/kyc")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hg.cash/api/v1/ve/recipients/kyc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"accountId\": \"YOUR_ACCOUNT_UUID\",\n \"email\": \"payer@example.com\",\n \"documentoIdentidad\": \"00000000\",\n \"tipoDocumento\": \"V\"\n}"
response = http.request(request)
puts response.read_body{
"status": "ready",
"empleado_id": 1000
}Autorizaciones
Token de autenticación de API de usuario con formato cash_<64-char-hex>. Valor de ejemplo cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.
Cuerpo
"YOUR_ACCOUNT_UUID"
"payer@example.com"
Solo dígitos. Se quita un prefijo coincidente V-, J-, P- o E-.
"00000000"
value del catálogo en country.documentTypes. V, J, P o E.
"V"
"+58"
"0000000000"
Respuesta
Resultado de la verificación. No crea una transacción.
ready, kyc_approved_no_account, kyc_in_progress, kyc_not_started, kyc_declined Se omite cuando el correo no está registrado. Se incluye para un destinatario existente, también en kyc_declined.
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.
Presente solo cuando status es kyc_declined.
KOLLAT_KYC_DECLINED 
