KYC Vendors

Defines the external KYC service providers the suite integrates with, holding each vendor's endpoint, credentials, supported check types and active status. Administrators configure vendors here so that member verifications can route to the right provider.

Workflow

Go to KYC Aggregator then Configuration then KYC Vendors
Click New to add a vendor
Enter the API endpoint, credentials and supported check types
Activate the vendor and set it as default if required
Test a verification to confirm the connection works

Fields reference

Every field on this screen, drawn from the live data model.

Field	Type	Required	Description
Driver Status `driver_status`	Text	—	Whether a concrete driver class is loaded for this vendor code.
Display Name `name`	Text	Yes	Display Name
Vendor Code `code`	Choice: Smile Identity (Africa), Onfido (Global), Trulioo (Doc Verification), Veriff (AI), Persona (KYB), Sumsub, IPRS Kenya (Gov), NIN Nigeria	Yes	Vendor Code
Base Url `base_url`	Text	Yes	Base Url
Has Message `has_message`	Yes/No	—	Has Message
Sequence `sequence`	Number	—	Sequence
Active `active`	Yes/No	—	Active
Sandbox `sandbox`	Yes/No	—	Sandbox
Api Key `api_key`	Text	—	Api Key
Api Secret `api_secret`	Text	—	Api Secret
Hmac Secret `hmac_secret`	Text	—	Hmac Secret
Supports Id Verification `supports_id_verification`	Yes/No	—	Supports Id Verification
Supports Biometric `supports_biometric`	Yes/No	—	Supports Biometric
Supports Liveness `supports_liveness`	Yes/No	—	Supports Liveness
Supports Aml Screening `supports_aml_screening`	Yes/No	—	Supports Aml Screening
Supports Kyb `supports_kyb`	Yes/No	—	Supports Kyb
Supports Address `supports_address`	Yes/No	—	Supports Address
Callback Url `callback_url`	Text	—	Callback Url
Color `color`	Number	—	Color
Company `company_id`	Link → res.company	—	Company
Verification Count `verification_count`	Number	—	Verification Count
Success Rate `success_rate`	Decimal	—	Success Rate
Last Connection Test `last_test_at`	Date & time	—	Last Connection Test
Last Test Status `last_test_status`	Choice: OK, Failed, Untested	—	Last Test Status
Last Test Message `last_test_message`	Text	—	Last Test Message

Actions & buttons

Buttons available on this screen and what they do:

Test Connection

Notes & rules

Model kyc.vendor
Holds endpoint, credentials, check types
Drives where Verifications are routed
Admin-only configuration

Technical model: kyc.vendor · Record: KYC Verification Vendor