Skip to content

KYC Integrator API

This content is not available in your language yet.

API authentifiée par clé rl_live_… pour intégrer le Collect / KYC depuis un SI externe (PSP, core banking, CRM).

Base typique : https://api.regulalink.pro (dev : http://localhost:8030).

Authorization: Bearer rl_live_xxxxxxxx

Ou header X-Api-Key: rl_live_xxxxxxxx.

Scopes :

ScopeDroits
kyc:readSchéma, GET dossier, validity, bundle, lookup
kyc:writeCREATE / PATCH / documents / submit (implique read)
verification:writePOST /v1/node/verification-results
node:heartbeatHealth nœud SDK

Créez la clé dans Admin → Intégrations → Nœuds de traitement.

MéthodeCheminScope
POST/v1/kyc/submissionskyc:write
PATCH/v1/kyc/submissions/{id}kyc:write
POST/v1/kyc/submissions/{id}/documentskyc:write (multipart fieldKey + file)
POST/v1/kyc/submissions/{id}/submitkyc:write
MéthodeCheminScope
GET/v1/kyc/schemas/{providerTypeCode}kyc:read
GET/v1/kyc/submissions/{id}kyc:read
GET/v1/kyc/submissions/{id}/validitykyc:read
GET/v1/kyc/submissions/{id}/bundlekyc:read
GET/v1/kyc/submissions/{id}/verificationskyc:read
GET/v1/kyc/submissions/{id}/documentskyc:read
POST/v1/kyc/submissions/lookupkyc:read
GET/v1/kyc/providers/{providerId}kyc:read
Fenêtre de terminal
curl -sS -X POST "$BASE/v1/kyc/submissions" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"providerTypeCode": "vendeur-ambulant",
"clientSubmissionId": "test-001",
"externalRef": "CRM-42",
"values": { "nom_prenom": "Test", "telephone": "+243900000001" }
}'

GET …/validity renvoie notamment :

{
"submissionId": 123,
"status": "APPROVED",
"valid": true,
"decision": "APPROVED",
"blockingIssues": [],
"verification": { "pending": 0, "failed": 0, "passed": 2 },
"flow": { "required": true, "completed": true }
}

valid == true uniquement si status == APPROVED et aucun blocage (vérifs / flow).

  1. Abonnez un webhook aux events kyc.* (Admin → Intégrations → Webhooks).
  2. À la réception de kyc.submitted (payload : submissionId), appelez :
Fenêtre de terminal
curl -sS "$BASE/v1/kyc/submissions/$SUB_ID/bundle" \
-H "Authorization: Bearer $API_KEY"

Screening World-Check / ComplyAdvantage inclus, dépôt FIU live — ports prêts, contrat vendor séparé.