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
}Check recipient (Venezuela)
Check a recipient before a payout. This does not create a transaction, does not reserve USDT, and does not save a bank account.
Required: accountId (operative USDT account the caller can pay from), email, documentoIdentidad, tipoDocumento.
Optional: numeroCuenta. When numeroCuenta is sent, ready means identity verification is approved and that account is already on file.
When it is omitted, ready means approved and a bank account is already on file.
documentoIdentidad is digits only. The letter belongs in tipoDocumento (V, J, P, or E from GET /ve/banks).
A matching V-, J-, P-, or E- prefix is accepted and stripped.
A missing account returns 404. A caller who cannot pay from that account, or an account that is not a Venezuela USDT account, returns 403.
A non-operative account returns 403 with code: ACCOUNT_NOT_OPERATIVE.
firstName, lastName, prefijoTelefono, numeroTelefono, direccion, and ciudad are required only when the email is not already registered
(400, code: KOLLAT_RECIPIENT_DETAILS_REQUIRED). When those fields are present and the email is still not registered, the response is
kyc_not_started without empleado_id and without kyc_url.
A document that does not match an existing email returns 400 with code: KOLLAT_IDENTITY_UNCONFIRMED and does not start identity verification.
Success status is ready, kyc_approved_no_account, kyc_in_progress, kyc_not_started, or kyc_declined.
kyc_declined includes code: KOLLAT_KYC_DECLINED and empleado_id.
For an existing recipient, kyc_not_started returns kyc_url when a session URL was issued.
kyc_in_progress includes kyc_url only when the status payload has one, or when a payout on this accountId already stored one.
Do not read that URL from another account’s transactions.
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
}Authorizations
User API authentication token with format cash_<64-char-hex>. Sample value cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.
Body
"YOUR_ACCOUNT_UUID"
"payer@example.com"
Digits only. A matching V-, J-, P-, or E- prefix is stripped.
"00000000"
Catalogue value from country.documentTypes. V, J, P, or E.
"V"
"+58"
"0000000000"
Response
Recipient check result. Does not create a transaction.
ready, kyc_approved_no_account, kyc_in_progress, kyc_not_started, kyc_declined Omitted when the email is not registered. Included for an existing recipient, including kyc_declined.
For an existing recipient, kyc_not_started includes this when a session URL was issued. kyc_in_progress includes it only when the status payload has one, or when a payout on this accountId already stored one. Never taken from another account's transactions. Omitted on kyc_not_started for an email that is not registered.
Present only when status is kyc_declined.
KOLLAT_KYC_DECLINED 
