Formularios

Un formulario define lo que rellena el solicitante y qué documentos y comprobaciones recopila una verificación. Antes de crear una solicitud KYC/KYB, liste los formularios del inquilino para mostrar al operador un selector o para localizar el formulario correcto por su nombre.

Es la misma lista que el panel de Certivant muestra en Formularios: el endpoint REST la devuelve solo para la organización de su clave de API.

Todos los endpoints requieren una clave de API. Consulte Autenticación.

Listar formularios

GET /api/v1/kyc/forms    Ámbito: kyc:read

Devuelve los formularios KYC y KYB de la organización que realiza la llamada. Por defecto, solo se devuelven los formularios publicados (aquellos con los que puede ejecutar realmente una verificación).

Parámetros de consulta

Ejemplos:

# All published forms (KYC + KYB)
curl -H "Authorization: Bearer $CERTIVANT_API_KEY" \
  https://app.certivant.com/api/v1/kyc/forms

# Only published KYB (business) forms
curl -H "Authorization: Bearer $CERTIVANT_API_KEY" \
  "https://app.certivant.com/api/v1/kyc/forms?type=kyb"

# Everything, including drafts and archived
curl -H "Authorization: Bearer $CERTIVANT_API_KEY" \
  "https://app.certivant.com/api/v1/kyc/forms?status=all"

Respuesta

{
  "data": [
    {
      "id": "cmr8prfoe000114msbv8bie12",
      "name": "KYC — Default Identity Verification",
      "description": "Standard KYC identity verification form. Requires 2 government-issued ID documents and a selfie.",
      "type": "kyc",
      "status": "published",
      "slug": "acme-kyc-9f2c1a",
      "publicSlug": "acme-kyc-9f2c1a",
      "embeddable": true,
      "aiAgentEnabled": false,
      "isDefault": true,
      "submissionCount": 32,
      "createdAt": "2026-06-14T10:22:13.022Z"
    }
  ]
}

Los resultados se ordenan con el formulario predeterminado del inquilino de cada tipo primero, y después alfabéticamente por nombre.

Cargar y usar un formulario

Liste los formularios, elija uno (por nombre o mediante el indicador isDefault) y, a continuación, envíe al solicitante a su URL alojada (https://app.certivant.com/forms/{slug}), o incrústelo cuando embeddable sea true. Si prefiere dirigir el flujo de servidor a servidor, omita la URL alojada y cree una solicitud directamente.

curl -H "Authorization: Bearer $CERTIVANT_API_KEY" \
  "https://app.certivant.com/api/v1/kyc/forms?type=kyc"
# Pick a form's "slug", then send applicants to complete it at:
#   https://app.certivant.com/forms/{slug}

const res = await fetch(
  "https://app.certivant.com/api/v1/kyc/forms?type=kyc",
  { headers: { Authorization: `Bearer ${process.env.CERTIVANT_API_KEY}` } },
);
const { data: forms } = await res.json();

// Show the operator a picker, or grab the org's default published KYC form:
const form = forms.find((f) => f.isDefault) ?? forms[0];

// Send the applicant to the hosted form to complete their verification
// (or embed it in an <iframe> when form.embeddable is true):
const hostedUrl = `https://app.certivant.com/forms/${form.slug}`;

import os, requests

BASE = "https://app.certivant.com"
headers = {"Authorization": f"Bearer {os.environ['CERTIVANT_API_KEY']}"}

forms = requests.get(f"{BASE}/api/v1/kyc/forms",
                     headers=headers, params={"type": "kyc"}).json()["data"]

# The org's default published KYC form (or present a picker):
form = next((f for f in forms if f["isDefault"]), forms[0])

# Hosted form URL the applicant opens to complete the verification:
hosted_url = f"{BASE}/forms/{form['slug']}"

Referencia de campos

Errores

Siguiente paso

Una vez elegido el formulario, cree una solicitud. Para que el solicitante lo complete en un navegador, genere una URL de sesión alojada o incruste el formulario usando su slug. Después, lea el resultado (comprobaciones, puntuación de riesgo y decisión) con Obtener una solicitud.