Mint a one-shot signed upload URL for a KYC file
curl --request POST \
--url https://api.example.com/v1/buyer-kyc/{buyerId}/upload-url \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"kind": "selfie",
"contentType": "image/jpeg"
}
'import requests
url = "https://api.example.com/v1/buyer-kyc/{buyerId}/upload-url"
payload = {
"kind": "selfie",
"contentType": "image/jpeg"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({kind: 'selfie', contentType: 'image/jpeg'})
};
fetch('https://api.example.com/v1/buyer-kyc/{buyerId}/upload-url', 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.example.com/v1/buyer-kyc/{buyerId}/upload-url",
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([
'kind' => 'selfie',
'contentType' => 'image/jpeg'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.example.com/v1/buyer-kyc/{buyerId}/upload-url"
payload := strings.NewReader("{\n \"kind\": \"selfie\",\n \"contentType\": \"image/jpeg\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.example.com/v1/buyer-kyc/{buyerId}/upload-url")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"selfie\",\n \"contentType\": \"image/jpeg\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/buyer-kyc/{buyerId}/upload-url")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind\": \"selfie\",\n \"contentType\": \"image/jpeg\"\n}"
response = http.request(request)
puts response.read_body{
"uploadUrl": "https://storage.googleapis.com/caratuva-kyc/kyc/ckbuy001/selfie.jpg?X-Goog-Signature=...",
"publicUrl": "https://storage.caratuva.com/kyc/ckbuy001/selfie.jpg",
"uploadHeaders": {
"content-type": "image/jpeg"
},
"uploadMethod": "PUT",
"expiresAt": "2026-06-30T12:15:00.000Z"
}{
"statusCode": 404,
"error": "NotFound",
"message": "No buyer with that buyerId."
}{
"statusCode": 503,
"error": "KycStorageDisabled",
"message": "KYC file storage is not configured; pass pre-hosted HTTPS URLs in the submit body instead."
}Accounts
Mint a one-shot signed upload URL for a KYC file
Mint a one-shot signed PUT URL for uploading a KYC file (selfie or ID document). Browsers PUT directly to GCS using the returned uploadUrl + uploadHeaders; the publicUrl flows through to the settlement partner in the /buyer-kyc submit. For business KYB, scope an owner file with ownerIndex. Both URLs expire — the upload URL in minutes.
POST
/
v1
/
buyer-kyc
/
{buyerId}
/
upload-url
Mint a one-shot signed upload URL for a KYC file
curl --request POST \
--url https://api.example.com/v1/buyer-kyc/{buyerId}/upload-url \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"kind": "selfie",
"contentType": "image/jpeg"
}
'import requests
url = "https://api.example.com/v1/buyer-kyc/{buyerId}/upload-url"
payload = {
"kind": "selfie",
"contentType": "image/jpeg"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({kind: 'selfie', contentType: 'image/jpeg'})
};
fetch('https://api.example.com/v1/buyer-kyc/{buyerId}/upload-url', 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.example.com/v1/buyer-kyc/{buyerId}/upload-url",
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([
'kind' => 'selfie',
'contentType' => 'image/jpeg'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.example.com/v1/buyer-kyc/{buyerId}/upload-url"
payload := strings.NewReader("{\n \"kind\": \"selfie\",\n \"contentType\": \"image/jpeg\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.example.com/v1/buyer-kyc/{buyerId}/upload-url")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"kind\": \"selfie\",\n \"contentType\": \"image/jpeg\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/buyer-kyc/{buyerId}/upload-url")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"kind\": \"selfie\",\n \"contentType\": \"image/jpeg\"\n}"
response = http.request(request)
puts response.read_body{
"uploadUrl": "https://storage.googleapis.com/caratuva-kyc/kyc/ckbuy001/selfie.jpg?X-Goog-Signature=...",
"publicUrl": "https://storage.caratuva.com/kyc/ckbuy001/selfie.jpg",
"uploadHeaders": {
"content-type": "image/jpeg"
},
"uploadMethod": "PUT",
"expiresAt": "2026-06-30T12:15:00.000Z"
}{
"statusCode": 404,
"error": "NotFound",
"message": "No buyer with that buyerId."
}{
"statusCode": 503,
"error": "KycStorageDisabled",
"message": "KYC file storage is not configured; pass pre-hosted HTTPS URLs in the submit body instead."
}Authorizations
apiKeybearer
Path Parameters
Body
application/json
⌘I