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"
}Verificar destinatário (Venezuela)
Consulta um destinatário antes de um payout. Não cria uma transação, não reserva USDT e não salva uma conta bancária.
Obrigatórios: accountId (conta USDT operativa da qual quem chama pode pagar), email, documentoIdentidad, tipoDocumento.
Opcional: numeroCuenta. Quando enviado, ready significa que a verificação de identidade está aprovada e essa conta já está registrada.
Quando omitido, ready significa aprovado e que já existe uma conta bancária registrada.
documentoIdentidad é somente dígitos. A letra fica em tipoDocumento (V, J, P ou E de GET /ve/banks).
Um prefixo correspondente V-, J-, P- ou E- é aceito e removido.
Uma conta inexistente retorna 404. Quem não pode pagar a partir dessa conta, ou uma conta que não é USDT da Venezuela, retorna 403.
Uma conta não operativa retorna 403 com code: ACCOUNT_NOT_OPERATIVE. Restringida retorna 403 com code: RESTRICTED.
firstName, lastName, prefijoTelefono, numeroTelefono, direccion e ciudad são obrigatórios somente quando o e-mail ainda não está registrado
(400, code: VE_RECIPIENT_DETAILS_REQUIRED). Quando esses campos estão presentes e o e-mail continua sem registro, a resposta é
kyc_not_started sem kyc_url. Esta chamada não registra esse e-mail.
Um documento que não corresponde a um e-mail existente retorna 400 com code: VE_IDENTITY_UNCONFIRMED e não inicia a verificação de identidade.
O status de sucesso é ready, kyc_approved_no_account, kyc_in_progress, kyc_not_started ou kyc_declined.
kyc_declined inclui code: VE_KYC_DECLINED.
Para um e-mail que já está registrado e não tem sessão, esta chamada pode iniciar a verificação e retornar kyc_url.
Para um destinatário existente, kyc_not_started retorna kyc_url quando uma URL de sessão foi emitida.
kyc_in_progress inclui kyc_url somente quando o payload de status tem uma, ou quando um payout neste accountId já armazenou uma.
Não leia essa URL em transações de outra conta.
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"
}Autorizações
Token de autenticação da API do usuário com o formato cash_<64-char-hex>. Valor de exemplo cash_16cdc3b6f83c72d9d2680adca4f430962981f6bf32613a129dded0aa060387d2.
Corpo
"YOUR_ACCOUNT_UUID"
"payer@example.com"
Somente dígitos. Um prefixo correspondente V-, J-, P- ou E- é removido.
"00000000"
value do catálogo em country.documentTypes. V, J, P ou E.
"V"
"+58"
"0000000000"
Resposta
Resultado da verificação. Não cria uma transação.
ready, kyc_approved_no_account, kyc_in_progress, kyc_not_started, kyc_declined Para um e-mail que já está registrado e não tem sessão, esta chamada pode iniciar a verificação e retornar esta URL. Para um destinatário existente, kyc_not_started inclui isto quando uma URL de sessão foi emitida. kyc_in_progress inclui somente quando o payload de status tem uma, ou quando um payout neste accountId já armazenou uma. Nunca é lida de transações de outra conta. Omitida em kyc_not_started se o e-mail não está registrado.
Presente somente quando status é kyc_declined.
VE_KYC_DECLINED 
