Create KYC for Beneficiary
Submit KYC (Know Your Customer) documentation for a beneficiary before proceeding with a payout. The KYC submission helps verify the beneficiary’s identity. The email provided will be used for approving the payout process in subsequent steps.
curl --request POST \
--url https://api.cleverhub.co/api/v1/payouts/create_kyc \
--header 'Content-Type: multipart/form-data' \
--form email=beneficiary@example.com \
--form id_doc_type=passport \
--form id_doc_front_side='@example-file' \
--form id_doc_back_side='@example-file' \
--form selfie='@example-file'import requests
url = "https://api.cleverhub.co/api/v1/payouts/create_kyc"
files = {
"id_doc_front_side": ("example-file", open("example-file", "rb")),
"id_doc_back_side": ("example-file", open("example-file", "rb")),
"selfie": ("example-file", open("example-file", "rb"))
}
payload = {
"email": "beneficiary@example.com",
"id_doc_type": "passport"
}
response = requests.post(url, data=payload, files=files)
print(response.text)const form = new FormData();
form.append('email', 'beneficiary@example.com');
form.append('id_doc_type', 'passport');
form.append('id_doc_front_side', '<string>');
form.append('id_doc_back_side', '<string>');
form.append('selfie', '<string>');
const options = {method: 'POST'};
options.body = form;
fetch('https://api.cleverhub.co/api/v1/payouts/create_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://api.cleverhub.co/api/v1/payouts/create_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 => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbeneficiary@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_type\"\r\n\r\npassport\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_front_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_back_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data"
],
]);
$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://api.cleverhub.co/api/v1/payouts/create_kyc"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbeneficiary@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_type\"\r\n\r\npassport\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_front_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_back_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cleverhub.co/api/v1/payouts/create_kyc")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbeneficiary@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_type\"\r\n\r\npassport\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_front_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_back_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleverhub.co/api/v1/payouts/create_kyc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbeneficiary@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_type\"\r\n\r\npassport\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_front_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_back_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"status": "OK"
}Body
Email address associated with the beneficiary’s KYC process. This email will be used to approve the payout processing later.
"beneficiary@example.com"
Type of ID document provided for KYC verification. Options include:
- id_card: National identification card.
- passport: Passport document.
id_card, passport "passport"
Front side of the ID document. The file format must be PDF.
Back side of the ID document. The file format must be PDF.
A selfie image of the beneficiary for identity verification. The file format must be JPEG.
Response
KYC submission was successful.
Indicates the status of the KYC submission.
"OK"
curl --request POST \
--url https://api.cleverhub.co/api/v1/payouts/create_kyc \
--header 'Content-Type: multipart/form-data' \
--form email=beneficiary@example.com \
--form id_doc_type=passport \
--form id_doc_front_side='@example-file' \
--form id_doc_back_side='@example-file' \
--form selfie='@example-file'import requests
url = "https://api.cleverhub.co/api/v1/payouts/create_kyc"
files = {
"id_doc_front_side": ("example-file", open("example-file", "rb")),
"id_doc_back_side": ("example-file", open("example-file", "rb")),
"selfie": ("example-file", open("example-file", "rb"))
}
payload = {
"email": "beneficiary@example.com",
"id_doc_type": "passport"
}
response = requests.post(url, data=payload, files=files)
print(response.text)const form = new FormData();
form.append('email', 'beneficiary@example.com');
form.append('id_doc_type', 'passport');
form.append('id_doc_front_side', '<string>');
form.append('id_doc_back_side', '<string>');
form.append('selfie', '<string>');
const options = {method: 'POST'};
options.body = form;
fetch('https://api.cleverhub.co/api/v1/payouts/create_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://api.cleverhub.co/api/v1/payouts/create_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 => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbeneficiary@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_type\"\r\n\r\npassport\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_front_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_back_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data"
],
]);
$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://api.cleverhub.co/api/v1/payouts/create_kyc"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbeneficiary@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_type\"\r\n\r\npassport\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_front_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_back_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cleverhub.co/api/v1/payouts/create_kyc")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbeneficiary@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_type\"\r\n\r\npassport\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_front_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_back_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cleverhub.co/api/v1/payouts/create_kyc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\nbeneficiary@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_type\"\r\n\r\npassport\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_front_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id_doc_back_side\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"selfie\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"status": "OK"
}