Skip to navigation
Server API guides

Get configuration

GET /api/kyc/config

Returns the ID types enabled for your organisation in the current environment, along with the features available for each. Call this on startup to drive which ID options you present to users and which capture steps you run.

Authentication: Authorization: Bearer pk_… (required).

Request

curl "https://api.toden.co/api/kyc/config" \
  -H "Authorization: Bearer $TODEN_KEY"

Response 200 OK

{
  "environment": "PRODUCTION",
  "idTypes": [
    {
      "country": "NG",
      "idType": "bvn",
      "features": {
        "documentVerification": false,
        "livenessCheck": true,
        "govDbCheck": true
      }
    },
    {
      "country": "NG",
      "idType": "drivers-license",
      "features": {
        "documentVerification": true,
        "livenessCheck": true,
        "govDbCheck": true
      }
    }
  ],
  "branding": {
    "companyName": "Acme Inc.",
    "logo": "https://api.toden.co/api/kyc/branding/logo/ast_123",
    "primaryColor": "#5645F5"
  }
}

Fields

FieldTypeDescription
environmentstringSANDBOX or PRODUCTION, derived from your API key.
idTypes[]arrayThe ID types enabled for your org. Disabled ones are omitted entirely.
idTypes[].countrystringISO-3166 alpha-2 country code: a government-database market (NG, GH, KE, ZA, CI) or any country enabled for global document verification.
idTypes[].idTypestringThe ID type identifier to send to POST /verify.
idTypes[].features.documentVerificationbooleanWhether document image capture is enabled for this ID type.
idTypes[].features.livenessCheckbooleanWhether a liveness/selfie step is enabled.
idTypes[].features.govDbCheckbooleanWhether the ID is checked against the government database.
brandingobjectYour organisation’s branding, set under Settings → Organization. May be omitted if nothing is configured.
branding.companyNamestringYour organisation’s display name.
branding.logostringAbsolute, public URL of your org logo. The SDKs render this when appearance.logo is set to 'default'. Omitted if no logo is uploaded.
branding.primaryColorstringYour org’s brand colour (hex), if set.

Only enabled ID types are returned. If an ID type you expect is missing, enable it under Settings → Organization → ID Types (or ask Toden to enable it for your account).

See Countries & ID types for the catalogue of supported values.