Vendor connections

Availability

vendors:read permits the connection list and read-only details. Assign both vendors:read and vendors:manage to a connector administrator who must create, edit, prefer, disable, or enable connections.

A connection can be created only when:

• Its parent Module and Sub-module are included in the current signed license.
• The vendor and service are available for the installed OneView release.
• The adapter supports the selected sandbox or production environment.
• The maximum active vendor-connector capacity is not exceeded.

Create a connection

Open Operations → Vendor connections, select an installed vendor, one of that vendor's released services, and an environment, give the connection a recognisable name, and enter every service-adapter credential.

Select License → Refresh when an approved vendor or service does not appear after it becomes available.

The onboarding drawer follows three bounded steps:

1. Vendor — choose a provider that has at least one service packaged in the installed release.
2. Service and environment — choose a released service such as BVN Basic and a supported sandbox or production environment. OneView derives the licensed Module and Sub-module from the service; they cannot be changed independently.
3. Connection and credentials — enter a 2–120 character operational name and the complete adapter-defined credential set.

Changing the vendor or service resets environment and credential fields so values cannot silently carry into a different adapter. Secret inputs are cleared from the form after submission.

Saved credentials cannot be viewed again. Keep the authoritative value in the client's approved secret manager.

For Prembly BVN Basic, BVN Advanced, NIN Basic, and NIN Advanced, the adapter requests one password field named Prembly API Secret Key. Obtain it from the client's Prembly account and do not paste it into any other OneView field. Both sandbox-labelled and production connections use Prembly's documented API host; the environment label controls OneView connection selection and does not create a separate Prembly account or credential.

OpenSanctions hosted screening

OpenSanctions is available as two separate production services:

• pep-screening for KYC → PEP Screening; and
• sanction-screening for KYC → Sanction Screening.

Creating one connection does not configure or run the other service. Create each connection only when its Sub-module is separately licensed and the client's approved process requires that screening. Each operation uses OneView execution capacity independently and can have separate OpenSanctions usage or pricing consequences. Confirm current commercial terms directly with OpenSanctions rather than relying on a price copied into operational documentation.

The client supplies its commercial OpenSanctions API key in the friendly OpenSanctions API key field. The released v1 connection sends approved screening identity fields to the configured OpenSanctions hosted production API. There is no hosted sandbox option, and self-hosted or on-premises OpenSanctions yente is not a supported OneView v1 connection. Use provider-approved synthetic data for a controlled production test and confirm whether it counts toward provider usage before running it.

OpenSanctions PEP Screening covers PEP-related and relevant related-person categories. OpenSanctions Sanction Screening covers sanctions-related and relevant linked-record categories. These remain independent queries; OneView does not silently combine them.

When the selected service supports a sandbox environment, begin with a sandbox connection and provider-approved synthetic data. Save and validate confirms the installed adapter contract and stores an encrypted complete credential set; it is not a live provider connectivity test. The success screen states when the adapter does not expose a non-billable test operation. Do not treat saved configuration as proof of provider authentication, IP allow-listing, account balance, or network reachability.

When a service is production-only, including OpenSanctions, follow its provider-approved production test plan instead of looking for a sandbox environment.

After Configuration accepted, record the vendor, service, Module, Sub-module, environment, connection owner, and provider-approved test plan without recording the credential. Confirm the new row and whether it became preferred before executing a synthetic request.

Preferred connection

The first active connection for a Sub-module and environment becomes preferred. An authorised administrator can select a different active connection. Verification calls that do not select a connection use the preferred production connection for the requested Sub-module and environment. API callers can supply connectionId to use another active connection that supports the same Sub-module; browser users choose from the active connections shown in New Verification.

Edit a connection

Open View for the required connection and select Edit connection. An authorised administrator can:

• change the operational connection name;
• move the connection to another adapter-supported and licensed environment;
• enter a complete replacement credential set when the provider credentials must be updated or rotated; and
• make the connection preferred for its Sub-module and environment.

The vendor, service, Module, and Sub-module identify the installed adapter connection and remain fixed. Create a new connection when any of those values must change.

An environment change is available only when the installed adapter and current license support the target environment. The change is rejected when another connection already uses the same vendor, service, Sub-module, adapter, and target environment.

Saved credential values are never displayed or prefilled. Credential fields open empty; leaving them unchanged preserves the current stored credential set. To update credentials, enter every adapter-required value from the client's approved secret manager. Saving a replacement updates the complete credential set rather than revealing or merging secret values in the browser. Changing environment does not require a credential change, but rotate the credentials in the same edit when the provider issues different values for sandbox and production.

When a preferred connection moves and Preferred remains selected, OneView makes it preferred in the target environment, replacing that environment's previous preferred connection when necessary. OneView also promotes an eligible active connection remaining in the source environment when one is available. Moving a non-preferred connection preserves the target environment's current preference; when the target has none, an active moved connection can become preferred automatically.

Use the separate Enable connection or Disable connection action to control whether new verification requests can use the connection; status is not changed by editing the connection details.

API Usage

Open a connection and select API Usage. Under Synchronous verification API, OneView shows the public integration facts for that connection:

• Method and Endpoint;
• Authorization and Content-Type;
• the optional Idempotency-Key; and
• the selected Connection.

An active API Service Account is required before a client-owned application can call the displayed endpoint. When none has been created, OneView shows an alert above the endpoint. Select Manage API Service Accounts to open Settings → API Service Accounts and create one with a name and optional expiration. This prerequisite applies to external API calls; a signed-in user running New Verification from a Sub-module's Verification page uses their own permitted browser session.

Review Connection choice to understand when to send this connection ID, Verification fields for the exact service inputs, and Request example for a safe template. The request body is displayed as read-only structured JSON. Select Copy to copy the example; the button changes to Copied after a successful copy. Make required placeholder changes in the client application's API tooling, not in the displayed viewer.

The example still requires an active API Service Account. Replace placeholders with client-approved values and keep the connection ID when calling a sandbox or specifically selected service. An idempotency key is recommended for network retry safety; omitting it creates a fresh vendor request every time.

Disable and enable

Disabling prevents new requests from using the connection and releases its active connector capacity. If it was preferred, OneView promotes another active connection for the same Sub-module and environment when available.

Re-enabling checks the current signed license, licensed Sub-module, and connector capacity before making the connection available.

Status changes require confirmation. There is no delete action in the current page; disable a retired connection and retain its administrative history.

Safe failure recovery

• Installed adapter unavailable or unsupported — confirm that the installed version supports the exact vendor service and its Sub-module/environment. Do not invent adapter keys or bypass the supported workflow.
• Module or Sub-module not licensed — review the signed license and refresh it through the supported license page. A browser selection cannot expand entitlement.
• Connector capacity reached — disable a genuinely retired connection or obtain approved capacity. Do not delete history or reuse another client's connection.
• Credential validation rejected — re-enter the complete set from the client's secret manager and compare it with the installed adapter's field names. OneView never returns the submitted value for diagnosis.
• Session or permission failure — sign in again when the session expired, or ask a role administrator for both vendors:read and vendors:manage.
• Provider call later fails — first confirm the connection is active/preferred and the correct environment is selected, then check provider account state, IP allow-listing, outbound network access, and the safe verification error code. Do not repeatedly rotate credentials or create chargeable retries without reconciliation.
• OpenSanctions service is absent — confirm the installed release supports the exact service, the corresponding PEP or Sanction Sub-module is licensed, and the license has been refreshed.
• OpenSanctions has no sandbox option — use only the supported hosted production connection. Do not substitute a self-hosted yente URL or an undocumented endpoint.
• OpenSanctions credential is rejected — re-enter the complete commercial API key from the client's secret manager and confirm the provider account remains active. OneView never returns the submitted key for diagnosis.

If the page disconnects after submission, reload the connection list before submitting again. A saved connection does not by itself prove the provider will accept a verification request.

The client remains responsible for the provider contract, lawful basis, notices or consent where applicable, data minimisation, processing location/transfers, provider retention, and access controls. See Data boundary & responsibilities. Never place a real vendor credential or KYC payload in a support request.

Using OpenSanctions sends the approved screening identity fields to the OpenSanctions hosted API selected by the client. Include that provider transfer in the client's data map, privacy review, notices, retention assessment, and access controls.

See Modules, Sub-modules & adapters for packaged-code availability and Verification history for the current read-only outcome view.