docs: correct Third-Party Background Check Providers in the beta README
Evidence: spikersoft-backend@master SpikerSoft.Api/Extensions/ServiceCollectionExtensions.cs:1512 Checkr is the vendor and Sterling was removed. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
1 parent
137801d6f1
commit
3915656db3
1 file changed
+10
-8
@@ -1740,9 +1740,8 @@ The background check system uses a pluggable provider architecture. Each provide
|
||||
|
||||
| Provider | Coverage | API Documentation | Notes |
|
||||
|----------|----------|-------------------|-------|
|
||||
| **Checkr** | USA | [docs.checkr.com](https://docs.checkr.com) | API-first platform; industry standard for US background checks. Requires API key from Checkr dashboard. |
|
||||
| **Sterling** | International (Latin America, Canada, etc.) | [sterlingcheck.com](https://sterlingcheck.com) | Broadest international coverage for non-US countries. |
|
||||
| **Manual** | Fallback (all countries) | N/A | No external API. Staff perform checks externally and record results in the admin panel. Used when no automated provider is configured for a country. |
|
||||
| **Checkr** | The 13 operating countries (USA, Canada, and Latin America) | [docs.checkr.com](https://docs.checkr.com) | Hosted invitation flow. The key is `BackgroundCheck:Checkr:ApiKey`; while it is blank the factory uses Manual. A per-country package can override the default international package. |
|
||||
| **Manual** | Fallback (all countries) | N/A | No external API. Staff perform checks externally and record results in the admin panel. Used when Checkr is not configured. |
|
||||
|
||||
### Configuration
|
||||
|
||||
@@ -1751,9 +1750,12 @@ Country-to-provider mappings and API keys are configured in `appsettings.json`.
|
||||
```json
|
||||
"BackgroundCheck": {
|
||||
"DefaultProvider": "Manual",
|
||||
"CountryProviders": {
|
||||
"US": { "Provider": "Checkr", "ApiKey": "" },
|
||||
"International": { "Provider": "Sterling", "ApiKey": "" }
|
||||
"CountryProviders": {},
|
||||
"Checkr": {
|
||||
"ApiKey": "",
|
||||
"BaseUrl": "https://api.checkr.com/v1",
|
||||
"DefaultPackage": "",
|
||||
"CountryPackages": {}
|
||||
}
|
||||
}
|
||||
```
|
||||
@@ -1762,11 +1764,11 @@ Country-to-provider mappings and API keys are configured in `appsettings.json`.
|
||||
|
||||
1. Create a class implementing `IBackgroundCheckProvider` in `SpikerSoft.Business/Services/BackgroundCheck/Providers/`.
|
||||
2. Register it in DI (`ServiceCollectionExtensions.cs`).
|
||||
3. Add the country mapping in `appsettings.json` under `BackgroundCheck:CountryProviders`.
|
||||
3. Add a country override at `BackgroundCheck:CountryProviders:{ISO3}:Provider` when that country should not use the provider that already lists it.
|
||||
|
||||
### API Key Management
|
||||
|
||||
Background check API keys follow the same pattern as `GoogleMaps:ApiKey`: empty strings in `appsettings.json` with actual values injected via environment variables (`BackgroundCheck__CountryProviders__US__ApiKey`) or a secrets vault in production.
|
||||
Background check API keys are blank in `appsettings.json`. Checkr's key is `BackgroundCheck:Checkr:ApiKey`, served from OpenBao in production. While it is blank the factory skips Checkr and uses Manual.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in new issue
Block a user