Formulaires

Un formulaire définit ce que le demandeur renseigne et quels documents et contrôles la vérification collecte. Avant de créer une demande KYC/KYB, listez les formulaires du locataire afin de pouvoir proposer à l'opérateur un sélecteur ou trouver le bon formulaire par son nom.

Il s'agit de la même liste que celle qu'affiche le tableau de bord Certivant sous Formulaires : le point de terminaison REST ne renvoie que les formulaires de l'organisation de votre clé d'API.

Tous les points de terminaison exigent une clé d'API. Voir Authentification.

Lister les formulaires

GET /api/v1/kyc/forms    Portée : kyc:read

Renvoie les formulaires KYC et KYB de l'organisation appelante. Par défaut, seuls les formulaires publiés sont renvoyés (ceux avec lesquels vous pouvez réellement effectuer une vérification).

Paramètres de requête

Exemples :

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

Réponse

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

Les résultats sont classés, pour chaque type, avec le formulaire par défaut du locataire en premier, puis par ordre alphabétique de nom.

Charger et utiliser un formulaire

Listez les formulaires, choisissez-en un (par son nom ou grâce à l'indicateur isDefault), puis envoyez le demandeur vers son URL hébergée — https://app.certivant.com/forms/{slug} — ou intégrez-le lorsque embeddable vaut true. Pour piloter le parcours de serveur à serveur, passez l'URL hébergée et créez directement une demande.

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

Référence des champs

Erreurs

Étape suivante

Une fois le formulaire choisi, créez une demande. Pour que le demandeur la complète dans un navigateur, générez une URL de session hébergée ou intégrez le formulaire à l'aide de son slug. Lisez ensuite le résultat — contrôles, score de risque et décision — avec Consulter une demande.