curl -X POST https://admin.kycert.com.br/api/v1/customers/CUSTOMER_ID/documents \
-H "x-api-key: $KYCERT_API_KEY" \
-F "type=comprovante_endereco" \
-F "file=@/caminho/para/comprovante.pdf"
const form = new FormData()
form.set('type', 'comprovante_endereco')
form.set('file', fileBlob, 'comprovante.pdf')
const res = await fetch(
`https://admin.kycert.com.br/api/v1/customers/${customerId}/documents`,
{ method: 'POST', headers: { 'x-api-key': process.env.KYCERT_API_KEY }, body: form },
)
const { document_id, status } = await res.json()
console.log(document_id, status)
import requests
url = "https://admin.kycert.com.br/api/v1/customers/{id}/documents"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "type": "comprovante_endereco" }
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('type', 'comprovante_endereco');
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://admin.kycert.com.br/api/v1/customers/{id}/documents', 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://admin.kycert.com.br/api/v1/customers/{id}/documents",
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=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ncomprovante_endereco\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data; boundary=---011000010111000001101001",
"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://admin.kycert.com.br/api/v1/customers/{id}/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ncomprovante_endereco\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://admin.kycert.com.br/api/v1/customers/{id}/documents")
.header("x-api-key", "<api-key>")
.header("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ncomprovante_endereco\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://admin.kycert.com.br/api/v1/customers/{id}/documents")
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"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ncomprovante_endereco\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_bodyAnexar documento
Anexa um documento (RG, CNH, comprovante de residência etc.) a um cliente
já cadastrado. Reenviar o mesmo type para o mesmo cliente substitui o
documento anterior (não-rejeitado) desse tipo.
Requer escopo customers:write (o mesmo usado por POST /customers —
não existe um escopo documents:write separado).
Limite de arquivo: 4MB. Tipos aceitos: jpg, jpeg, png, webp,
heic, heif, tiff, bmp, pdf.
curl -X POST https://admin.kycert.com.br/api/v1/customers/CUSTOMER_ID/documents \
-H "x-api-key: $KYCERT_API_KEY" \
-F "type=comprovante_endereco" \
-F "file=@/caminho/para/comprovante.pdf"
const form = new FormData()
form.set('type', 'comprovante_endereco')
form.set('file', fileBlob, 'comprovante.pdf')
const res = await fetch(
`https://admin.kycert.com.br/api/v1/customers/${customerId}/documents`,
{ method: 'POST', headers: { 'x-api-key': process.env.KYCERT_API_KEY }, body: form },
)
const { document_id, status } = await res.json()
console.log(document_id, status)
import requests
url = "https://admin.kycert.com.br/api/v1/customers/{id}/documents"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "type": "comprovante_endereco" }
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('type', 'comprovante_endereco');
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
options.body = form;
fetch('https://admin.kycert.com.br/api/v1/customers/{id}/documents', 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://admin.kycert.com.br/api/v1/customers/{id}/documents",
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=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ncomprovante_endereco\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data; boundary=---011000010111000001101001",
"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://admin.kycert.com.br/api/v1/customers/{id}/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ncomprovante_endereco\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://admin.kycert.com.br/api/v1/customers/{id}/documents")
.header("x-api-key", "<api-key>")
.header("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ncomprovante_endereco\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://admin.kycert.com.br/api/v1/customers/{id}/documents")
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"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ncomprovante_endereco\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_bodyQuando usar
Use este endpoint para anexar um documento (RG, CNH, comprovante de residência etc.) a um cliente já cadastrado — via POST /customers ou pelo portal de onboarding. Ideal para integrações que fazem o cadastro e a captura de documentos em etapas separadas, sem depender do cliente final preencher o formulário web.Corpo da requisição
O corpo émultipart/form-data, não JSON — evita o overhead de ~33% de um payload base64 e mantém POST /customers livre de mudança de contrato.
| Campo | Obrigatório | Descrição |
|---|---|---|
file | Sim | Arquivo do documento |
type | Sim | Tipo do documento (ver catálogo abaixo) |
Limite de arquivo: 4MB
Serverless Functions da Vercel têm um teto de 4.5MB de tamanho de request, fixo em nível de infraestrutura. Arquivos maiores que 4MB são rejeitados com400 file_too_large antes de chegar no Storage.
Catálogo de type
Tipos base, aceitos em qualquer tenant:
identidade_frente, identidade_verso, cnh_frente, cnh_verso, passaporte,
comprovante_endereco, selfie, contrato_social, comprovante_cnpj,
procuracao, balanco, outro
type fora desse conjunto retorna 400 invalid_document_type.
Reenvio do mesmo tipo
Enviar o mesmotype novamente para o mesmo cliente substitui o documento anterior (desde que não esteja rejeitado) — só um documento ativo por tipo.
Se o documento existente desse type estiver rejeitado, o comportamento é diferente: o antigo não é removido, e o novo upload passa a coexistir com ele — os dois aparecem em documents[] de GET /customers/, um rejeitado e um pendente. Não é possível, via API, apagar o documento rejeitado antigo depois disso.
Exemplo
curl -X POST https://admin.kycert.com.br/api/v1/customers/CUSTOMER_ID/documents \
-H "x-api-key: $KYCERT_API_KEY" \
-F "type=comprovante_endereco" \
-F "file=@/caminho/para/comprovante.pdf"
{
"document_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"object": "document",
"type": "comprovante_endereco",
"status": "pendente",
"file_name": "comprovante.pdf",
"mime_type": "application/pdf",
"created_at": "2026-06-12T14:00:00Z",
"livemode": true
}
O que este endpoint não faz
- Não retorna o arquivo nem gera signed URL — baixar o documento continua exclusivo do dashboard.
- Não aprova nem rejeita documentos — todo documento entra como
pendente; a revisão manual é feita no dashboard. - Não lista documentos em volume — use o campo
documentsde GET /customers/ para confirmar recebimento e status.
Erros
Formato completo do envelope e estratégia de retry em Tratamento de erros. Os códigos deste endpoint:missing_api_key, invalid_api_key, insufficient_scope, channel_disabled, invalid_id ({id} da URL ausente ou inválido), invalid_multipart, invalid_file, invalid_document_type, file_too_large, customer_not_found, storage_failed, db_failed.Authorizations
API key no header x-api-key (recomendado)
Headers
"2026-06-03"
Path Parameters
ID do cliente retornado pelo POST /customers
Body
Arquivo do documento (máx. 4MB)
Tipo do documento. Catálogo base:
identidade_frente, identidade_verso, cnh_frente, cnh_verso,
passaporte, comprovante_endereco, selfie, contrato_social,
comprovante_cnpj, procuracao, balanco, outro.
Tenants com tipos customizados configurados também são aceitos.
"comprovante_endereco"
Response
Documento anexado com sucesso