Formulare

Ein Formular legt fest, was ein Antragsteller ausfüllt und welche Dokumente und Prüfungen eine Verifizierung erfasst. Bevor Sie eine KYC-/KYB-Anfrage erstellen, listen Sie die Formulare des Mandanten auf, damit Sie dem Betreiber eine Auswahl anzeigen oder das richtige Formular anhand des Namens ermitteln können.

Dies ist dieselbe Liste, die das Certivant-Dashboard unter Formulare anzeigt — der REST-Endpunkt liefert sie nur für die Organisation Ihres API-Schlüssels.

Alle Endpunkte benötigen einen API-Schlüssel. Siehe Authentifizierung.

Formulare auflisten

GET /api/v1/kyc/forms    Berechtigungsbereich: kyc:read

Liefert die KYC- und KYB-Formulare der aufrufenden Organisation. Standardmäßig werden nur veröffentlichte Formulare zurückgegeben (also diejenigen, mit denen Sie tatsächlich eine Verifizierung durchführen können).

Abfrageparameter

Beispiele:

# 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"

Antwort

{
  "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"
    }
  ]
}

Die Ergebnisse sind so sortiert, dass das Standardformular jedes Typs des Mandanten zuerst steht, danach alphabetisch nach Name.

Formular laden und verwenden

Listen Sie die Formulare auf, wählen Sie eines aus (nach Name oder über das Kennzeichen isDefault) und senden Sie den Antragsteller anschließend an dessen gehostete URL — https://app.certivant.com/forms/{slug} — oder betten Sie es ein, wenn embeddable den Wert true hat. Wenn Sie den Ablauf stattdessen serverseitig steuern möchten, verzichten Sie auf die gehostete URL und erstellen Sie direkt eine Anfrage.

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']}"

Feldreferenz

Fehler

Nächster Schritt

Sobald Sie ein Formular ausgewählt haben, erstellen Sie eine Anfrage. Damit der Antragsteller sie im Browser ausfüllen kann, erzeugen Sie eine URL für die gehostete Sitzung oder betten Sie das Formular über seinen slug ein. Lesen Sie anschließend das Ergebnis — Prüfungen, Risiko-Score und Entscheidung — mit Eine einzelne Anfrage abrufen.