KYC Integrator API
KYC Integrator API
Section intitulée « KYC Integrator API »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).
Authentification
Section intitulée « Authentification »Authorization: Bearer rl_live_xxxxxxxxOu header X-Api-Key: rl_live_xxxxxxxx.
Scopes :
| Scope | Droits |
|---|---|
kyc:read | Schéma, GET dossier, validity, bundle, lookup |
kyc:write | CREATE / PATCH / documents / submit (implique read) |
verification:write | POST /v1/node/verification-results |
node:heartbeat | Health nœud SDK |
Créez la clé dans Admin → Intégrations → Nœuds de traitement.
Endpoints
Section intitulée « Endpoints »| Méthode | Chemin | Scope |
|---|---|---|
POST | /v1/kyc/submissions | kyc:write |
PATCH | /v1/kyc/submissions/{id} | kyc:write |
POST | /v1/kyc/submissions/{id}/documents | kyc:write (multipart fieldKey + file) |
POST | /v1/kyc/submissions/{id}/submit | kyc:write |
| Méthode | Chemin | Scope |
|---|---|---|
GET | /v1/kyc/schemas/{providerTypeCode} | kyc:read |
GET | /v1/kyc/submissions/{id} | kyc:read |
GET | /v1/kyc/submissions/{id}/validity | kyc:read |
GET | /v1/kyc/submissions/{id}/bundle | kyc:read |
GET | /v1/kyc/submissions/{id}/verifications | kyc:read |
GET | /v1/kyc/submissions/{id}/documents | kyc:read |
POST | /v1/kyc/submissions/lookup | kyc:read |
GET | /v1/kyc/providers/{providerId} | kyc:read |
Exemple create
Section intitulée « Exemple create »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" } }'Validité
Section intitulée « Validité »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).
Pattern webhook → GET
Section intitulée « Pattern webhook → GET »- Abonnez un webhook aux events
kyc.*(Admin → Intégrations → Webhooks). - À la réception de
kyc.submitted(payload :submissionId), appelez :
curl -sS "$BASE/v1/kyc/submissions/$SUB_ID/bundle" \ -H "Authorization: Bearer $API_KEY"- API publique (PWA / signup — sans clé API)
- Node SDK
- Collect
- Admin : Paramètres → Intégrations → KYC API
Hors scope
Section intitulée « Hors scope »Screening World-Check / ComplyAdvantage inclus, dépôt FIU live — ports prêts, contrat vendor séparé.