Certivant Entwicklerdokumentation
Entwickeln Sie mit der Certivant-API — KYC, KYB, Dokumenten-Upload, gehostete Sitzungen und Webhook-Ereignisse.
Willkommen in der Entwicklerdokumentation von Certivant. Dies ist die technische Referenz für die Integration der KYC- und KYB-Plattform von Certivant in Ihr eigenes Produkt.
Wenn Sie wissen möchten, wie Sie Certivant im Browser verwenden, lesen Sie stattdessen die Dokumentation für Mandanten. Diese Seite setzt voraus, dass Sie Code schreiben, der mit der REST-API kommuniziert.
Was Sie entwickeln können
- Eine Identitätsverifizierung (KYC) aus Ihrer eigenen App heraus durchführen — einen Antragsteller anlegen, Dokumente über eine gehostete Sitzung oder Ihre eigene Oberfläche erfassen und eine Entscheidung zu Genehmigung, Ablehnung oder Eskalation erhalten.
- Eine Unternehmensverifizierung (KYB) durchführen — Unternehmensdaten, Geschäftsführer und wirtschaftlich Berechtigte übermitteln und diese mit Registern und Sanktionslisten abgleichen.
- Webhooks in Echtzeit empfangen, wenn sich der Status einer Anfrage ändert, ein Dokument hochgeladen wird oder eine Prüfung abgeschlossen ist.
- Anfragen über Ihre eigene Automatisierung aus dem Dashboard verwalten — dieselben Endpunkte versorgen auch die Weboberfläche von Certivant.
- Anfragen Ihren eigenen Kunden zuordnen (Partnermodus) — Verifizierungen für viele Endkunden innerhalb einer Organisation durchführen, jede Anfrage mit einem Unter-Mandantennamen und einer externen ID kennzeichnen und sie über die API und Webhooks filtern oder weiterleiten.
Auf einen Blick
| Basis-URL | https://app.certivant.com/api/v1/kyc |
| Authentifizierung | Authorization: Bearer ck_live_… oder ck_test_… (API-Schlüssel, pro Organisation; ältere kyk_…-Schlüssel funktionieren weiterhin) |
| Inhaltstyp | application/json (bzw. multipart/form-data für den Dokumenten-Upload) |
| Ratenlimit | Abhängig vom Tarif — siehe Ratenlimits |
| Webhook-Signatur | X-Certivant-Signature-V2: t=…,v1=… (HMAC-SHA256 über timestamp.body, 300 s Toleranz) — siehe Signaturprüfung |
| Interaktive Referenz | API-Referenz oder direkt /api/v1/docs öffnen — öffentlich, aus dem OpenAPI-Schema generiert |
| OpenAPI-Schema | /api/v1/openapi.json — öffentliches OpenAPI 3.1, keine Anmeldung erforderlich |
Ein Host, nicht eine Subdomain pro Mandant. Im gehosteten Dienst teilen
sich alle Organisationen denselben Host, app.certivant.com — es gibt
kein ihre-org.certivant.com. Verwenden Sie in diesen Beispielen daher
app.certivant.com unverändert. (Selbst gehostete Installationen verwenden
die Domain, die der Betreiber konfiguriert hat; certivant.com selbst ist
die Marketingseite, nicht die Anwendung.) Bei der API wird Ihre Organisation
anhand Ihres API-Schlüssels identifiziert, niemals anhand der URL: Der
Basispfad lautet /api/v1/kyc ohne Organisations-Slug. Der Slug taucht nur
dort auf, wo Menschen browsen — im Dashboard unter /app/{org-slug} und in
gehosteten Formular- bzw. Sitzungslinks wie /forms/{slug}. Eine
White-Label-Domain kann diese für
Menschen sichtbaren Links auf Ihre eigene Domain legen, der API-Host bleibt
aber unverändert.
Die interaktive Referenz und das rohe OpenAPI-Schema sind öffentlich:
Es sind weder Anmeldung noch API-Schlüssel erforderlich, und sie beschreiben
ausschließlich die Integrations-Endpunkte (/api/v1). Siehe
API-Referenz.
Jetzt starten
Referenz
- Formulare — die KYC- und KYB-Formulare des Mandanten auflisten, damit Sie wählen können, mit welchem Formular eine Verifizierung durchgeführt wird.
- KYC-Anfragen — erstellen, auflisten, abrufen, einreichen, entscheiden, erneut einreichen.
- KYB-Anfragen — Unternehmensverifizierung mit Geschäftsführern und wirtschaftlich Berechtigten.
- Dokumente — Ausweisdokumente hochladen, signierte Download-URLs abrufen.
- Gehostete Sitzungen — eine kurzlebige URL erzeugen, unter der der Antragsteller den Ablauf abschließt.
- Sperrliste — gesperrte E-Mail-Adressen, Telefonnummern, Dokumentnummern und IP-Adressen hinzufügen und entfernen oder das Gesicht, das Gerät und die IP-Adresse hinter einer Verifizierung sperren.
- Altersprüfung — anhand eines Selfies schätzen, ob eine Person alt genug ist, mit Rückgriff auf das Geburtsdatum im Ausweis.
- Wiederverwendete Verifizierungen — einem Antragsteller, der bereits anderswo eine Certivant-Verifizierung bestanden hat, ermöglichen, diese bei Ihnen wiederzuverwenden (Privatpersonen und Unternehmen).
- In Ihre Website oder App einbetten — eine Verifizierung mit einem einzigen Script-Tag in Ihrer eigenen Seite anzeigen oder in einer React-Native- oder Flutter-WebView.
- API-Referenz (OpenAPI) — das öffentliche OpenAPI-3.1-Dokument und die interaktive Referenz.
- Live-Verifizierung — eine von einer Person durchgeführte Live-ID-Verifizierung planen, verfolgen, verschieben oder absagen und die Entscheidung per Webhook erhalten.
- Live ID Validation — biometrische Anmeldung: das Live-Selfie eines wiederkehrenden Nutzers mit dem verifizierten KYC-Gesicht abgleichen.
- MCP-Server — einen KI-Assistenten über das Model Context Protocol mit Ihrer Verifizierungswarteschlange verbinden.
- Webhooks — eine URL registrieren, Signaturen prüfen, Wiederholungsversuche behandeln.
- Fehler — Fehlercodes, Zuordnung zu HTTP-Statuscodes, Aufbau der Validierungsfelder.
- Ratenlimits — Kontingente, Header, Strategie für Wiederholungen.
- Schemas — Aufzählungen, Statuswerte, Anfrage- und Antwortstrukturen, denen Sie häufig begegnen.